js-apis-defaultAppManager.md 32.9 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 68 69 70 71 72 73 74 75 76 77
defaultAppMgr.isDefaultApplication(defaultAppMgr.ApplicationType.BROWSER)
.then((data) => {
    console.info('Operation successful. IsDefaultApplication ? ' + JSON.stringify(data));
}).catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
});
```

## defaultAppMgr.isDefaultApplication

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

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

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

**参数:**

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

**示例:**

X
xsz233 已提交
91
```ts
W
wanghang 已提交
92
import defaultAppMgr from '@ohos.bundle.defaultAppManager';
93 94 95 96 97 98 99 100 101
defaultAppMgr.isDefaultApplication(defaultAppMgr.ApplicationType.BROWSER, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. IsDefaultApplication ? ' + JSON.stringify(data));
 });
```

102 103 104 105
## defaultAppMgr.getDefaultApplication

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

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

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

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

112
**系统API:**  此接口为系统接口。
113 114 115

**参数:**

J
junyi233 已提交
116
| 参数名         | 类型     | 必填   | 说明                                      |
117
| ----------- | ------ | ---- | --------------------------------------- |
118
| type  | string | 是    | 要查询的应用类型,取[ApplicationType](#defaultappmgrapplicationtype)中的值,或者符合媒体类型格式的文件类型。       |
119
| userId  | number | 否    | 用户ID。默认值:调用方所在用户。                        |
120 121 122 123 124

**返回值:**

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

127 128
**错误码:**

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

J
junyi233 已提交
131
| 错误码ID | 错误信息                                  |
132
| -------- | ----------------------------------------- |
J
junyi233 已提交
133
| 17700004 | The specified user ID is not found.       |
134 135 136
| 17700023 | The specified default app does not exist. |
| 17700025 | The specified type is invalid.            |

137 138
**示例:**

X
xsz233 已提交
139
```ts
W
wanghang 已提交
140
import defaultAppMgr from '@ohos.bundle.defaultAppManager';
141 142
defaultAppMgr.getDefaultApplication(defaultAppMgr.ApplicationType.BROWSER)
.then((data) => {
143 144 145
    console.info('Operation successful. bundleInfo: ' + JSON.stringify(data));
})
.catch((error) => {
146 147 148
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
});

149
defaultAppMgr.getDefaultApplication("image/png")
150
.then((data) => {
151 152 153
    console.info('Operation successful. bundleInfo: ' + JSON.stringify(data));
})
.catch((error) => {
154 155 156 157
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
});
```

158 159 160 161 162
## defaultAppMgr.getDefaultApplication

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

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

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

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

168
**系统API:**  此接口为系统接口。
169 170 171

**参数:**

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

178 179
**错误码:**

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

J
junyi233 已提交
182
| 错误码ID | 错误信息                                  |
183
| -------- | ----------------------------------------- |
J
junyi233 已提交
184
| 17700004 | The specified user ID is not found.       |
185 186 187
| 17700023 | The specified default app does not exist. |
| 17700025 | The specified type is invalid.            |

188 189
**示例:**

X
xsz233 已提交
190
```ts
W
wanghang 已提交
191 192 193
import defaultAppMgr from '@ohos.bundle.defaultAppManager';
let userId = 100;
defaultAppMgr.getDefaultApplication(defaultAppMgr.ApplicationType.BROWSER, userId, (err, data) => {
194 195 196 197 198 199 200
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. bundleInfo:' + JSON.stringify(data));
});

W
wanghang 已提交
201
defaultAppMgr.getDefaultApplication("image/png", userId, (err, data) => {
202 203 204 205 206
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. bundleInfo:' + JSON.stringify(data));
207 208
});
```
209 210 211 212 213 214 215

## defaultAppMgr.getDefaultApplication

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

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

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

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

220
**系统API:**  此接口为系统接口。
221 222 223

**参数:**

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

229 230
**错误码:**

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

J
junyi233 已提交
233
| 错误码ID | 错误信息                                  |
234 235 236 237
| -------- | ----------------------------------------- |
| 17700023 | The specified default app does not exist. |
| 17700025 | The specified type is invalid.            |

238 239
**示例:**

X
xsz233 已提交
240
```ts
W
wanghang 已提交
241
import defaultAppMgr from '@ohos.bundle.defaultAppManager';
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
defaultAppMgr.getDefaultApplication(defaultAppMgr.ApplicationType.BROWSER, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. bundleInfo:' + JSON.stringify(data));
});
defaultAppMgr.getDefaultApplication("image/png", (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. bundleInfo:' + JSON.stringify(data));
});
```

## defaultAppMgr.setDefaultApplication

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

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

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

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

268
**系统API:**  此接口为系统接口。
269 270 271

**参数:**

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

W
wanghang 已提交
278 279 280 281
**返回值:**

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

284 285
**错误码:**

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

J
junyi233 已提交
288
| 错误码ID | 错误信息                                       |
289
| -------- | ---------------------------------------------- |
J
junyi233 已提交
290
| 17700004 | The specified user ID is not found.            |
291
| 17700025 | The specified type is invalid.                 |
J
junyi233 已提交
292
| 17700028 | The specified ability does not match the type. |
293

294 295
**示例:**

X
xsz233 已提交
296
```ts
W
wanghang 已提交
297
import defaultAppMgr from '@ohos.bundle.defaultAppManager';
298
defaultAppMgr.setDefaultApplication(defaultAppMgr.ApplicationType.BROWSER, {
299
    bundleName: "com.example.myapplication",
300
    moduleName: "module01",
301
    abilityName: "EntryAbility"
W
wanghang 已提交
302
}).then((data) => {
303
    console.info('Operation successful.');
W
wanghang 已提交
304 305 306 307 308 309
}).catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
});

let userId = 100;
defaultAppMgr.setDefaultApplication(defaultAppMgr.ApplicationType.BROWSER, {
310
    bundleName: "com.example.myapplication",
W
wanghang 已提交
311
    moduleName: "module01",
312
    abilityName: "EntryAbility"
W
wanghang 已提交
313 314 315
}, userId).then((data) => {
    console.info('Operation successful.');
}).catch((error) => {
316 317 318 319
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
});

defaultAppMgr.setDefaultApplication("image/png", {
320
    bundleName: "com.example.myapplication",
321
    moduleName: "module01",
322
    abilityName: "EntryAbility"
W
wanghang 已提交
323
}, userId).then((data) => {
324
    console.info('Operation successful.');
W
wanghang 已提交
325
}).catch((error) => {
326 327 328 329 330 331 332 333
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
});
```

## defaultAppMgr.setDefaultApplication

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

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

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

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

340
**系统API:**  此接口为系统接口。
341 342 343

**参数:**

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

351 352
**错误码:**

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

J
junyi233 已提交
355
| 错误码ID | 错误信息                                       |
356
| -------- | ---------------------------------------------- |
J
junyi233 已提交
357
| 17700004 | The specified user ID is not found.            |
358
| 17700025 | The specified type is invalid.                 |
J
junyi233 已提交
359
| 17700028 | The specified ability does not match the type. |
360

361 362
**示例:**

X
xsz233 已提交
363
```ts
W
wanghang 已提交
364 365
import defaultAppMgr from '@ohos.bundle.defaultAppManager';
let userId = 100;
366
defaultAppMgr.setDefaultApplication(defaultAppMgr.ApplicationType.BROWSER, {
367
    bundleName: "com.example.myapplication",
368
    moduleName: "module01",
369
    abilityName: "EntryAbility"
W
wanghang 已提交
370
}, userId, (err, data) => {
371 372 373 374 375 376 377 378
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful.');
 });

defaultAppMgr.setDefaultApplication("image/png", {
379
    bundleName: "com.example.myapplication",
380
    moduleName: "module01",
381
    abilityName: "EntryAbility"
W
wanghang 已提交
382
}, userId, (err, data) => {
383 384 385 386 387 388 389 390 391 392 393 394
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful.');
 });
```

## defaultAppMgr.setDefaultApplication

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

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

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

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

401
**系统API:**  此接口为系统接口。
402 403 404

**参数:**

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

411 412
**错误码:**

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

J
junyi233 已提交
415
| 错误码ID | 错误信息                                       |
416 417
| -------- | ---------------------------------------------- |
| 17700025 | The specified type is invalid.                 |
J
junyi233 已提交
418
| 17700028 | The specified ability does not match the type. |
419

420 421
**示例:**

X
xsz233 已提交
422
```ts
W
wanghang 已提交
423
import defaultAppMgr from '@ohos.bundle.defaultAppManager';
424
defaultAppMgr.setDefaultApplication(defaultAppMgr.ApplicationType.BROWSER, {
425
    bundleName: "com.example.myapplication",
426
    moduleName: "module01",
427
    abilityName: "EntryAbility"
428 429 430 431 432 433 434 435 436
}, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful.');
 });

defaultAppMgr.setDefaultApplication("image/png", {
437
    bundleName: "com.example.myapplication",
438
    moduleName: "module01",
439
    abilityName: "EntryAbility"
440 441 442 443 444 445 446 447 448 449 450 451 452
}, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful.');
 });
```

## defaultAppMgr.resetDefaultApplication

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

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

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

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

459
**系统API:**  此接口为系统接口。
460 461 462

**参数:**

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

468 469
**错误码:**

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

J
junyi233 已提交
472
| 错误码ID | 错误信息                            |
473
| -------- | ----------------------------------- |
J
junyi233 已提交
474
| 17700004 | The specified user ID is not found. |
475 476
| 17700025 | The specified type is invalid.      |

477 478
**示例:**

X
xsz233 已提交
479
```ts
W
wanghang 已提交
480 481 482
import defaultAppMgr from '@ohos.bundle.defaultAppManager';
let userId = 100;
defaultAppMgr.resetDefaultApplication(defaultAppMgr.ApplicationType.BROWSER, userId)
483 484 485 486 487 488 489
.then((data) => {
    console.info('Operation successful.');
})
.catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
});

W
wanghang 已提交
490
defaultAppMgr.resetDefaultApplication("image/png", userId)
491 492 493 494 495 496 497 498 499 500 501 502
.then((data) => {
    console.info('Operation successful.');
})
.catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
});
```

## defaultAppMgr.resetDefaultApplication

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

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

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

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

509
**系统API:**  此接口为系统接口。
510 511 512

**参数:**

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

519 520
**错误码:**

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

J
junyi233 已提交
523
| 错误码ID | 错误信息                            |
524
| -------- | ----------------------------------- |
J
junyi233 已提交
525
| 17700004 | The specified user ID is not found. |
526 527
| 17700025 | The specified type is invalid.      |

528 529
**示例:**

X
xsz233 已提交
530
```ts
W
wanghang 已提交
531 532 533
import defaultAppMgr from '@ohos.bundle.defaultAppManager';
let userId = 100;
defaultAppMgr.resetDefaultApplication(defaultAppMgr.ApplicationType.BROWSER, userId, (err, data) => {
534 535 536 537 538 539 540
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful.');
});

W
wanghang 已提交
541
defaultAppMgr.resetDefaultApplication("image/png", userId, (err, data) => {
542 543 544 545 546 547 548 549 550 551 552 553
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful.');
});
```

## defaultAppMgr.resetDefaultApplication

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

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

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

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

560
**系统API:**  此接口为系统接口。
561 562 563

**参数:**

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

569 570
**错误码:**

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

J
junyi233 已提交
573
| 错误码ID | 错误信息                            |
574 575 576
| -------- | ----------------------------------- |
| 17700025 | The specified type is invalid.      |

577 578
**示例:**

X
xsz233 已提交
579
```ts
W
wanghang 已提交
580
import defaultAppMgr from '@ohos.bundle.defaultAppManager';
581 582 583 584 585 586 587 588 589 590 591 592 593 594 595
defaultAppMgr.resetDefaultApplication(defaultAppMgr.ApplicationType.BROWSER, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful.');
});

defaultAppMgr.resetDefaultApplication("image/png", (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful.');
});
596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 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 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854
```

## defaultAppMgr.resetDefaultApplication

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

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

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

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

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

**参数:**

| 参数名         | 类型     | 必填   | 说明                                      |
| ----------- | ------ | ---- | --------------------------------------- |
| 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';
defaultAppMgr.resetDefaultApplication(defaultAppMgr.ApplicationType.BROWSER, (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful.');
});

defaultAppMgr.resetDefaultApplication("image/png", (err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful.');
});
```

## defaultAppMgr.isDefaultApplicationSync

isDefaultApplication(type: string): boolean

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

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

**参数:**

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

**返回值:**

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


**示例:**

```ts
import defaultAppMgr from '@ohos.bundle.defaultAppManager';
defaultAppMgr.isDefaultApplicationSync(defaultAppMgr.ApplicationType.BROWSER)
.then((data) => {
    console.info('Operation successful. IsDefaultApplicationSync ? ' + JSON.stringify(data));
}).catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
});
```

## defaultAppMgr.getDefaultApplicationSync

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';
defaultAppMgr.getDefaultApplicationSync(defaultAppMgr.ApplicationType.BROWSER)
.then((data) => {
    console.info('Operation successful. bundleInfo: ' + JSON.stringify(data));
})
.catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
});

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

## defaultAppMgr.setDefaultApplicationSync

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

以同步方法根据系统已定义的应用类型或者符合媒体类型格式(type/subtype)的文件类型设置默认应用,返回undefined。

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

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

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

**参数:**

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

**返回值:**

| 类型   | 说明                               |
| ------ | ---------------------------------- |
| void   | undefined对象,无返回结果的undefined对象。 |

**错误码:**

以下错误码的详细介绍请参见[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';
defaultAppMgr.setDefaultApplicationSync(defaultAppMgr.ApplicationType.BROWSER, {
    bundleName: "com.example.myapplication",
    moduleName: "module01",
    abilityName: "EntryAbility"
}).then((data) => {
    console.info('Operation successful.');
}).catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
});

let userId = 100;
defaultAppMgr.setDefaultApplicationSync(defaultAppMgr.ApplicationType.BROWSER, {
    bundleName: "com.example.myapplication",
    moduleName: "module01",
    abilityName: "EntryAbility"
}, userId).then((data) => {
    console.info('Operation successful.');
}).catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
});

defaultAppMgr.setDefaultApplicationSync("image/png", {
    bundleName: "com.example.myapplication",
    moduleName: "module01",
    abilityName: "EntryAbility"
}, userId).then((data) => {
    console.info('Operation successful.');
}).catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
});
```

## defaultAppMgr.resetDefaultApplicationSync

resetDefaultApplicationSync(type: string, userId?: number): [void]

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

**需要权限:** 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';
let userId = 100;
defaultAppMgr.resetDefaultApplicationSync(defaultAppMgr.ApplicationType.BROWSER, userId)
.then((data) => {
    console.info('Operation successful.');
})
.catch((error) => {
    console.error('Operation failed. Cause: ' + JSON.stringify(error));
});

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