js-apis-defaultAppManager.md 31.4 KB
Newer Older
Z
zengyawen 已提交
1
# @ohos.bundle.defaultAppManager (默认应用管理)
2

3
本模块提供查询默认应用的能力,支持查询当前应用是否是默认应用。
4

5
> **说明:**
6
>
7 8 9 10 11
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

## 导入模块

```
J
junyi233 已提交
12
import defaultAppMgr from '@ohos.bundle.defaultAppManager';
13
```
Z
zhaogan 已提交
14 15 16 17 18 19 20

## 权限列表

| 权限                                    | 权限等级    | 描述             |
| --------------------------------------- | ----------- | ---------------- |
| ohos.permission.GET_DEFAULT_APPLICATION | system_core | 默认应用相关权限。 |

J
junyi233 已提交
21
权限等级参考[权限等级说明](../../security/accesstoken-overview.md#权限等级说明)
Z
zhaogan 已提交
22 23


24 25
## defaultAppMgr.ApplicationType

X
xsz233 已提交
26
默认应用的应用类型。
27

Z
zhaogan 已提交
28
**系统能力:** SystemCapability.BundleManager.BundleFramework.DefaultApp
29

J
junyi233 已提交
30 31
| 名称   | 值 | 说明                                   |
| -------- | -------------------------------------- | -------------------------------------- |
J
junyi233 已提交
32 33 34 35 36 37 38 39
| BROWSER  | "Web Browser" | 默认浏览器。                            |
| IMAGE    | "Image Gallery" | 默认图片查看器。                         |
| AUDIO    | "Audio Player" | 默认音频播放器。                         |
| VIDEO    | "Video Player" | 默认视频播放器。                         |
| PDF      | "PDF Viewer" | 默认PDF文档查看器。                      |
| WORD     | "Word Viewer" | 默认WORD文档查看器。                     |
| EXCEL    | "Excel Viewer" | 默认EXCEL文档查看器。                    |
| PPT      | "PPT Viewer" | 默认PPT文档查看器。                      |
40 41 42 43 44

## defaultAppMgr.isDefaultApplication

isDefaultApplication(type: string): Promise\<boolean>

45
以异步方法根据系统已定义的应用类型判断当前应用是否是该应用类型的默认应用,使用Promise形式返回结果。
46

Z
zhaogan 已提交
47
**系统能力:** SystemCapability.BundleManager.BundleFramework.DefaultApp
48 49 50

**参数:**

J
junyi233 已提交
51
| 参数名         | 类型     | 必填   | 说明                                      |
52
| ----------- | ------ | ---- | --------------------------------------- |
53
| type  | string | 是    | 要查询的应用类型,取[ApplicationType](#defaultappmgrapplicationtype)中的值。                           |
54 55 56 57 58

**返回值:**

| 类型                        | 说明                 |
| ------------------------- | ------------------ |
59
| Promise\<boolean> | Promise形式返回当前应用是否是默认应用,true表示是默认应用,false表示不是默认应用。 |
60

Z
zhaogan 已提交
61

62 63
**示例:**

X
xsz233 已提交
64
```ts
W
wanghang 已提交
65
import defaultAppMgr from '@ohos.bundle.defaultAppManager';
66 67
import { BusinessError } from '@ohos.base';

68
defaultAppMgr.isDefaultApplication(defaultAppMgr.ApplicationType.BROWSER)
69
  .then((data) => {
70
    console.info('Operation successful. IsDefaultApplication ? ' + JSON.stringify(data));
71 72
  }).catch((error: BusinessError) => {
  console.error('Operation failed. Cause: ' + JSON.stringify(error));
73 74 75 76 77 78 79
});
```

## defaultAppMgr.isDefaultApplication

isDefaultApplication(type: string, callback: AsyncCallback\<boolean>): void

80
以异步方法根据系统已定义的应用类型判断当前应用是否是该应用类型的默认应用,使用callback形式返回结果。
81

Z
zhaogan 已提交
82
**系统能力:** SystemCapability.BundleManager.BundleFramework.DefaultApp
83 84 85

**参数:**

J
junyi233 已提交
86
| 参数名         | 类型                              | 必填   | 说明                                      |
87
| ----------- | ------------------------------- | ---- | --------------------------------------- |
88 89
| type  | string                          | 是    | 要查询的应用类型,取[ApplicationType](#defaultappmgrapplicationtype)中的值。                            |
| callback    | AsyncCallback\<boolean> | 是    | 程序启动作为入参的回调函数,返回当前应用是否是默认应用,true表示是默认应用,false表示不是默认应用。 |
90 91 92

**示例:**

X
xsz233 已提交
93
```ts
W
wanghang 已提交
94
import defaultAppMgr from '@ohos.bundle.defaultAppManager';
G
geng-wenguang 已提交
95 96
import { BusinessError } from '@ohos.base';

97 98 99 100 101 102 103
defaultAppMgr.isDefaultApplication(defaultAppMgr.ApplicationType.BROWSER, (err: BusinessError, data) => {
  if (err) {
    console.error('Operation failed. Cause: ' + JSON.stringify(err));
    return;
  }
  console.info('Operation successful. IsDefaultApplication ? ' + JSON.stringify(data));
});
104 105
```

106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
## defaultAppMgr.isDefaultApplicationSync<sup>10+</sup>

isDefaultApplicationSync(type: string): boolean;

以同步方法根据系统已定义的应用类型判断当前应用是否是该应用类型的默认应用,使用boolean形式返回结果。

**系统能力:** SystemCapability.BundleManager.BundleFramework.DefaultApp

**参数:**

| 参数名 | 类型   | 必填 | 说明                                     |
| -------| ------ | ---- | --------------------------------------- |
|  type  | string | 是   | 要查询的应用类型,取[ApplicationType](#defaultappmgrapplicationtype)中的值。   |

**返回值:**

| 类型    | 说明                 |
| ------- | -------------------- |
124
| boolean | 返回当前应用是否是默认应用,true表示是默认应用,false表示不是默认应用。 |
125 126 127 128 129 130


**示例:**

```ts
import defaultAppMgr from '@ohos.bundle.defaultAppManager';
131 132 133 134 135 136
try {
  let data = defaultAppMgr.isDefaultApplicationSync(defaultAppMgr.ApplicationType.BROWSER)
  console.info('Operation successful. IsDefaultApplicationSync ? ' + JSON.stringify(data));
} catch(error) {
  console.error('Operation failed. Cause: ' + JSON.stringify(error));
};
137 138
```

139 140 141 142
## defaultAppMgr.getDefaultApplication

getDefaultApplication(type: string, userId?: number): Promise\<BundleInfo>

143 144
以异步方法根据系统已定义的应用类型或者符合媒体类型格式(type/subtype)的文件类型获取默认应用信息,使用Promise形式返回结果。

145
**需要权限:** ohos.permission.GET_DEFAULT_APPLICATION
146

Z
zhaogan 已提交
147
**系统能力:** SystemCapability.BundleManager.BundleFramework.DefaultApp
148

149
**系统API:**  此接口为系统接口。
150 151 152

**参数:**

J
junyi233 已提交
153
| 参数名         | 类型     | 必填   | 说明                                      |
154
| ----------- | ------ | ---- | --------------------------------------- |
155
| type  | string | 是    | 要查询的应用类型,取[ApplicationType](#defaultappmgrapplicationtype)中的值,或者符合媒体类型格式的文件类型。       |
156
| userId  | number | 否    | 用户ID。默认值:调用方所在用户。                        |
157 158 159 160 161

**返回值:**

| 类型                        | 说明                 |
| ------------------------- | ------------------ |
162
| Promise\<[BundleInfo](js-apis-bundle-BundleInfo.md)> | Promise形式返回默认应用包信息。 |
163

164 165
**错误码:**

Z
zhaogan 已提交
166 167
以下错误码的详细介绍请参见[ohos.bundle错误码](../errorcodes/errorcode-bundle.md)

J
junyi233 已提交
168
| 错误码ID | 错误信息                                  |
169
| -------- | ----------------------------------------- |
J
junyi233 已提交
170
| 17700004 | The specified user ID is not found.       |
171 172 173
| 17700023 | The specified default app does not exist. |
| 17700025 | The specified type is invalid.            |

174 175
**示例:**

X
xsz233 已提交
176
```ts
W
wanghang 已提交
177
import defaultAppMgr from '@ohos.bundle.defaultAppManager';
178 179
import { BusinessError } from '@ohos.base';

180
defaultAppMgr.getDefaultApplication(defaultAppMgr.ApplicationType.BROWSER)
181
  .then((data) => {
182
    console.info('Operation successful. bundleInfo: ' + JSON.stringify(data));
183 184
  })
  .catch((error: BusinessError) => {
185
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
186
  });
187

188
defaultAppMgr.getDefaultApplication("image/png")
189
  .then((data) => {
190
    console.info('Operation successful. bundleInfo: ' + JSON.stringify(data));
191 192
  })
  .catch((error: BusinessError) => {
193
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
194
  });
195 196
```

197 198 199 200 201
## defaultAppMgr.getDefaultApplication

getDefaultApplication(type: string, userId: number, callback: AsyncCallback\<BundleInfo>) : void

以异步方法根据系统已定义的应用类型或者符合媒体类型格式(type/subtype)的文件类型获取默认应用信息,使用callback形式返回结果。
202

203
**需要权限:** ohos.permission.GET_DEFAULT_APPLICATION
204

Z
zhaogan 已提交
205
**系统能力:** SystemCapability.BundleManager.BundleFramework.DefaultApp
206

207
**系统API:**  此接口为系统接口。
208 209 210

**参数:**

J
junyi233 已提交
211
| 参数名         | 类型     | 必填   | 说明                                      |
212
| ----------- | ------ | ---- | --------------------------------------- |
213
| type  | string | 是    | 要查询的应用类型,取[ApplicationType](#defaultappmgrapplicationtype)中的值,或者符合媒体类型格式的文件类型。       |
214 215
| userId  | number | 是    | 用户ID。                           |
| callback    | AsyncCallback\<[BundleInfo](js-apis-bundle-BundleInfo.md)> | 是    | 程序启动作为入参的回调函数,返回包信息。                    |
216

217 218
**错误码:**

Z
zhaogan 已提交
219 220
以下错误码的详细介绍请参见[ohos.bundle错误码](../errorcodes/errorcode-bundle.md)

J
junyi233 已提交
221
| 错误码ID | 错误信息                                  |
222
| -------- | ----------------------------------------- |
J
junyi233 已提交
223
| 17700004 | The specified user ID is not found.       |
224 225 226
| 17700023 | The specified default app does not exist. |
| 17700025 | The specified type is invalid.            |

227 228
**示例:**

X
xsz233 已提交
229
```ts
W
wanghang 已提交
230
import defaultAppMgr from '@ohos.bundle.defaultAppManager';
G
geng-wenguang 已提交
231 232
import { BusinessError } from '@ohos.base';

W
wanghang 已提交
233
let userId = 100;
234 235 236 237 238 239
defaultAppMgr.getDefaultApplication(defaultAppMgr.ApplicationType.BROWSER, userId, (err: BusinessError, data) => {
  if (err) {
    console.error('Operation failed. Cause: ' + JSON.stringify(err));
    return;
  }
  console.info('Operation successful. bundleInfo:' + JSON.stringify(data));
240 241
});

242 243 244 245 246 247
defaultAppMgr.getDefaultApplication("image/png", userId, (err: BusinessError, data) => {
  if (err) {
    console.error('Operation failed. Cause: ' + JSON.stringify(err));
    return;
  }
  console.info('Operation successful. bundleInfo:' + JSON.stringify(data));
248 249
});
```
250 251 252 253 254 255 256

## defaultAppMgr.getDefaultApplication

getDefaultApplication(type: string, callback: AsyncCallback\<BundleInfo>) : void

以异步方法根据系统已定义的应用类型或者符合媒体类型格式(type/subtype)的文件类型获取默认应用信息,使用callback形式返回结果。

257
**需要权限:** ohos.permission.GET_DEFAULT_APPLICATION
258

Z
zhaogan 已提交
259
**系统能力:** SystemCapability.BundleManager.BundleFramework.DefaultApp
260

261
**系统API:**  此接口为系统接口。
262 263 264

**参数:**

J
junyi233 已提交
265
| 参数名         | 类型     | 必填   | 说明                                      |
266
| ----------- | ------ | ---- | --------------------------------------- |
267
| type  | string | 是    | 要查询的应用类型,取[ApplicationType](#defaultappmgrapplicationtype)中的值,或者符合媒体类型格式的文件类型。       |
268 269
| callback    | AsyncCallback\<[BundleInfo](js-apis-bundle-BundleInfo.md)> | 是    | 程序启动作为入参的回调函数,返回包信息。                    |

270 271
**错误码:**

Z
zhaogan 已提交
272 273
以下错误码的详细介绍请参见[ohos.bundle错误码](../errorcodes/errorcode-bundle.md)

J
junyi233 已提交
274
| 错误码ID | 错误信息                                  |
275 276 277 278
| -------- | ----------------------------------------- |
| 17700023 | The specified default app does not exist. |
| 17700025 | The specified type is invalid.            |

279 280
**示例:**

X
xsz233 已提交
281
```ts
W
wanghang 已提交
282
import defaultAppMgr from '@ohos.bundle.defaultAppManager';
G
geng-wenguang 已提交
283 284
import { BusinessError } from '@ohos.base';

285 286 287 288 289 290
defaultAppMgr.getDefaultApplication(defaultAppMgr.ApplicationType.BROWSER, (err: BusinessError, data) => {
  if (err) {
    console.error('Operation failed. Cause: ' + JSON.stringify(err));
    return;
  }
  console.info('Operation successful. bundleInfo:' + JSON.stringify(data));
291
});
292 293 294 295 296 297
defaultAppMgr.getDefaultApplication("image/png", (err: BusinessError, data) => {
  if (err) {
    console.error('Operation failed. Cause: ' + JSON.stringify(err));
    return;
  }
  console.info('Operation successful. bundleInfo:' + JSON.stringify(data));
298 299 300
});
```

301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339
## defaultAppMgr.getDefaultApplicationSync<sup>10+</sup>

getDefaultApplicationSync(type: string, userId?: number): BundleInfo;

以同步方法根据系统已定义的应用类型或者符合媒体类型格式(type/subtype)的文件类型获取默认应用信息,使用BundleInfo返回结果。

**需要权限:** ohos.permission.GET_DEFAULT_APPLICATION

**系统能力:** SystemCapability.BundleManager.BundleFramework.DefaultApp

**系统API:**  此接口为系统接口。

**参数:**

| 参数名 | 类型   | 必填 | 说明                                    |
| -------| ------ | ---- | --------------------------------------- |
| type   | string | 是   | 要查询的应用类型,取[ApplicationType](#defaultappmgrapplicationtype)中的值,或者符合媒体类型格式的文件类型。|
| userId | number | 否   | 用户ID。默认值:调用方所在用户。         |

**返回值:**

| 类型                                       | 说明                 |
| ------------------------------------------ | -------------------- |
| [BundleInfo](js-apis-bundle-BundleInfo.md) | 返回的默认应用包信息。|

**错误码:**

以下错误码的详细介绍请参见[ohos.bundle错误码](../errorcodes/errorcode-bundle.md)

| 错误码ID | 错误信息                                  |
| -------- | ----------------------------------------- |
| 17700004 | The specified user ID is not found.       |
| 17700023 | The specified default app does not exist. |
| 17700025 | The specified type is invalid.            |

**示例:**

```ts
import defaultAppMgr from '@ohos.bundle.defaultAppManager';
340 341 342 343 344 345 346 347 348 349 350 351 352
try {
  let data = defaultAppMgr.getDefaultApplicationSync(defaultAppMgr.ApplicationType.BROWSER)
  console.info('Operation successful. bundleInfo: ' + JSON.stringify(data));
} catch(error) {
  console.error('Operation failed. Cause: ' + JSON.stringify(error));
};

try {
  let data = defaultAppMgr.getDefaultApplicationSync("image/png")
  console.info('Operation successful. bundleInfo: ' + JSON.stringify(data));
} catch(error) {
  console.error('Operation failed. Cause: ' + JSON.stringify(error));
};
353 354
```

355 356
## defaultAppMgr.setDefaultApplication

J
junyi233 已提交
357
setDefaultApplication(type: string, elementName: ElementName, userId?: number): Promise\<void>
358

359
以异步方法根据系统已定义的应用类型或者符合媒体类型格式(type/subtype)的文件类型设置默认应用,使用Promise形式返回结果。
360

361
**需要权限:** ohos.permission.SET_DEFAULT_APPLICATION
362

Z
zhaogan 已提交
363
**系统能力:** SystemCapability.BundleManager.BundleFramework.DefaultApp
364

365
**系统API:**  此接口为系统接口。
366 367 368

**参数:**

J
junyi233 已提交
369
| 参数名         | 类型     | 必填   | 说明                                      |
370
| ----------- | ------ | ---- | --------------------------------------- |
371
| type  | string | 是    | 要设置的应用类型,取[ApplicationType](#defaultappmgrapplicationtype)中的值,或者符合媒体类型格式的文件类型。       |
372 373 374
| elementName  | [ElementName](js-apis-bundle-ElementName.md) | 是    | 要设置为默认应用的组件信息。                           |
| userId  | number | 否    | 用户ID。默认值:调用方所在用户。                           |

W
wanghang 已提交
375 376 377 378
**返回值:**

| 类型           | 说明                               |
| -------------- | ---------------------------------- |
379
| Promise\<void> | Promise对象,无返回结果的Promise对象。 |
W
wanghang 已提交
380

381 382
**错误码:**

Z
zhaogan 已提交
383 384
以下错误码的详细介绍请参见[ohos.bundle错误码](../errorcodes/errorcode-bundle.md)

J
junyi233 已提交
385
| 错误码ID | 错误信息                                       |
386
| -------- | ---------------------------------------------- |
J
junyi233 已提交
387
| 17700004 | The specified user ID is not found.            |
388
| 17700025 | The specified type is invalid.                 |
J
junyi233 已提交
389
| 17700028 | The specified ability does not match the type. |
390

391 392
**示例:**

X
xsz233 已提交
393
```ts
W
wanghang 已提交
394
import defaultAppMgr from '@ohos.bundle.defaultAppManager';
395 396
import { BusinessError } from '@ohos.base';

397
defaultAppMgr.setDefaultApplication(defaultAppMgr.ApplicationType.BROWSER, {
398 399 400
  bundleName: "com.example.myapplication",
  moduleName: "module01",
  abilityName: "EntryAbility"
401
}).then((data) => {
402 403 404
  console.info('Operation successful.');
}).catch((error: BusinessError) => {
  console.error('Operation failed. Cause: ' + JSON.stringify(error));
W
wanghang 已提交
405 406 407
});

let userId = 100;
408 409 410 411 412
defaultAppMgr.setDefaultApplication(defaultAppMgr.ApplicationType.BROWSER, {
  bundleName: "com.example.myapplication",
  moduleName: "module01",
  abilityName: "EntryAbility"
}, userId).then((data) => {
413 414 415
  console.info('Operation successful.');
}).catch((error: BusinessError) => {
  console.error('Operation failed. Cause: ' + JSON.stringify(error));
416 417
});

418 419 420 421 422
defaultAppMgr.setDefaultApplication("image/png", {
  bundleName: "com.example.myapplication",
  moduleName: "module01",
  abilityName: "EntryAbility"
}, userId).then((data) => {
423 424 425
  console.info('Operation successful.');
}).catch((error: BusinessError) => {
  console.error('Operation failed. Cause: ' + JSON.stringify(error));
426 427 428 429 430 431 432
});
```

## defaultAppMgr.setDefaultApplication

setDefaultApplication(type: string, elementName: ElementName, userId: number, callback: AsyncCallback\<void>) : void;

433
以异步方法根据系统已定义的应用类型或者符合媒体类型格式(type/subtype)的文件类型设置默认应用,使用callback形式返回结果。
434

435
**需要权限:** ohos.permission.SET_DEFAULT_APPLICATION
436

Z
zhaogan 已提交
437
**系统能力:** SystemCapability.BundleManager.BundleFramework.DefaultApp
438

439
**系统API:**  此接口为系统接口。
440 441 442

**参数:**

J
junyi233 已提交
443
| 参数名         | 类型     | 必填   | 说明                                      |
444
| ----------- | ------ | ---- | --------------------------------------- |
445
| type  | string | 是    | 要设置的应用类型,取[ApplicationType](#defaultappmgrapplicationtype)中的值,或者符合媒体类型格式的文件类型。       |
446 447 448 449
| elementName  | [ElementName](js-apis-bundle-ElementName.md) | 是    | 要设置为默认应用的组件信息。                           |
| userId  | number | 是    | 用户ID。                           |
| callback    | AsyncCallback\<void> | 是    | 程序启动作为入参的回调函数。                    |

450 451
**错误码:**

Z
zhaogan 已提交
452 453
以下错误码的详细介绍请参见[ohos.bundle错误码](../errorcodes/errorcode-bundle.md)

J
junyi233 已提交
454
| 错误码ID | 错误信息                                       |
455
| -------- | ---------------------------------------------- |
J
junyi233 已提交
456
| 17700004 | The specified user ID is not found.            |
457
| 17700025 | The specified type is invalid.                 |
J
junyi233 已提交
458
| 17700028 | The specified ability does not match the type. |
459

460 461
**示例:**

X
xsz233 已提交
462
```ts
W
wanghang 已提交
463
import defaultAppMgr from '@ohos.bundle.defaultAppManager';
G
geng-wenguang 已提交
464 465
import { BusinessError } from '@ohos.base';

W
wanghang 已提交
466
let userId = 100;
467
defaultAppMgr.setDefaultApplication(defaultAppMgr.ApplicationType.BROWSER, {
468 469 470
  bundleName: "com.example.myapplication",
  moduleName: "module01",
  abilityName: "EntryAbility"
471
}, userId, (err: BusinessError, data) => {
472 473 474 475 476 477
  if (err) {
    console.error('Operation failed. Cause: ' + JSON.stringify(err));
    return;
  }
  console.info('Operation successful.');
});
478

479 480 481 482 483
defaultAppMgr.setDefaultApplication("image/png", {
  bundleName: "com.example.myapplication",
  moduleName: "module01",
  abilityName: "EntryAbility"
}, userId, (err: BusinessError, data) => {
484 485 486 487 488 489
  if (err) {
    console.error('Operation failed. Cause: ' + JSON.stringify(err));
    return;
  }
  console.info('Operation successful.');
});
490 491 492 493 494 495
```

## defaultAppMgr.setDefaultApplication

setDefaultApplication(type: string, elementName: ElementName, callback: AsyncCallback\<void>) : void;

496
以异步方法根据系统已定义的应用类型或者符合媒体类型格式(type/subtype)的文件类型设置默认应用,使用callback形式返回结果。
497

498
**需要权限:** ohos.permission.SET_DEFAULT_APPLICATION
499

Z
zhaogan 已提交
500
**系统能力:** SystemCapability.BundleManager.BundleFramework.DefaultApp
501

502
**系统API:**  此接口为系统接口。
503 504 505

**参数:**

J
junyi233 已提交
506
| 参数名         | 类型     | 必填   | 说明                                      |
507
| ----------- | ------ | ---- | --------------------------------------- |
508
| type  | string | 是    | 要设置的应用类型,取[ApplicationType](#defaultappmgrapplicationtype)中的值,或者符合媒体类型格式的文件类型。       |
509 510 511
| elementName  | [ElementName](js-apis-bundle-ElementName.md) | 是    | 要设置为默认应用的组件信息。                           |
| callback    | AsyncCallback\<void> | 是    | 程序启动作为入参的回调函数。                    |

512 513
**错误码:**

Z
zhaogan 已提交
514 515
以下错误码的详细介绍请参见[ohos.bundle错误码](../errorcodes/errorcode-bundle.md)

J
junyi233 已提交
516
| 错误码ID | 错误信息                                       |
517 518
| -------- | ---------------------------------------------- |
| 17700025 | The specified type is invalid.                 |
J
junyi233 已提交
519
| 17700028 | The specified ability does not match the type. |
520

521 522
**示例:**

X
xsz233 已提交
523
```ts
W
wanghang 已提交
524
import defaultAppMgr from '@ohos.bundle.defaultAppManager';
G
geng-wenguang 已提交
525 526
import { BusinessError } from '@ohos.base';

527
defaultAppMgr.setDefaultApplication(defaultAppMgr.ApplicationType.BROWSER, {
528 529 530
  bundleName: "com.example.myapplication",
  moduleName: "module01",
  abilityName: "EntryAbility"
531
}, (err: BusinessError, data) => {
532 533 534 535 536 537
  if (err) {
    console.error('Operation failed. Cause: ' + JSON.stringify(err));
    return;
  }
  console.info('Operation successful.');
});
538

539 540 541 542 543
defaultAppMgr.setDefaultApplication("image/png", {
  bundleName: "com.example.myapplication",
  moduleName: "module01",
  abilityName: "EntryAbility"
}, (err: BusinessError, data) => {
544 545 546 547 548 549
  if (err) {
    console.error('Operation failed. Cause: ' + JSON.stringify(err));
    return;
  }
  console.info('Operation successful.');
});
550 551
```

552 553 554 555
## defaultAppMgr.setDefaultApplicationSync<sup>10+</sup>

setDefaultApplicationSync(type: string, elementName: ElementName, userId?: number): void;

556
以同步方法根据系统已定义的应用类型或者符合媒体类型格式(type/subtype)的文件类型设置默认应用。
557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585

**需要权限:** ohos.permission.SET_DEFAULT_APPLICATION

**系统能力:** SystemCapability.BundleManager.BundleFramework.DefaultApp

**系统API:**  此接口为系统接口。

**参数:**

| 参数名      | 类型   | 必填 | 说明                                      |
| ----------- | ------ | ---- | --------------------------------------- |
| type        | string | 是   | 要设置的应用类型,取[ApplicationType](#defaultappmgrapplicationtype)中的值,或者符合媒体类型格式的文件类型。|
| elementName | [ElementName](js-apis-bundle-ElementName.md) | 是 | 要设置为默认应用的组件信息。                           |
| userId      | number | 否   | 用户ID。默认值:调用方所在用户。                           |

**错误码:**

以下错误码的详细介绍请参见[ohos.bundle错误码](../errorcodes/errorcode-bundle.md)

| 错误码ID | 错误信息                                       |
| -------- | ---------------------------------------------- |
| 17700004 | The specified user ID is not found.            |
| 17700025 | The specified type is invalid.                 |
| 17700028 | The specified ability does not match the type. |

**示例:**

```ts
import defaultAppMgr from '@ohos.bundle.defaultAppManager';
586 587
try {
  defaultAppMgr.setDefaultApplicationSync(defaultAppMgr.ApplicationType.BROWSER, {
588 589 590
  bundleName: "com.example.myapplication",
  moduleName: "module01",
  abilityName: "EntryAbility"
591
});
592 593 594 595
  console.info('Operation successful.');
} catch(error) {
  console.error('Operation failed. Cause: ' + JSON.stringify(error));
};
596 597

let userId = 100;
598
try {
599 600 601 602 603
  defaultAppMgr.setDefaultApplicationSync(defaultAppMgr.ApplicationType.BROWSER, {
  bundleName: "com.example.myapplication",
  moduleName: "module01",
  abilityName: "EntryAbility"
}, userId);
604 605 606 607 608 609
  console.info('Operation successful.');
} catch(error) {
  console.error('Operation failed. Cause: ' + JSON.stringify(error));
};

try {
610 611 612 613 614
  defaultAppMgr.setDefaultApplicationSync("image/png", {
  bundleName: "com.example.myapplication",
  moduleName: "module01",
  abilityName: "EntryAbility"
}, userId);
615 616 617 618
  console.info('Operation successful.');
} catch(error) {
  console.error('Operation failed. Cause: ' + JSON.stringify(error));
};
619 620
```

621 622 623 624
## defaultAppMgr.resetDefaultApplication

resetDefaultApplication(type: string, userId?: number): Promise\<void>

625
以异步方法根据系统已定义的应用类型或者符合媒体类型格式(type/subtype)的文件类型重置默认应用,使用Promise形式返回结果。
626

627
**需要权限:** ohos.permission.SET_DEFAULT_APPLICATION
628

Z
zhaogan 已提交
629
**系统能力:** SystemCapability.BundleManager.BundleFramework.DefaultApp
630

631
**系统API:**  此接口为系统接口。
632 633 634

**参数:**

J
junyi233 已提交
635
| 参数名         | 类型     | 必填   | 说明                                      |
636
| ----------- | ------ | ---- | --------------------------------------- |
637
| type  | string | 是    | 要重置的应用类型,取[ApplicationType](#defaultappmgrapplicationtype)中的值,或者符合媒体类型格式的文件类型。       |
638 639
| userId  | number | 否    | 用户ID。默认值:调用方所在用户。                           |

640 641
**错误码:**

Z
zhaogan 已提交
642 643
以下错误码的详细介绍请参见[ohos.bundle错误码](../errorcodes/errorcode-bundle.md)

J
junyi233 已提交
644
| 错误码ID | 错误信息                            |
645
| -------- | ----------------------------------- |
J
junyi233 已提交
646
| 17700004 | The specified user ID is not found. |
647 648
| 17700025 | The specified type is invalid.      |

649 650
**示例:**

X
xsz233 已提交
651
```ts
W
wanghang 已提交
652
import defaultAppMgr from '@ohos.bundle.defaultAppManager';
653 654
import { BusinessError } from '@ohos.base';

W
wanghang 已提交
655 656
let userId = 100;
defaultAppMgr.resetDefaultApplication(defaultAppMgr.ApplicationType.BROWSER, userId)
657
  .then((data) => {
658
    console.info('Operation successful.');
659 660
  })
  .catch((error: BusinessError) => {
661
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
662
  });
663

W
wanghang 已提交
664
defaultAppMgr.resetDefaultApplication("image/png", userId)
665
  .then((data) => {
666
    console.info('Operation successful.');
667 668
  })
  .catch((error: BusinessError) => {
669
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
670
  });
671 672 673 674 675 676
```

## defaultAppMgr.resetDefaultApplication

resetDefaultApplication(type: string, userId: number, callback: AsyncCallback\<void>) : void;

677
以异步方法根据系统已定义的应用类型或者符合媒体类型格式(type/subtype)的文件类型重置默认应用,使用callback形式返回结果。
678

679
**需要权限:** ohos.permission.SET_DEFAULT_APPLICATION
680

Z
zhaogan 已提交
681
**系统能力:** SystemCapability.BundleManager.BundleFramework.DefaultApp
682

683
**系统API:**  此接口为系统接口。
684 685 686

**参数:**

J
junyi233 已提交
687
| 参数名         | 类型     | 必填   | 说明                                      |
688
| ----------- | ------ | ---- | --------------------------------------- |
689
| type  | string | 是    | 要重置的应用类型,取[ApplicationType](#defaultappmgrapplicationtype)中的值,或者符合媒体类型格式的文件类型。       |
690 691 692
| userId  | number | 是    | 用户ID。                          |
| callback    | AsyncCallback\<void> | 是    | 程序启动作为入参的回调函数。                    |

693 694
**错误码:**

Z
zhaogan 已提交
695 696
以下错误码的详细介绍请参见[ohos.bundle错误码](../errorcodes/errorcode-bundle.md)

J
junyi233 已提交
697
| 错误码ID | 错误信息                            |
698
| -------- | ----------------------------------- |
J
junyi233 已提交
699
| 17700004 | The specified user ID is not found. |
700 701
| 17700025 | The specified type is invalid.      |

702 703
**示例:**

X
xsz233 已提交
704
```ts
W
wanghang 已提交
705
import defaultAppMgr from '@ohos.bundle.defaultAppManager';
G
geng-wenguang 已提交
706 707
import { BusinessError } from '@ohos.base';

W
wanghang 已提交
708
let userId = 100;
709 710 711 712 713 714
defaultAppMgr.resetDefaultApplication(defaultAppMgr.ApplicationType.BROWSER, userId, (err: BusinessError, data) => {
  if (err) {
    console.error('Operation failed. Cause: ' + JSON.stringify(err));
    return;
  }
  console.info('Operation successful.');
715 716
});

717 718 719 720 721 722
defaultAppMgr.resetDefaultApplication("image/png", userId, (err: BusinessError, data) => {
  if (err) {
    console.error('Operation failed. Cause: ' + JSON.stringify(err));
    return;
  }
  console.info('Operation successful.');
723 724 725 726 727 728 729
});
```

## defaultAppMgr.resetDefaultApplication

resetDefaultApplication(type: string, callback: AsyncCallback\<void>) : void;

730
以异步方法根据系统已定义的应用类型或者符合媒体类型格式(type/subtype)的文件类型重置默认应用,使用callback形式返回结果。
731

732
**需要权限:** ohos.permission.SET_DEFAULT_APPLICATION
733

Z
zhaogan 已提交
734
**系统能力:** SystemCapability.BundleManager.BundleFramework.DefaultApp
735

736
**系统API:**  此接口为系统接口。
737 738 739

**参数:**

J
junyi233 已提交
740
| 参数名         | 类型     | 必填   | 说明                                      |
741
| ----------- | ------ | ---- | --------------------------------------- |
742 743 744 745 746 747 748 749 750 751 752 753 754 755 756
| type  | string | 是    | 要重置的应用类型,取[ApplicationType](#defaultappmgrapplicationtype)中的值,或者符合媒体类型格式的文件类型。       |
| callback    | AsyncCallback\<void> | 是    | 程序启动作为入参的回调函数。                    |

**错误码:**

以下错误码的详细介绍请参见[ohos.bundle错误码](../errorcodes/errorcode-bundle.md)

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 17700025 | The specified type is invalid.      |

**示例:**

```ts
import defaultAppMgr from '@ohos.bundle.defaultAppManager';
G
geng-wenguang 已提交
757 758
import { BusinessError } from '@ohos.base';

759 760 761 762 763 764
defaultAppMgr.resetDefaultApplication(defaultAppMgr.ApplicationType.BROWSER, (err: BusinessError, data) => {
  if (err) {
    console.error('Operation failed. Cause: ' + JSON.stringify(err));
    return;
  }
  console.info('Operation successful.');
765 766
});

767 768 769 770 771 772
defaultAppMgr.resetDefaultApplication("image/png", (err: BusinessError, data) => {
  if (err) {
    console.error('Operation failed. Cause: ' + JSON.stringify(err));
    return;
  }
  console.info('Operation successful.');
773 774 775
});
```

776
## defaultAppMgr.resetDefaultApplicationSync<sup>10+</sup>
777

778
resetDefaultApplicationSync(type: string, userId?: number): void;
779

780
以同步方法根据系统已定义的应用类型或者符合媒体类型格式(type/subtype)的文件类型重置默认应用。
781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808

**需要权限:** ohos.permission.SET_DEFAULT_APPLICATION

**系统能力:** SystemCapability.BundleManager.BundleFramework.DefaultApp

**系统API:**  此接口为系统接口。

**参数:**

| 参数名 | 类型   | 必填 | 说明                                    |
| ------ | ------ | ---- | --------------------------------------- |
| type   | string | 是   | 要重置的应用类型,取[ApplicationType](#defaultappmgrapplicationtype)中的值,或者符合媒体类型格式的文件类型。|
| userId | number | 否   | 用户ID。默认值:调用方所在用户。                           |

**错误码:**

以下错误码的详细介绍请参见[ohos.bundle错误码](../errorcodes/errorcode-bundle.md)

| 错误码ID | 错误信息                            |
| -------- | ----------------------------------- |
| 17700004 | The specified user ID is not found. |
| 17700025 | The specified type is invalid.      |

**示例:**

```ts
import defaultAppMgr from '@ohos.bundle.defaultAppManager';

809 810 811 812 813 814 815 816 817 818 819 820 821 822
let userId = 100;
try {
  defaultAppMgr.resetDefaultApplicationSync(defaultAppMgr.ApplicationType.BROWSER, userId);
  console.info('Operation successful.');
} catch(error) {
  console.error('Operation failed. Cause: ' + JSON.stringify(error));
};

try {
  defaultAppMgr.resetDefaultApplicationSync("image/png", userId);
  console.info('Operation successful.');
} catch(error) {
  console.error('Operation failed. Cause: ' + JSON.stringify(error));
};
823
```