js-apis-application-missionManager.md 29.7 KB
Newer Older
1
# @ohos.application.missionManager (missionManager)
W
wusongqing 已提交
2

3
The **missionManager** module provides APIs to lock, unlock, and clear missions, and switch a mission to the foreground.
W
wusongqing 已提交
4

W
wusongqing 已提交
5 6
> **NOTE**
> 
7
> The APIs of this module are supported since API version 8 and deprecated since API version 9. You are advised to use [@ohos.app.ability.missionManager](js-apis-app-ability-missionManager.md) instead. Newly added APIs will be marked with a superscript to indicate their earliest API version.
W
wusongqing 已提交
8 9 10

## Modules to Import

11
```ts
W
wusongqing 已提交
12 13 14
import missionManager from '@ohos.application.missionManager'
```

W
wusongqing 已提交
15 16 17
## Required Permissions

ohos.permission.MANAGE_MISSIONS
W
wusongqing 已提交
18 19 20

## missionManager.registerMissionListener

W
wusongqing 已提交
21
registerMissionListener(listener: MissionListener): number;
W
wusongqing 已提交
22 23 24

Registers a listener to observe the mission status.

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

W
wusongqing 已提交
27 28
**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

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

W
wusongqing 已提交
31 32
**Parameters**

W
wusongqing 已提交
33 34
  | Name| Type| Mandatory| Description|
  | -------- | -------- | -------- | -------- |
35
  | listener | [MissionListener](js-apis-inner-application-missionListener.md) | Yes| Mission status listener to register.|
W
wusongqing 已提交
36 37 38

**Return value**

W
wusongqing 已提交
39 40
  | Type| Description|
  | -------- | -------- |
41
  | number | Index of the mission status listener, which is created by the system and allocated when the listener is registered.|
W
wusongqing 已提交
42 43 44

**Example**

45 46 47 48 49 50 51 52 53 54 55 56
```ts
var 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-------")}
};
console.log("registerMissionListener")
var listenerid = missionManager.registerMissionListener(listener);
G
Gloria 已提交
57
```
W
wusongqing 已提交
58 59 60 61


## missionManager.unregisterMissionListener

W
wusongqing 已提交
62
unregisterMissionListener(listenerId: number, callback: AsyncCallback<void>): void;
W
wusongqing 已提交
63

W
wusongqing 已提交
64
Deregisters a mission status listener. This API uses an asynchronous callback to return the result.
W
wusongqing 已提交
65

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

W
wusongqing 已提交
68 69
**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

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

W
wusongqing 已提交
72 73
**Parameters**

W
wusongqing 已提交
74 75
  | Name| Type| Mandatory| Description|
  | -------- | -------- | -------- | -------- |
76
  | listenerId | number | Yes| Index of the mission status listener to deregister. It is returned by **registerMissionListener()**.|
W
wusongqing 已提交
77
  | callback | AsyncCallback<void> | Yes| Callback used to return the result.|
W
wusongqing 已提交
78 79 80

**Example**

81
```ts
G
Gloria 已提交
82 83 84 85 86 87
  var 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-------")},
88 89
      onMissionClosed: function (mission) {console.log("--------onMissionClosed-------")},
      onMissionLabelUpdated: function (mission) {console.log("--------onMissionLabelUpdated-------")}
W
wusongqing 已提交
90 91 92 93 94
  };
  console.log("registerMissionListener")
  var listenerid = missionManager.registerMissionListener(listener);

  missionManager.unregisterMissionListener(listenerid, (error) => {
G
Gloria 已提交
95
      console.log("unregisterMissionListener");
W
wusongqing 已提交
96
  })
G
Gloria 已提交
97
```
W
wusongqing 已提交
98 99 100 101


## missionManager.unregisterMissionListener

W
wusongqing 已提交
102
unregisterMissionListener(listenerId: number): Promise<void>;
W
wusongqing 已提交
103

W
wusongqing 已提交
104
Deregisters a mission status listener. This API uses a promise to return the result.
W
wusongqing 已提交
105

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

W
wusongqing 已提交
108 109
**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

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

W
wusongqing 已提交
112 113
**Parameters**

W
wusongqing 已提交
114 115
  | Name| Type| Mandatory| Description|
  | -------- | -------- | -------- | -------- |
116
  | listenerId | number | Yes| Index of the mission status listener to deregister. It is returned by **registerMissionListener()**.|
W
wusongqing 已提交
117

W
wusongqing 已提交
118 119
**Return value**

W
wusongqing 已提交
120 121 122
  | Type| Description| 
  | -------- | -------- |
  | Promise<void> | Promise used to return the result.| 
W
wusongqing 已提交
123

W
wusongqing 已提交
124 125
**Example**

126
```ts
G
Gloria 已提交
127 128 129 130 131 132
  var 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-------")},
133 134
      onMissionClosed: function (mission) {console.log("--------onMissionClosed-------")},
      onMissionLabelUpdated: function (mission) {console.log("--------onMissionLabelUpdated-------")}
G
Gloria 已提交
135 136 137 138 139 140 141 142
  };
  console.log("registerMissionListener")
  var listenerid = missionManager.registerMissionListener(listener);

  missionManager.unregisterMissionListener(listenerid).catch(function (err) {
      console.log(err);
  });
```
W
wusongqing 已提交
143 144 145 146


## missionManager.getMissionInfo

W
wusongqing 已提交
147
getMissionInfo(deviceId: string, missionId: number, callback: AsyncCallback<MissionInfo>): void;
W
wusongqing 已提交
148

W
wusongqing 已提交
149
Obtains the information about a given mission. This API uses an asynchronous callback to return the result.
W
wusongqing 已提交
150

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

W
wusongqing 已提交
153 154
**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

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

W
wusongqing 已提交
157 158
**Parameters**

W
wusongqing 已提交
159 160 161 162
  | 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.|
163
  | callback | AsyncCallback<[MissionInfo](js-apis-inner-application-missionInfo.md)> | Yes| Callback used to return the mission information obtained.|
W
wusongqing 已提交
164 165 166

**Example**

167
  ```ts
W
wusongqing 已提交
168 169
  import missionManager from '@ohos.application.missionManager'

W
wusongqing 已提交
170 171
  var allMissions=missionManager.getMissionInfos("",10).catch(function(err){console.log(err);});
      missionManager.getMissionInfo("", allMissions[0].missionId, (error, mission) => {
172 173 174 175 176 177
        if (error.code) {
          console.log("getMissionInfo failed, error.code:" + JSON.stringify(error.code) +
            "error.message:" + JSON.stringify(error.message));
          return;
        }

W
wusongqing 已提交
178 179 180 181 182 183 184
        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);
      });
W
wusongqing 已提交
185 186 187 188 189
  ```


## missionManager.getMissionInfo

W
wusongqing 已提交
190
getMissionInfo(deviceId: string, missionId: number): Promise<MissionInfo>;
W
wusongqing 已提交
191

W
wusongqing 已提交
192
Obtains the information about a given mission. This API uses a promise to return the result.
W
wusongqing 已提交
193

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

W
wusongqing 已提交
196 197
**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

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

W
wusongqing 已提交
200 201
**Parameters**

W
wusongqing 已提交
202 203 204 205
  | 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.|
W
wusongqing 已提交
206 207 208

**Return value**

W
wusongqing 已提交
209 210
  | Type| Description|
  | -------- | -------- |
211
  | Promise<[MissionInfo](js-apis-inner-application-missionInfo.md)> | Promise used to return the mission information obtained.|
W
wusongqing 已提交
212 213 214

**Example**

215
  ```ts
W
wusongqing 已提交
216 217
  import missionManager from '@ohos.application.missionManager'

W
wusongqing 已提交
218
  var mission = missionManager.getMissionInfo("", 10).catch(function (err){
W
wusongqing 已提交
219 220 221 222 223 224 225
      console.log(err);
  });
  ```


## missionManager.getMissionInfos

W
wusongqing 已提交
226
getMissionInfos(deviceId: string, numMax: number, callback: AsyncCallback<Array<MissionInfo>>): void;
W
wusongqing 已提交
227

W
wusongqing 已提交
228
Obtains information about all missions. This API uses an asynchronous callback to return the result.
W
wusongqing 已提交
229

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

W
wusongqing 已提交
232 233
**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

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

W
wusongqing 已提交
236 237
**Parameters**

W
wusongqing 已提交
238 239 240 241
  | 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.|
242
  | callback | AsyncCallback<Array<[MissionInfo](js-apis-inner-application-missionInfo.md)>> | Yes| Callback used to return the array of mission information obtained.|
W
wusongqing 已提交
243 244 245

**Example**

246
  ```ts
W
wusongqing 已提交
247 248 249
  import missionManager from '@ohos.application.missionManager'

  missionManager.getMissionInfos("", 10, (error, missions) => {
250 251 252 253 254
      if (error.code) {
          console.log("getMissionInfos failed, error.code:" + JSON.stringify(error.code) +
            "error.message:" + JSON.stringify(error.message));
          return;
      }
W
wusongqing 已提交
255 256 257 258 259 260 261 262
      console.log("size = " + missions.length);
      console.log("missions = " + JSON.stringify(missions));
  })
  ```


## missionManager.getMissionInfos

W
wusongqing 已提交
263
getMissionInfos(deviceId: string, numMax: number): Promise<Array<MissionInfo>>;
W
wusongqing 已提交
264

W
wusongqing 已提交
265
Obtains information about all missions. This API uses a promise to return the result.
W
wusongqing 已提交
266

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

W
wusongqing 已提交
269 270
**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

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

W
wusongqing 已提交
273 274
**Parameters**

W
wusongqing 已提交
275 276 277 278
  | 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.|
W
wusongqing 已提交
279 280 281

**Return value**

W
wusongqing 已提交
282 283
  | Type| Description|
  | -------- | -------- |
284
  | Promise<Array<[MissionInfo](js-apis-inner-application-missionInfo.md)>> | Promise used to return the array of mission information obtained.|
W
wusongqing 已提交
285 286 287

**Example**

288
  ```ts
W
wusongqing 已提交
289 290
  import missionManager from '@ohos.application.missionManager'

W
wusongqing 已提交
291
  var allMissions = missionManager.getMissionInfos("", 10).catch(function (err){
W
wusongqing 已提交
292 293 294 295 296 297 298
      console.log(err);
  });
  ```


## missionManager.getMissionSnapShot

W
wusongqing 已提交
299
getMissionSnapShot(deviceId: string, missionId: number, callback: AsyncCallback<MissionSnapshot>): void;
W
wusongqing 已提交
300 301 302

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

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

W
wusongqing 已提交
305 306
**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

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

W
wusongqing 已提交
309 310
**Parameters**

W
wusongqing 已提交
311 312 313 314
  | 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.|
315
  | callback | AsyncCallback<[MissionSnapshot](js-apis-inner-application-missionSnapshot.md)> | Yes| Callback used to return the snapshot information obtained.|
W
wusongqing 已提交
316 317 318

**Example**

319
  ```ts
W
wusongqing 已提交
320 321 322
  import missionManager from '@ohos.application.missionManager'

  missionManager.getMissionInfos("", 10, (error, missions) => {
323 324 325 326 327
    if (error.code) {
        console.log("getMissionInfos failed, error.code:" + JSON.stringify(error.code) +
            "error.message:" + JSON.stringify(error.message));
        return;
    }
W
wusongqing 已提交
328 329 330 331 332
    console.log("size = " + missions.length);
    console.log("missions = " + JSON.stringify(missions));
    var id = missions[0].missionId;

    missionManager.getMissionSnapShot("", id, (error, snapshot) => {
333 334 335 336 337 338
      if (error.code) {
          console.log("getMissionSnapShot failed, error.code:" + JSON.stringify(error.code) +
            "error.message:" + JSON.stringify(error.message));
          return;
      }
      console.log("bundleName = " + snapshot.ability.bundleName);
W
wusongqing 已提交
339 340 341 342 343 344 345
  })
  })
  ```


## missionManager.getMissionSnapShot

W
wusongqing 已提交
346
getMissionSnapShot(deviceId: string, missionId: number): Promise<MissionSnapshot>;
W
wusongqing 已提交
347 348 349

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

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

W
wusongqing 已提交
352 353
**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

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

W
wusongqing 已提交
356 357
**Parameters**

W
wusongqing 已提交
358 359 360 361
  | 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.|
W
wusongqing 已提交
362 363 364

**Return value**

W
wusongqing 已提交
365 366
  | Type| Description|
  | -------- | -------- |
367
  | Promise<[MissionSnapshot](js-apis-inner-application-missionSnapshot.md)> | Promise used to return the snapshot information obtained.|
W
wusongqing 已提交
368 369 370

**Example**

371
  ```ts
W
wusongqing 已提交
372 373
  import missionManager from '@ohos.application.missionManager'

W
wusongqing 已提交
374 375 376 377 378 379 380 381 382 383 384
  var 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));
    var id = allMissions[0].missionId;

    var snapshot = missionManager.getMissionSnapShot("", id).catch(function (err){
        console.log(err);
    });
W
wusongqing 已提交
385 386
  ```

387 388 389 390 391 392
## missionManager.getLowResolutionMissionSnapShot<sup>9+</sup>

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.

393
**Required permissions**: ohos.permission.MANAGE_MISSIONS
394 395 396 397 398 399 400 401 402 403 404

**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.|
405
  | callback | AsyncCallback&lt;[MissionSnapshot](js-apis-inner-application-missionSnapshot.md)&gt; | Yes| Callback used to return the snapshot information obtained.|
406 407 408

**Example**

409
  ```ts
410 411 412
  import missionManager from '@ohos.application.missionManager'

  missionManager.getMissionInfos("", 10, (error, missions) => {
413 414 415 416 417
    if (error.code) {
        console.log("getMissionInfos failed, error.code:" + JSON.stringify(error.code) +
            "error.message:" + JSON.stringify(error.message));
        return;
    }
418 419 420 421 422
    console.log("size = " + missions.length);
    console.log("missions = " + JSON.stringify(missions));
    var id = missions[0].missionId;

    missionManager.getLowResolutionMissionSnapShot("", id, (error, snapshot) => {
423 424 425 426 427 428
      if (error.code) {
          console.log("getLowResolutionMissionSnapShot failed, error.code:" + JSON.stringify(error.code) +
            "error.message:" + JSON.stringify(error.message));
          return;
      }
  	  console.log("bundleName = " + snapshot.ability.bundleName);
429 430 431 432 433 434 435 436 437 438 439
  })
  })
  ```


## missionManager.getLowResolutionMissionSnapShot<sup>9+</sup>

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.

440
**Required permissions**: ohos.permission.MANAGE_MISSIONS
441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456

**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|
  | -------- | -------- |
457
  | Promise&lt;[MissionSnapshot](js-apis-inner-application-missionSnapshot.md)&gt; | Promise used to return the snapshot information obtained.|
458 459 460

**Example**

461
  ```ts
462 463 464 465 466 467 468 469 470 471 472 473 474 475 476
  import missionManager from '@ohos.application.missionManager'

  var 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));
    var id = allMissions[0].missionId;

    var snapshot = missionManager.getLowResolutionMissionSnapShot("", id).catch(function (err){
        console.log(err);
    });
  ```

W
wusongqing 已提交
477 478 479

## missionManager.lockMission

W
wusongqing 已提交
480
lockMission(missionId: number, callback: AsyncCallback&lt;void&gt;): void;
W
wusongqing 已提交
481 482 483

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

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

W
wusongqing 已提交
486 487
**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

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

W
wusongqing 已提交
490 491
**Parameters**

W
wusongqing 已提交
492 493 494 495
  | Name| Type| Mandatory| Description|
  | -------- | -------- | -------- | -------- |
  | missionId | number | Yes| Mission ID.|
  | callback | AsyncCallback&lt;void&gt; | Yes| Callback used to return the result.|
W
wusongqing 已提交
496 497 498

**Example**

499
  ```ts
W
wusongqing 已提交
500 501 502
  import missionManager from '@ohos.application.missionManager'

  missionManager.getMissionInfos("", 10, (error, missions) => {
503 504 505 506 507
    if (error.code) {
        console.log("getMissionInfos failed, error.code:" + JSON.stringify(error.code) +
            "error.message:" + JSON.stringify(error.message));
        return;
    }
W
wusongqing 已提交
508 509 510 511 512 513 514 515 516 517 518 519 520
    console.log("size = " + missions.length);
    console.log("missions = " + JSON.stringify(missions));
    var id = missions[0].missionId;

    missionManager.lockMission(id).then(() => {
  	console.log("lockMission is called ");
  });
  });
  ```


## missionManager.lockMission

W
wusongqing 已提交
521
lockMission(missionId: number): Promise&lt;void&gt;;
W
wusongqing 已提交
522 523 524

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

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

W
wusongqing 已提交
527 528
**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

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

W
wusongqing 已提交
531 532
**Parameters**

W
wusongqing 已提交
533 534 535
  | Name| Type| Mandatory| Description|
  | -------- | -------- | -------- | -------- |
  | missionId | number | Yes| Mission ID.|
W
wusongqing 已提交
536

W
wusongqing 已提交
537 538
**Return value**

W
wusongqing 已提交
539 540 541
  | Type| Description| 
  | -------- | -------- |
  | Promise&lt;void&gt; | Promise used to return the result.| 
W
wusongqing 已提交
542

W
wusongqing 已提交
543 544
**Example**

545
  ```ts
W
wusongqing 已提交
546
  import missionManager from '@ohos.application.missionManager'
W
wusongqing 已提交
547 548 549 550
  var allMissions;
  missionManager.getMissionInfos("",10).then(function(res){
    allMissions=res;
  }).catch(function(err){console.log(err);});
W
wusongqing 已提交
551 552 553 554
  console.log("size = " + allMissions.length);
  console.log("missions = " + JSON.stringify(allMissions));
  var id = allMissions[0].missionId;

W
wusongqing 已提交
555
  missionManager.lockMission(id).catch(function (err){
W
wusongqing 已提交
556 557 558 559 560 561 562
      console.log(err);
  });
  ```


## missionManager.unlockMission

W
wusongqing 已提交
563
unlockMission(missionId: number, callback: AsyncCallback&lt;void&gt;): void;
W
wusongqing 已提交
564 565 566

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

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

W
wusongqing 已提交
569 570
**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

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

W
wusongqing 已提交
573 574
**Parameters**

W
wusongqing 已提交
575 576 577 578
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| missionId | number | Yes| Mission ID.|
| callback | AsyncCallback&lt;void&gt; | Yes| Callback used to return the result.|
W
wusongqing 已提交
579 580 581

**Example**

582
  ```ts
W
wusongqing 已提交
583 584 585
  import missionManager from '@ohos.application.missionManager'

  missionManager.getMissionInfos("", 10, (error, missions) => {
586 587 588 589 590
    if (error.code) {
        console.log("getMissionInfos failed, error.code:" + JSON.stringify(error.code) +
            "error.message:" + JSON.stringify(error.message));
        return;
    }
W
wusongqing 已提交
591 592 593 594 595 596 597 598 599 600 601 602 603
    console.log("size = " + missions.length);
    console.log("missions = " + JSON.stringify(missions));
    var id = missions[0].missionId;

    missionManager.unlockMission(id).then(() => {
  	console.log("unlockMission is called ");
  });
  });
  ```


## missionManager.unlockMission

W
wusongqing 已提交
604
unlockMission(missionId: number): Promise&lt;void&gt;;
W
wusongqing 已提交
605 606 607

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

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

W
wusongqing 已提交
610 611
**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

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

W
wusongqing 已提交
614 615
**Parameters**

W
wusongqing 已提交
616 617 618
  | Name| Type| Mandatory| Description|
  | -------- | -------- | -------- | -------- |
  | missionId | number | Yes| Mission ID.|
W
wusongqing 已提交
619

W
wusongqing 已提交
620 621
**Return value**

W
wusongqing 已提交
622 623 624
  | Type| Description| 
  | -------- | -------- |
  | Promise&lt;void&gt; | Promise used to return the result.| 
W
wusongqing 已提交
625

W
wusongqing 已提交
626 627
**Example**

628
  ```ts
W
wusongqing 已提交
629 630
  import missionManager from '@ohos.application.missionManager'

W
wusongqing 已提交
631 632 633 634
  var allMissions;
  missionManager.getMissionInfos("",10).then(function(res){
    allMissions=res;
  }).catch(function(err){console.log(err);});
W
wusongqing 已提交
635 636 637 638
  console.log("size = " + allMissions.length);
  console.log("missions = " + JSON.stringify(allMissions));
  var id = allMissions[0].missionId;

W
wusongqing 已提交
639
  missionManager.lockMission(id).catch(function (err){
W
wusongqing 已提交
640 641
      console.log(err);
  });
W
wusongqing 已提交
642
  missionManager.unlockMission(id).catch(function (err){
W
wusongqing 已提交
643 644 645 646 647 648 649
      console.log(err);
  });
  ```


## missionManager.clearMission

W
wusongqing 已提交
650
clearMission(missionId: number, callback: AsyncCallback&lt;void&gt;): void;
W
wusongqing 已提交
651 652 653

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

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

W
wusongqing 已提交
656 657
**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

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

W
wusongqing 已提交
660 661
**Parameters**

W
wusongqing 已提交
662 663 664 665
  | Name| Type| Mandatory| Description|
  | -------- | -------- | -------- | -------- |
  | missionId | number | Yes| Mission ID.|
  | callback | AsyncCallback&lt;void&gt; | Yes| Callback used to return the result.|
W
wusongqing 已提交
666 667 668

**Example**

669
  ```ts
W
wusongqing 已提交
670 671 672
  import missionManager from '@ohos.application.missionManager'

  missionManager.getMissionInfos("", 10, (error, missions) => {
673 674 675 676 677
    if (error.code) {
        console.log("getMissionInfos failed, error.code:" + JSON.stringify(error.code) +
            "error.message:" + JSON.stringify(error.message));
        return;
    }
W
wusongqing 已提交
678 679 680 681 682 683 684 685 686 687 688 689 690
    console.log("size = " + missions.length);
    console.log("missions = " + JSON.stringify(missions));
    var id = missions[0].missionId;

    missionManager.clearMission(id).then(() => {
  	console.log("clearMission is called ");
  });
  });
  ```


## missionManager.clearMission

W
wusongqing 已提交
691
clearMission(missionId: number): Promise&lt;void&gt;;
W
wusongqing 已提交
692 693 694

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

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

W
wusongqing 已提交
697 698
**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

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

W
wusongqing 已提交
701 702
**Parameters**

W
wusongqing 已提交
703 704 705
  | Name| Type| Mandatory| Description|
  | -------- | -------- | -------- | -------- |
  | missionId | number | Yes| Mission ID.|
W
wusongqing 已提交
706

W
wusongqing 已提交
707 708
**Return value**

W
wusongqing 已提交
709 710 711
  | Type| Description| 
  | -------- | -------- |
  | Promise&lt;void&gt; | Promise used to return the result.| 
W
wusongqing 已提交
712

W
wusongqing 已提交
713 714
**Example**

715
  ```ts
W
wusongqing 已提交
716 717
  import missionManager from '@ohos.application.missionManager'

W
wusongqing 已提交
718 719 720 721
  var allMissions;
  missionManager.getMissionInfos("",10).then(function(res){
    allMissions=res;
  }).catch(function(err){console.log(err);});
W
wusongqing 已提交
722 723 724 725
  console.log("size = " + allMissions.length);
  console.log("missions = " + JSON.stringify(allMissions));
  var id = allMissions[0].missionId;

W
wusongqing 已提交
726
  missionManager.clearMission(id).catch(function (err){
W
wusongqing 已提交
727 728 729 730 731 732 733
    console.log(err);
  });
  ```


## missionManager.clearAllMissions

W
wusongqing 已提交
734
clearAllMissions(callback: AsyncCallback&lt;void&gt;): void;
W
wusongqing 已提交
735 736 737

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

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

W
wusongqing 已提交
740 741
**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

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

W
wusongqing 已提交
744 745
**Example**

746
  ```ts
W
wusongqing 已提交
747 748 749 750 751 752 753 754 755 756
  import missionManager from '@ohos.application.missionManager'

  missionManager.clearAllMissions().then(() => {
    console.log("clearAllMissions is called ");
  });
  ```


## missionManager.clearAllMissions

W
wusongqing 已提交
757
clearAllMissions(): Promise&lt;void&gt;;
W
wusongqing 已提交
758 759 760

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

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

W
wusongqing 已提交
763 764
**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

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

W
wusongqing 已提交
767 768
**Return value**

W
wusongqing 已提交
769 770 771
  | Type| Description| 
  | -------- | -------- |
  | Promise&lt;void&gt; | Promise used to return the result.| 
W
wusongqing 已提交
772

W
wusongqing 已提交
773 774
**Example**

775
  ```ts
W
wusongqing 已提交
776
  import missionManager from '@ohos.application.missionManager'
W
wusongqing 已提交
777
  missionManager.clearAllMissions().catch(function (err){
W
wusongqing 已提交
778 779 780 781 782 783 784
    console.log(err);
  });
  ```


## missionManager.moveMissionToFront

W
wusongqing 已提交
785
moveMissionToFront(missionId: number, callback: AsyncCallback&lt;void&gt;): void;
W
wusongqing 已提交
786 787 788

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

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

W
wusongqing 已提交
791 792
**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

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

W
wusongqing 已提交
795 796
**Parameters**

W
wusongqing 已提交
797 798 799 800
  | Name| Type| Mandatory| Description|
  | -------- | -------- | -------- | -------- |
  | missionId | number | Yes| Mission ID.|
  | callback | AsyncCallback&lt;void&gt; | Yes| Callback used to return the result.|
W
wusongqing 已提交
801 802 803

**Example**

804
  ```ts
W
wusongqing 已提交
805 806 807
  import missionManager from '@ohos.application.missionManager'

  missionManager.getMissionInfos("", 10, (error, missions) => {
808 809 810 811 812
    if (error.code) {
        console.log("getMissionInfos failed, error.code:" + JSON.stringify(error.code) +
            "error.message:" + JSON.stringify(error.message));
        return;
    }
W
wusongqing 已提交
813 814 815 816 817 818 819 820 821 822 823 824 825
    console.log("size = " + missions.length);
    console.log("missions = " + JSON.stringify(missions));
    var id = missions[0].missionId;

    missionManager.moveMissionToFront(id).then(() => {
  	console.log("moveMissionToFront is called ");
  });
  });
  ```


## missionManager.moveMissionToFront

W
wusongqing 已提交
826
moveMissionToFront(missionId: number, options: StartOptions, callback: AsyncCallback&lt;void&gt;): void;
W
wusongqing 已提交
827

W
wusongqing 已提交
828
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.
W
wusongqing 已提交
829

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

W
wusongqing 已提交
832 833
**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

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

W
wusongqing 已提交
836 837
**Parameters**

W
wusongqing 已提交
838 839 840
  | Name| Type| Mandatory| Description|
  | -------- | -------- | -------- | -------- |
  | missionId | number | Yes| Mission ID.|
841
  | options | [StartOptions](js-apis-application-startOptions.md) | Yes| Startup parameters, which are used to specify the window mode and device ID for switching the mission to the foreground.|
W
wusongqing 已提交
842
  | callback | AsyncCallback&lt;void&gt; | Yes| Callback used to return the result.|
W
wusongqing 已提交
843 844 845

**Example**

846
  ```ts
W
wusongqing 已提交
847 848 849
  import missionManager from '@ohos.application.missionManager'

  missionManager.getMissionInfos("", 10, (error, missions) => {
850 851 852 853 854
    if (error.code) {
        console.log("getMissionInfos failed, error.code:" + JSON.stringify(error.code) +
            "error.message:" + JSON.stringify(error.message));
        return;
    }
W
wusongqing 已提交
855 856 857 858 859 860 861 862 863 864 865 866 867
    console.log("size = " + missions.length);
    console.log("missions = " + JSON.stringify(missions));
    var id = missions[0].missionId;

    missionManager.moveMissionToFront(id,{windowMode : 101}).then(() => {
  	console.log("moveMissionToFront is called ");
    });
  });
  ```


## missionManager.moveMissionToFront

W
wusongqing 已提交
868
moveMissionToFront(missionId: number, options?: StartOptions): Promise&lt;void&gt;;
W
wusongqing 已提交
869

W
wusongqing 已提交
870
Switches a given mission to the foreground, with the startup parameters for the switching specified. This API uses a promise to return the result.
W
wusongqing 已提交
871

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

W
wusongqing 已提交
874 875
**System capability**: SystemCapability.Ability.AbilityRuntime.Mission

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

W
wusongqing 已提交
878 879
**Parameters**

W
wusongqing 已提交
880 881 882
  | Name| Type| Mandatory| Description|
  | -------- | -------- | -------- | -------- |
  | missionId | number | Yes| Mission ID.|
883
  | options | [StartOptions](js-apis-application-startOptions.md) | No| Startup parameters, which are used to specify the window mode and device ID for switching the mission to the foreground.|
W
wusongqing 已提交
884

W
wusongqing 已提交
885 886
**Return value**

W
wusongqing 已提交
887 888 889
  | Type| Description| 
  | -------- | -------- |
  | Promise&lt;void&gt; | Promise used to return the result.| 
W
wusongqing 已提交
890

W
wusongqing 已提交
891 892
**Example**

893
  ```ts
W
wusongqing 已提交
894 895
  import missionManager from '@ohos.application.missionManager'

W
wusongqing 已提交
896 897 898 899
  var allMissions;
  missionManager.getMissionInfos("",10).then(function(res){
    allMissions=res;
  }).catch(function(err){console.log(err);});
W
wusongqing 已提交
900 901 902 903
  console.log("size = " + allMissions.length);
  console.log("missions = " + JSON.stringify(allMissions));
  var id = allMissions[0].missionId;

W
wusongqing 已提交
904
  missionManager.moveMissionToFront(id).catch(function (err){
W
wusongqing 已提交
905 906 907
    console.log(err);
  });
  ```