js-apis-app-ability-missionManager.md 34.2 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
# @ohos.app.ability.missionManager (missionManager)

The **missionManager** module provides APIs to lock, unlock, and clear missions, and switch a mission to the foreground.

> **NOTE**
>
> The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.

## Modules to Import

```ts
import missionManager from '@ohos.app.ability.missionManager';
```

## Required Permissions

ohos.permission.MANAGE_MISSIONS

## missionManager.on

21
on(type:'mission', listener: MissionListener): number;
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45

Registers a listener to observe the mission status.

**Required permissions**: ohos.permission.MANAGE_MISSIONS

**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

**System API**: This is a system API and cannot be called by third-party applications.

**Parameters**

  | Name| Type| Mandatory| Description|
  | -------- | -------- | -------- | -------- |
  | listener | [MissionListener](js-apis-inner-application-missionListener.md) | Yes| Mission status listener to register.|

**Return value**

  | Type| Description|
  | -------- | -------- |
  | number | Index of the mission status listener, which is created by the system and allocated when the listener is registered.|

**Example**

```ts
G
Gloria 已提交
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
import missionManager from '@ohos.app.ability.missionManager';
import UIAbility from '@ohos.app.ability.UIAbility';

let listener = {
    onMissionCreated: function (mission) {console.log('--------onMissionCreated-------');},
    onMissionDestroyed: function (mission) {console.log('--------onMissionDestroyed-------');},
    onMissionSnapshotChanged: function (mission) {console.log('--------onMissionSnapshotChanged-------');},
    onMissionMovedToFront: function (mission) {console.log('--------onMissionMovedToFront-------');},
    onMissionIconUpdated: function (mission, icon) {console.log('--------onMissionIconUpdated-------');},
    onMissionClosed: function (mission) {console.log('--------onMissionClosed-------');},
    onMissionLabelUpdated: function (mission) {console.log('--------onMissionLabelUpdated-------');}
};

let listenerId = -1;

export default class EntryAbility extends UIAbility {
    onCreate(want, launchParam) {
        console.log('[Demo] EntryAbility onCreate');
        globalThis.abilityWant = want;
        globalThis.context = this.context;
    }

    onDestroy() {
        try {
            if (listenerId !== -1) {
                missionManager.off('mission', listenerId).catch(function (err) {
                    console.log(err);
                });
            }
        } catch (paramError) {
            console.error('error: ${paramError.code}, ${paramError.message}');
        }
        console.log('[Demo] EntryAbility onDestroy');
    }

    onWindowStageCreate(windowStage) {
        // Main window is created, set main page for this ability
        console.log('[Demo] EntryAbility onWindowStageCreate');
        try {
            listenerId = missionManager.on('mission', listener);
        } catch (paramError) {
            console.error('error: ${paramError.code}, ${paramError.message}');
        }

        windowStage.loadContent('pages/index', (err, data) => {
            if (err.code) {
                console.error('Failed to load the content. Cause: ${JSON.stringify(err)}');
                return;
            }
            console.info('Succeeded in loading the content. Data: ${JSON.stringify(data)}');
        });

        if (globalThis.flag) {
            return;
        }
    }
};
103 104 105 106 107
```


## missionManager.off

108
off(type: 'mission', listenerId: number, callback: AsyncCallback<void>): void;
109 110 111 112 113 114 115 116 117 118 119 120 121

Deregisters a mission status listener.

**Required permissions**: ohos.permission.MANAGE_MISSIONS

**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

**System API**: This is a system API and cannot be called by third-party applications.

**Parameters**

  | Name| Type| Mandatory| Description|
  | -------- | -------- | -------- | -------- |
122
  | listenerId | number | Yes| Index of the mission status listener to deregister. It is returned by **registerMissionListener()**.|
123 124 125 126 127
  | callback | AsyncCallback<void> | Yes| Callback used to return the result.|

**Example**

```ts
G
Gloria 已提交
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
import missionManager from '@ohos.app.ability.missionManager';
import UIAbility from '@ohos.app.ability.UIAbility';

let listener = {
    onMissionCreated: function (mission) {console.log('--------onMissionCreated-------');},
    onMissionDestroyed: function (mission) {console.log('--------onMissionDestroyed-------');},
    onMissionSnapshotChanged: function (mission) {console.log('--------onMissionSnapshotChanged-------');},
    onMissionMovedToFront: function (mission) {console.log('--------onMissionMovedToFront-------');},
    onMissionIconUpdated: function (mission, icon) {console.log('--------onMissionIconUpdated-------');},
    onMissionClosed: function (mission) {console.log('--------onMissionClosed-------');},
    onMissionLabelUpdated: function (mission) {console.log('--------onMissionLabelUpdated-------');}
};

let listenerId = -1;

export default class EntryAbility extends UIAbility {
    onCreate(want, launchParam) {
        console.log('[Demo] EntryAbility onCreate');
        globalThis.abilityWant = want;
        globalThis.context = this.context;
    }

    onDestroy() {
        try {
            if (listenerId !== -1) {
                missionManager.off('mission', listenerId, (err) => {
                    console.log(err);
                });
            }
        } catch (paramError) {
            console.error('error: ${paramError.code}, ${paramError.message}');
        }
        console.log('[Demo] EntryAbility onDestroy');
    }

    onWindowStageCreate(windowStage) {
        // Main window is created, set main page for this ability
        console.log('[Demo] EntryAbility onWindowStageCreate');
        try {
            listenerId = missionManager.on('mission', listener);
        } catch (paramError) {
            console.error('error: ${paramError.code}, ${paramError.message}');
        }

        windowStage.loadContent('pages/index', (err, data) => {
            if (err.code) {
                console.error('Failed to load the content. Cause: ${JSON.stringify(err)}');
                return;
            }
            console.info('Succeeded in loading the content. Data: ${JSON.stringify(data)}');
        });

        if (globalThis.flag) {
            return;
        }
    }
};
185 186 187 188 189
```


## missionManager.off

190
off(type: 'mission', listenerId: number): Promise<void>;
191 192 193 194 195 196 197 198 199 200 201 202 203

Deregisters a mission status listener. This API uses a promise to return the result.

**Required permissions**: ohos.permission.MANAGE_MISSIONS

**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

**System API**: This is a system API and cannot be called by third-party applications.

**Parameters**

  | Name| Type| Mandatory| Description|
  | -------- | -------- | -------- | -------- |
204
  | listenerId | number | Yes| Index of the mission status listener to deregister. It is returned by **registerMissionListener()**.|
205 206 207 208 209 210 211 212 213 214

**Return value**

  | Type| Description|
  | -------- | -------- |
  | Promise<void> | Promise used to return the result.|

**Example**

```ts
G
Gloria 已提交
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271
import missionManager from '@ohos.app.ability.missionManager';
import UIAbility from '@ohos.app.ability.UIAbility';

let listener = {
    onMissionCreated: function (mission) {console.log('--------onMissionCreated-------');},
    onMissionDestroyed: function (mission) {console.log('--------onMissionDestroyed-------');},
    onMissionSnapshotChanged: function (mission) {console.log('--------onMissionSnapshotChanged-------');},
    onMissionMovedToFront: function (mission) {console.log('--------onMissionMovedToFront-------');},
    onMissionIconUpdated: function (mission, icon) {console.log('--------onMissionIconUpdated-------');},
    onMissionClosed: function (mission) {console.log('--------onMissionClosed-------');},
    onMissionLabelUpdated: function (mission) {console.log('--------onMissionLabelUpdated-------');}
};

let listenerId = -1;

export default class EntryAbility extends UIAbility {
    onCreate(want, launchParam) {
        console.log('[Demo] EntryAbility onCreate');
        globalThis.abilityWant = want;
        globalThis.context = this.context;
    }

    onDestroy() {
        try {
            if (listenerId !== -1) {
                missionManager.off('mission', listenerId).catch(function (err) {
                    console.log(err);
                });
            }
        } catch (paramError) {
            console.error('error: ${paramError.code}, ${paramError.message}');
        }
        console.log('[Demo] EntryAbility onDestroy');
    }

    onWindowStageCreate(windowStage) {
        // Main window is created, set main page for this ability
        console.log('[Demo] EntryAbility onWindowStageCreate');
        try {
            listenerId = missionManager.on('mission', listener);
        } catch (paramError) {
            console.error('error: ${paramError.code}, ${paramError.message}');
        }

        windowStage.loadContent('pages/index', (err, data) => {
            if (err.code) {
                console.error('Failed to load the content. Cause: ${JSON.stringify(err)}');
                return;
            }
            console.info('Succeeded in loading the content. Data: ${JSON.stringify(data)}');
        });

        if (globalThis.flag) {
            return;
        }
    }
};
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
```


## missionManager.getMissionInfo

getMissionInfo(deviceId: string, missionId: number, callback: AsyncCallback<MissionInfo>): void;

Obtains the information about a given mission. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.MANAGE_MISSIONS

**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

**System API**: This is a system API and cannot be called by third-party applications.

**Parameters**

  | Name| Type| Mandatory| Description|
  | -------- | -------- | -------- | -------- |
  | deviceId | string | Yes| Device ID. It is a null string by default for the local device.|
  | missionId | number | Yes| Mission ID.|
G
Gloria 已提交
293
  | callback | AsyncCallback<[MissionInfo](./js-apis-inner-application-missionInfo.md)> | Yes| Callback used to return the mission information obtained.|
294 295 296 297 298 299 300

**Example**

  ```ts
  import missionManager from '@ohos.app.ability.missionManager';

  try {
301 302 303 304 305 306 307 308 309 310
    let allMissions=missionManager.getMissionInfos('',10).catch(function(err){console.log(err);});
      missionManager.getMissionInfo('', allMissions[0].missionId, (error, mission) => {
        console.log('getMissionInfo is called, error.code = ' + error.code);
        console.log('mission.missionId = ' + mission.missionId);
        console.log('mission.runningState = ' + mission.runningState);
        console.log('mission.lockedState = ' + mission.lockedState);
        console.log('mission.timestamp = ' + mission.timestamp);
        console.log('mission.label = ' + mission.label);
        console.log('mission.iconPath = ' + mission.iconPath);
      });
311
  } catch (paramError) {
312
    console.log('error: ' + paramError.code + ', ' + paramError.message);
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 340 341 342 343
  }
  ```


## missionManager.getMissionInfo

getMissionInfo(deviceId: string, missionId: number): Promise<MissionInfo>;

Obtains the information about a given mission. This API uses a promise to return the result.

**Required permissions**: ohos.permission.MANAGE_MISSIONS

**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

**System API**: This is a system API and cannot be called by third-party applications.

**Parameters**

  | Name| Type| Mandatory| Description|
  | -------- | -------- | -------- | -------- |
  | deviceId | string | Yes| Device ID. It is a null string by default for the local device.|
  | missionId | number | Yes| Mission ID.|

**Return value**

  | Type| Description|
  | -------- | -------- |
  | Promise<[MissionInfo](./js-apis-inner-application-missionInfo.md)> | Promise used to return the mission information obtained.|

**Example**

344 345
  ```ts
  import missionManager from '@ohos.app.ability.missionManager';
346

347 348 349
  try {
    let mission = missionManager.getMissionInfo('', 10).catch(function (err){
      console.log(err);
350
    });
351 352 353 354 355
  } catch (paramError) {
    console.log('error: ' + paramError.code + ', ' + paramError.message);
  }
  ```

356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382

## missionManager.getMissionInfos

getMissionInfos(deviceId: string, numMax: number, callback: AsyncCallback<Array<MissionInfo>>): void;

Obtains information about all missions. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.MANAGE_MISSIONS

**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

**System API**: This is a system API and cannot be called by third-party applications.

**Parameters**

  | Name| Type| Mandatory| Description|
  | -------- | -------- | -------- | -------- |
  | deviceId | string | Yes| Device ID. It is a null string by default for the local device.|
  | numMax | number | Yes| Maximum number of missions whose information can be obtained.|
  | callback | AsyncCallback<Array<[MissionInfo](./js-apis-inner-application-missionInfo.md)>> | Yes| Callback used to return the array of mission information obtained.|

**Example**

  ```ts
  import missionManager from '@ohos.app.ability.missionManager';

  try {
383 384 385 386 387
    missionManager.getMissionInfos('', 10, (error, missions) => {
      console.log('getMissionInfos is called, error.code = ' + error.code);
      console.log('size = ' + missions.length);
      console.log('missions = ' + JSON.stringify(missions));
    });
388
  } catch (paramError) {
389
    console.log('error: ' + paramError.code + ', ' + paramError.message);
390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420
  }
  ```


## missionManager.getMissionInfos

getMissionInfos(deviceId: string, numMax: number): Promise<Array<MissionInfo>>;

Obtains information about all missions. This API uses a promise to return the result.

**Required permissions**: ohos.permission.MANAGE_MISSIONS

**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

**System API**: This is a system API and cannot be called by third-party applications.

**Parameters**

  | Name| Type| Mandatory| Description|
  | -------- | -------- | -------- | -------- |
  | deviceId | string | Yes| Device ID. It is a null string by default for the local device.|
  | numMax | number | Yes| Maximum number of missions whose information can be obtained.|

**Return value**

  | Type| Description|
  | -------- | -------- |
  | Promise<Array<[MissionInfo](./js-apis-inner-application-missionInfo.md)>> | Promise used to return the array of mission information obtained.|

**Example**

421 422
  ```ts
  import missionManager from '@ohos.app.ability.missionManager';
423

424 425 426
  try {
    let allMissions = missionManager.getMissionInfos('', 10).catch(function (err){
      console.log(err);
427
    });
428 429 430 431 432
  } catch (paramError) {
    console.log('error: ' + paramError.code + ', ' + paramError.message);
  }
  ```

433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455

## missionManager.getMissionSnapShot

getMissionSnapShot(deviceId: string, missionId: number, callback: AsyncCallback<MissionSnapshot>): void;

Obtains the snapshot of a given mission. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.MANAGE_MISSIONS

**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

**System API**: This is a system API and cannot be called by third-party applications.

**Parameters**

  | Name| Type| Mandatory| Description|
  | -------- | -------- | -------- | -------- |
  | deviceId | string | Yes| Device ID. It is a null string by default for the local device.|
  | missionId | number | Yes| Mission ID.|
  | callback | AsyncCallback<[MissionSnapshot](js-apis-inner-application-missionSnapshot.md)> | Yes| Callback used to return the snapshot information obtained.|

**Example**

456 457 458 459 460 461 462 463 464 465 466 467 468 469
  ```ts
  import missionManager from '@ohos.app.ability.missionManager';

  try {
    missionManager.getMissionInfos('', 10, (error, missions) => {
      console.log('getMissionInfos is called, error.code = ' + error.code);
      console.log('size = ' + missions.length);
      console.log('missions = ' + JSON.stringify(missions));
      let id = missions[0].missionId;

      missionManager.getMissionSnapShot('', id, (error, snapshot) => {
  	    console.log('getMissionSnapShot is called, error.code = ' + error.code);
  	    console.log('bundleName = ' + snapshot.ability.bundleName);
      });
470
    });
471 472 473 474 475
  } catch (paramError) {
    console.log('error: ' + paramError.code + ', ' + paramError.message);
  }
  ```

476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503

## missionManager.getMissionSnapShot

getMissionSnapShot(deviceId: string, missionId: number): Promise<MissionSnapshot>;

Obtains the snapshot of a given mission. This API uses a promise to return the result.

**Required permissions**: ohos.permission.MANAGE_MISSIONS

**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

**System API**: This is a system API and cannot be called by third-party applications.

**Parameters**

  | Name| Type| Mandatory| Description|
  | -------- | -------- | -------- | -------- |
  | deviceId | string | Yes| Device ID. It is a null string by default for the local device.|
  | missionId | number | Yes| Mission ID.|

**Return value**

  | Type| Description|
  | -------- | -------- |
  | Promise<[MissionSnapshot](js-apis-inner-application-missionSnapshot.md)> | Promise used to return the snapshot information obtained.|

**Example**

504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522
  ```ts
  import missionManager from '@ohos.app.ability.missionManager';

  try {
    let allMissions;
    missionManager.getMissionInfos('',10).then(function(res){
      allMissions=res;
      }).catch(function(err){console.log(err);});
      console.log('size = ' + allMissions.length);
      console.log('missions = ' + JSON.stringify(allMissions));
      let id = allMissions[0].missionId;

      let snapshot = missionManager.getMissionSnapShot('', id).catch(function (err){
        console.log(err);
      });
  } catch (paramError) {
    console.log('error: ' + paramError.code + ', ' + paramError.message);
  }
  ```
523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545

## missionManager.getLowResolutionMissionSnapShot

getLowResolutionMissionSnapShot(deviceId: string, missionId: number, callback: AsyncCallback\<MissionSnapshot>): void;

Obtains the low-resolution snapshot of a given mission. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.MANAGE_MISSIONS

**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

**System API**: This is a system API and cannot be called by third-party applications.

**Parameters**

  | Name| Type| Mandatory| Description|
  | -------- | -------- | -------- | -------- |
  | deviceId | string | Yes| Device ID. It is a null string by default for the local device.|
  | missionId | number | Yes| Mission ID.|
  | callback | AsyncCallback&lt;[MissionSnapshot](js-apis-inner-application-missionSnapshot.md)&gt; | Yes| Callback used to return the snapshot information obtained.|

**Example**

546 547 548 549 550 551 552 553 554 555 556 557 558 559
  ```ts
  import missionManager from '@ohos.app.ability.missionManager';

  try {
    missionManager.getMissionInfos('', 10, (error, missions) => {
      console.log('getMissionInfos is called, error.code = ' + error.code);
      console.log('size = ' + missions.length);
      console.log('missions = ' + JSON.stringify(missions));
      let id = missions[0].missionId;

      missionManager.getLowResolutionMissionSnapShot('', id, (error, snapshot) => {
  	    console.log('getLowResolutionMissionSnapShot is called, error.code = ' + error.code);
  	    console.log('bundleName = ' + snapshot.ability.bundleName);
      });
560
    });
561 562 563 564 565
  } catch (paramError) {
    console.log('error: ' + paramError.code + ', ' + paramError.message);
  }
  ```

566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593

## missionManager.getLowResolutionMissionSnapShot

getLowResolutionMissionSnapShot(deviceId: string, missionId: number): Promise\<MissionSnapshot>;

Obtains the low-resolution snapshot of a given mission. This API uses a promise to return the result.

**Required permissions**: ohos.permission.MANAGE_MISSIONS

**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

**System API**: This is a system API and cannot be called by third-party applications.

**Parameters**

  | Name| Type| Mandatory| Description|
  | -------- | -------- | -------- | -------- |
  | deviceId | string | Yes| Device ID. It is a null string by default for the local device.|
  | missionId | number | Yes| Mission ID.|

**Return value**

  | Type| Description|
  | -------- | -------- |
  | Promise&lt;[MissionSnapshot](js-apis-inner-application-missionSnapshot.md)&gt; | Promise used to return the snapshot information obtained.|

**Example**

594 595
  ```ts
  import missionManager from '@ohos.app.ability.missionManager';
596

597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612
  try {
    let allMissions;
    missionManager.getMissionInfos('',10).then(function(res){
      allMissions=res;
      }).catch(function(err){console.log(err);});
      console.log('size = ' + allMissions.length);
      console.log('missions = ' + JSON.stringify(allMissions));
      let id = allMissions[0].missionId;

      let snapshot = missionManager.getLowResolutionMissionSnapShot('', id).catch(function (err){
        console.log(err);
      });
  } catch (paramError) {
    console.log('error: ' + paramError.code + ', ' + paramError.message);
  }
  ```
613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635


## missionManager.lockMission

lockMission(missionId: number, callback: AsyncCallback&lt;void&gt;): void;

Locks a given mission. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.MANAGE_MISSIONS

**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

**System API**: This is a system API and cannot be called by third-party applications.

**Parameters**

  | Name| Type| Mandatory| Description|
  | -------- | -------- | -------- | -------- |
  | missionId | number | Yes| Mission ID.|
  | callback | AsyncCallback&lt;void&gt; | Yes| Callback used to return the result.|

**Example**

636 637
  ```ts
  import missionManager from '@ohos.app.ability.missionManager';
638

639 640 641 642 643 644 645 646 647 648
  try {
    missionManager.getMissionInfos('', 10, (error, missions) => {
      console.log('getMissionInfos is called, error.code = ' + error.code);
      console.log('size = ' + missions.length);
      console.log('missions = ' + JSON.stringify(missions));
      let id = missions[0].missionId;

      missionManager.lockMission(id).then(() => {
  	    console.log('lockMission is called ');
      });
649
    });
650 651 652 653 654
  } catch (paramError) {
    console.log('error: ' + paramError.code + ', ' + paramError.message);
  }
  ```

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

## missionManager.lockMission

lockMission(missionId: number): Promise&lt;void&gt;;

Locks a given mission. This API uses a promise to return the result.

**Required permissions**: ohos.permission.MANAGE_MISSIONS

**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

**System API**: This is a system API and cannot be called by third-party applications.

**Parameters**

  | Name| Type| Mandatory| Description|
  | -------- | -------- | -------- | -------- |
  | missionId | number | Yes| Mission ID.|

**Return value**

  | Type| Description|
  | -------- | -------- |
  | Promise&lt;void&gt; | Promise used to return the result.|

**Example**

682 683 684 685 686 687 688 689 690 691 692 693 694 695
  ```ts
  import missionManager from '@ohos.app.ability.missionManager';
  
  try {
    let allMissions;
    missionManager.getMissionInfos('',10).then(function(res){
      allMissions=res;
    }).catch(function(err){console.log(err);});
    console.log('size = ' + allMissions.length);
    console.log('missions = ' + JSON.stringify(allMissions));
    let id = allMissions[0].missionId;

    missionManager.lockMission(id).catch(function (err){
      console.log(err);
696
    });
697 698 699 700 701
  } catch (paramError) {
    console.log('error: ' + paramError.code + ', ' + paramError.message);
  }
  ```

702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723

## missionManager.unlockMission

unlockMission(missionId: number, callback: AsyncCallback&lt;void&gt;): void;

Unlocks a given mission. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.MANAGE_MISSIONS

**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

**System API**: This is a system API and cannot be called by third-party applications.

**Parameters**

| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| missionId | number | Yes| Mission ID.|
| callback | AsyncCallback&lt;void&gt; | Yes| Callback used to return the result.|

**Example**

724 725 726 727 728 729 730 731 732 733 734 735 736
  ```ts
  import missionManager from '@ohos.app.ability.missionManager';

  try {
    missionManager.getMissionInfos('', 10, (error, missions) => {
      console.log('getMissionInfos is called, error.code = ' + error.code);
      console.log('size = ' + missions.length);
      console.log('missions = ' + JSON.stringify(missions));
      let id = missions[0].missionId;

      missionManager.unlockMission(id).then(() => {
  	    console.log('unlockMission is called ');
      });
737
    });
738 739 740 741 742
  } catch (paramError) {
    console.log('error: ' + paramError.code + ', ' + paramError.message);
  }
  ```

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

## missionManager.unlockMission

unlockMission(missionId: number): Promise&lt;void&gt;;

Unlocks a given mission. This API uses a promise to return the result.

**Required permissions**: ohos.permission.MANAGE_MISSIONS

**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

**System API**: This is a system API and cannot be called by third-party applications.

**Parameters**

  | Name| Type| Mandatory| Description|
  | -------- | -------- | -------- | -------- |
  | missionId | number | Yes| Mission ID.|

**Return value**

  | Type| Description|
  | -------- | -------- |
  | Promise&lt;void&gt; | Promise used to return the result.|

**Example**

770 771
  ```ts
  import missionManager from '@ohos.app.ability.missionManager';
772

773 774 775 776 777 778 779 780 781 782 783
  try {
    let allMissions;
    missionManager.getMissionInfos('',10).then(function(res){
      allMissions=res;
    }).catch(function(err){console.log(err);});
    console.log('size = ' + allMissions.length);
    console.log('missions = ' + JSON.stringify(allMissions));
    let id = allMissions[0].missionId;

    missionManager.lockMission(id).catch(function (err){
      console.log(err);
784
    });
785 786 787 788 789 790 791 792
    missionManager.unlockMission(id).catch(function (err){
      console.log(err);
    });
  } catch (paramError) {
    console.log('error: ' + paramError.code + ', ' + paramError.message);
  }
  ```

793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814

## missionManager.clearMission

clearMission(missionId: number, callback: AsyncCallback&lt;void&gt;): void;

Clears a given mission, regardless of whether it is locked. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.MANAGE_MISSIONS

**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

**System API**: This is a system API and cannot be called by third-party applications.

**Parameters**

  | Name| Type| Mandatory| Description|
  | -------- | -------- | -------- | -------- |
  | missionId | number | Yes| Mission ID.|
  | callback | AsyncCallback&lt;void&gt; | Yes| Callback used to return the result.|

**Example**

815 816
  ```ts
  import missionManager from '@ohos.app.ability.missionManager';
817

818 819 820 821 822 823 824 825 826 827
  try {
    missionManager.getMissionInfos('', 10, (error, missions) => {
      console.log('getMissionInfos is called, error.code = ' + error.code);
      console.log('size = ' + missions.length);
      console.log('missions = ' + JSON.stringify(missions));
      let id = missions[0].missionId;

      missionManager.clearMission(id).then(() => {
  	    console.log('clearMission is called ');
      });
828
    });
829 830 831 832
  } catch (paramError) {
    console.log('error: ' + paramError.code + ', ' + paramError.message);
  }
  ```
833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860


## missionManager.clearMission

clearMission(missionId: number): Promise&lt;void&gt;;

Clears a given mission, regardless of whether it is locked. This API uses a promise to return the result.

**Required permissions**: ohos.permission.MANAGE_MISSIONS

**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

**System API**: This is a system API and cannot be called by third-party applications.

**Parameters**

  | Name| Type| Mandatory| Description|
  | -------- | -------- | -------- | -------- |
  | missionId | number | Yes| Mission ID.|

**Return value**

  | Type| Description|
  | -------- | -------- |
  | Promise&lt;void&gt; | Promise used to return the result.|

**Example**

861 862
  ```ts
  import missionManager from '@ohos.app.ability.missionManager';
863

864 865 866 867 868 869 870 871 872 873 874
  try {
    let allMissions;
    missionManager.getMissionInfos('',10).then(function(res){
      allMissions=res;
    }).catch(function(err){console.log(err);});
    console.log('size = ' + allMissions.length);
    console.log('missions = ' + JSON.stringify(allMissions));
    let id = allMissions[0].missionId;

    missionManager.clearMission(id).catch(function (err){
      console.log(err);
875
    });
876 877 878 879 880
  } catch (paramError) {
    console.log('error: ' + paramError.code + ', ' + paramError.message);
  }
  ```

881 882 883 884 885 886 887 888 889 890 891 892 893 894 895

## missionManager.clearAllMissions

clearAllMissions(callback: AsyncCallback&lt;void&gt;): void;

Clears all unlocked missions. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.MANAGE_MISSIONS

**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

**System API**: This is a system API and cannot be called by third-party applications.

**Example**

896 897 898 899 900 901 902
  ```ts
  import missionManager from '@ohos.app.ability.missionManager';

  missionManager.clearAllMissions().then(() => {
    console.log('clearAllMissions is called ');
  });
  ```
903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924


## missionManager.clearAllMissions

clearAllMissions(): Promise&lt;void&gt;;

Clears all unlocked missions. This API uses a promise to return the result.

**Required permissions**: ohos.permission.MANAGE_MISSIONS

**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

**System API**: This is a system API and cannot be called by third-party applications.

**Return value**

  | Type| Description|
  | -------- | -------- |
  | Promise&lt;void&gt; | Promise used to return the result.|

**Example**

925 926 927 928 929 930
  ```ts
  import missionManager from '@ohos.app.ability.missionManager';
  missionManager.clearAllMissions().catch(function (err){
    console.log(err);
  });
  ```
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953


## missionManager.moveMissionToFront

moveMissionToFront(missionId: number, callback: AsyncCallback&lt;void&gt;): void;

Switches a given mission to the foreground. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.MANAGE_MISSIONS

**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

**System API**: This is a system API and cannot be called by third-party applications.

**Parameters**

  | Name| Type| Mandatory| Description|
  | -------- | -------- | -------- | -------- |
  | missionId | number | Yes| Mission ID.|
  | callback | AsyncCallback&lt;void&gt; | Yes| Callback used to return the result.|

**Example**

954 955
  ```ts
  import missionManager from '@ohos.app.ability.missionManager';
956

957 958 959 960 961 962 963 964 965 966
  try {
    missionManager.getMissionInfos('', 10, (error, missions) => {
      console.log('getMissionInfos is called, error.code = ' + error.code);
      console.log('size = ' + missions.length);
      console.log('missions = ' + JSON.stringify(missions));
      let id = missions[0].missionId;

      missionManager.moveMissionToFront(id).then(() => {
  	    console.log('moveMissionToFront is called ');
      });
967
    });
968 969 970 971 972
  } catch (paramError) {
    console.log('error: ' + paramError.code + ', ' + paramError.message);
  }
  ```

973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995

## missionManager.moveMissionToFront

moveMissionToFront(missionId: number, options: StartOptions, callback: AsyncCallback&lt;void&gt;): void;

Switches a given mission to the foreground, with the startup parameters for the switching specified. This API uses an asynchronous callback to return the result.

**Required permissions**: ohos.permission.MANAGE_MISSIONS

**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

**System API**: This is a system API and cannot be called by third-party applications.

**Parameters**

  | Name| Type| Mandatory| Description|
  | -------- | -------- | -------- | -------- |
  | missionId | number | Yes| Mission ID.|
  | options | [StartOptions](js-apis-app-ability-startOptions.md) | Yes| Startup parameters, which are used to specify the window mode and device ID for switching the mission to the foreground.|
  | callback | AsyncCallback&lt;void&gt; | Yes| Callback used to return the result.|

**Example**

996 997
  ```ts
  import missionManager from '@ohos.app.ability.missionManager';
998

999 1000 1001 1002 1003 1004 1005 1006 1007 1008
  try {
    missionManager.getMissionInfos('', 10, (error, missions) => {
      console.log('getMissionInfos is called, error.code = ' + error.code);
      console.log('size = ' + missions.length);
      console.log('missions = ' + JSON.stringify(missions));
      let id = missions[0].missionId;

      missionManager.moveMissionToFront(id,{windowMode : 101}).then(() => {
  	    console.log('moveMissionToFront is called ');
      });
1009
    });
1010 1011 1012 1013 1014
  } catch (paramError) {
    console.log('error: ' + paramError.code + ', ' + paramError.message);
  }
  ```

1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042

## missionManager.moveMissionToFront

moveMissionToFront(missionId: number, options?: StartOptions): Promise&lt;void&gt;;

Switches a given mission to the foreground, with the startup parameters for the switching specified. This API uses a promise to return the result.

**Required permissions**: ohos.permission.MANAGE_MISSIONS

**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

**System API**: This is a system API and cannot be called by third-party applications.

**Parameters**

  | Name| Type| Mandatory| Description|
  | -------- | -------- | -------- | -------- |
  | missionId | number | Yes| Mission ID.|
  | options | [StartOptions](js-apis-app-ability-startOptions.md) | No| Startup parameters, which are used to specify the window mode and device ID for switching the mission to the foreground.|

**Return value**

  | Type| Description|
  | -------- | -------- |
  | Promise&lt;void&gt; | Promise used to return the result.|

**Example**

1043 1044
  ```ts
  import missionManager from '@ohos.app.ability.missionManager';
1045

1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056
  try {
    let allMissions;
    missionManager.getMissionInfos('',10).then(function(res){
      allMissions=res;
    }).catch(function(err){console.log(err);});
    console.log('size = ' + allMissions.length);
    console.log('missions = ' + JSON.stringify(allMissions));
    let id = allMissions[0].missionId;

    missionManager.moveMissionToFront(id).catch(function (err){
      console.log(err);
1057
    });
1058 1059 1060 1061
  } catch (paramError) {
    console.log('error: ' + paramError.code + ', ' + paramError.message);
  }
  ```