You need to sign in or sign up before continuing.
js-apis-ability-context.md 56.2 KB
Newer Older
1 2
# AbilityContext

Y
yuyaozhi 已提交
3 4
AbilityContext是Ability的上下文环境,继承自Context。

H
HuangXW 已提交
5
AbilityContext模块提供允许访问特定Ability的资源的能力,包括对Ability的启动、停止的设置、获取caller通信接口、拉起弹窗请求用户授权等。
Y
yuyaozhi 已提交
6

Y
yuyaozhi 已提交
7
> **说明:**
Z
zhangyafei.echo 已提交
8
>
H
HuangXW 已提交
9 10
>  - 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>  - 本模块接口仅可在Stage模型下使用。
11

ahjxliubao2's avatar
ahjxliubao2 已提交
12 13
## 使用说明

R
RayShih 已提交
14 15
在使用AbilityContext的功能前,需要通过Ability子类实例获取。

16 17
```ts
import Ability from '@ohos.app.ability.UIAbility';
H
HuangXW 已提交
18 19

 let context = undefined;
ahjxliubao2's avatar
ahjxliubao2 已提交
20 21
class MainAbility extends Ability {
    onWindowStageCreate(windowStage) {
H
HuangXW 已提交
22
        context = this.context;
ahjxliubao2's avatar
ahjxliubao2 已提交
23 24 25 26
    }
}
```

27 28
## 属性

29 30
**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core

D
merge  
donglin 已提交
31
| 名称 | 类型 | 可读 | 可写 | 说明 |
32
| -------- | -------- | -------- | -------- | -------- |
G
guyuanzhang 已提交
33 34
| abilityInfo | AbilityInfo | 是 | 否 | Abilityinfo相关信息 |
| currentHapModuleInfo | HapModuleInfo | 是 | 否 | 当前hap包的信息 |
M
m00512953 已提交
35
| config | [Configuration](js-apis-application-configuration.md) | 是 | 否 | 表示配置信息。 |
36

Y
yuyaozhi 已提交
37
## AbilityContext.startAbility
38

Y
yuyaozhi 已提交
39
startAbility(want: Want, callback: AsyncCallback<void>): void;
40

41
启动Ability(callback形式)。
42

Y
yuyaozhi 已提交
43
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
ahjxliubao2's avatar
ahjxliubao2 已提交
44

Y
yuyaozhi 已提交
45
**参数:**
ahjxliubao2's avatar
ahjxliubao2 已提交
46

G
guyuanzhang 已提交
47 48
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
M
m00512953 已提交
49
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
G
guyuanzhang 已提交
50
| callback | AsyncCallback<void> | 是 | callback形式返回启动结果 |
51

H
HuangXW 已提交
52 53 54 55 56
**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 401 | Invalid input parameter. |
D
merge  
donglin 已提交
57
其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md)
H
HuangXW 已提交
58

Y
yuyaozhi 已提交
59 60
**示例:**

61
  ```ts
62
  var want = {
63 64
    bundleName: "com.example.myapp",
    abilityName: "MyAbility"
65
  };
H
HuangXW 已提交
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82

  try {
    this.context.startAbility(want, (error) => {
      if (error.code) {
        // 处理业务逻辑错误
        console.log('startAbility failed, error.code: ' + JSON.stringify(error.code) +
          ' error.message: ' + JSON.stringify(error.message));
        return;
      }
      // 执行正常业务
      console.log('startAbility succeed');
    });
  } catch (paramError) {
    // 处理入参错误异常
    console.log('error.code: ' + JSON.stringify(paramError.code) +
      ' error.message: ' + JSON.stringify(paramError.message));
  }
83 84 85
  ```


Y
yuyaozhi 已提交
86
## AbilityContext.startAbility
87

Y
yuyaozhi 已提交
88
startAbility(want: Want, options: StartOptions, callback: AsyncCallback<void>): void;
ahjxliubao2's avatar
ahjxliubao2 已提交
89

90
启动Ability(callback形式)。
ahjxliubao2's avatar
ahjxliubao2 已提交
91

Y
yuyaozhi 已提交
92
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
ahjxliubao2's avatar
ahjxliubao2 已提交
93

Y
yuyaozhi 已提交
94
**参数:**
ahjxliubao2's avatar
ahjxliubao2 已提交
95

G
guyuanzhang 已提交
96 97
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
M
m00512953 已提交
98 99
| want | [Want](js-apis-application-want.md)  | 是 | 启动Ability的want信息。 |
| options | [StartOptions](js-apis-application-startOptions.md) | 是 | 启动Ability所携带的参数。 |
G
guyuanzhang 已提交
100
| callback | AsyncCallback<void> | 是 | callback形式返回启动结果。 |
ahjxliubao2's avatar
ahjxliubao2 已提交
101

H
HuangXW 已提交
102 103
**错误码:**

104
| 错误码ID | 错误信息 |
H
HuangXW 已提交
105 106
| ------- | -------------------------------- |
| 401 | Invalid input parameter. |
D
merge  
donglin 已提交
107
其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md)
H
HuangXW 已提交
108

Y
yuyaozhi 已提交
109
**示例:**
Z
zhangyafei.echo 已提交
110

111
  ```ts
ahjxliubao2's avatar
ahjxliubao2 已提交
112
  var want = {
113 114 115
    deviceId: "",
    bundleName: "com.extreme.test",
    abilityName: "MainAbility"
ahjxliubao2's avatar
ahjxliubao2 已提交
116 117
  };
  var options = {
H
HuangXW 已提交
118
    windowMode: 0
ahjxliubao2's avatar
ahjxliubao2 已提交
119 120
  };

H
HuangXW 已提交
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
  try {
    this.context.startAbility(want, options, (error) => {
      if (error.code) {
        // 处理业务逻辑错误
        console.log('startAbility failed, error.code: ' + JSON.stringify(error.code) +
          ' error.message: ' + JSON.stringify(error.message));
        return;
      }
      // 执行正常业务
      console.log('startAbility succeed');
    });
  } catch (paramError) {
    // 处理入参错误异常
    console.log('error.code: ' + JSON.stringify(paramError.code) +
      ' error.message: ' + JSON.stringify(paramError.message));
  }
  ```
ahjxliubao2's avatar
ahjxliubao2 已提交
138

Y
yuyaozhi 已提交
139
## AbilityContext.startAbility
ahjxliubao2's avatar
ahjxliubao2 已提交
140

Y
yuyaozhi 已提交
141
startAbility(want: Want, options?: StartOptions): Promise<void>;
142

143
启动Ability(promise形式)。
144

Y
yuyaozhi 已提交
145
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
ahjxliubao2's avatar
ahjxliubao2 已提交
146

Y
yuyaozhi 已提交
147
**参数:**
ahjxliubao2's avatar
ahjxliubao2 已提交
148

G
guyuanzhang 已提交
149 150
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
M
m00512953 已提交
151 152
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| options | [StartOptions](js-apis-application-startOptions.md) | 否 | 启动Ability所携带的参数。 |
153

Y
yuyaozhi 已提交
154 155
**返回值:**

G
guyuanzhang 已提交
156 157 158
| 类型 | 说明 |
| -------- | -------- |
| Promise<void> | Promise形式返回启动结果。 |
159

H
HuangXW 已提交
160 161 162 163 164
**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 401 | Invalid input parameter. |
D
merge  
donglin 已提交
165
其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md)
H
HuangXW 已提交
166

Y
yuyaozhi 已提交
167 168
**示例:**

169
  ```ts
170
  var want = {
171 172
    bundleName: "com.example.myapp",
    abilityName: "MyAbility"
173
  };
ahjxliubao2's avatar
ahjxliubao2 已提交
174 175 176
  var options = {
  	windowMode: 0,
  };
H
HuangXW 已提交
177 178 179 180 181 182 183 184 185

  try {
    this.context.startAbility(want, options)
      .then((data) => {
        // 执行正常业务
        console.log('startAbility succeed');
      })
      .catch((error) => {
        // 处理业务逻辑错误
186 187
        console.log('startAbility failed, error.code: ' + JSON.stringify(error.code) +
          ' error.message: ' + JSON.stringify(error.message));
H
HuangXW 已提交
188 189 190 191 192 193
      });
  } catch (paramError) {
    // 处理入参错误异常
    console.log('error.code: ' + JSON.stringify(paramError.code) +
      ' error.message: ' + JSON.stringify(paramError.message));
  }
194 195 196
  ```


Y
yuyaozhi 已提交
197
## AbilityContext.startAbilityForResult
198

199
startAbilityForResult(want: Want, callback: AsyncCallback<AbilityResult>): void;
200

201
启动Ability并在该Ability退出的时候返回执行结果(callback形式)。
202

Y
yuyaozhi 已提交
203
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
ahjxliubao2's avatar
ahjxliubao2 已提交
204

Y
yuyaozhi 已提交
205
**参数:**
ahjxliubao2's avatar
ahjxliubao2 已提交
206

G
guyuanzhang 已提交
207 208
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
M
m00512953 已提交
209 210
| want |[Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| callback | AsyncCallback<[AbilityResult](js-apis-inner-ability-abilityResult.md)> | 是 | 执行结果回调函数。 |
211

H
HuangXW 已提交
212 213 214 215 216
**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 401 | Invalid input parameter. |
D
merge  
donglin 已提交
217
其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md)
218

Y
yuyaozhi 已提交
219 220
**示例:**

221
  ```ts
H
HuangXW 已提交
222
  var want = {
223 224 225
    deviceId: "",
    bundleName: "com.extreme.test",
    abilityName: "MainAbility"
H
HuangXW 已提交
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
  };

  try {
    this.context.startAbilityForResult(want, (error, result) => {
      if (error.code) {
        // 处理业务逻辑错误
        console.log('startAbilityForResult failed, error.code: ' + JSON.stringify(error.code) +
          ' error.message: ' + JSON.stringify(error.message));
        return;
      }
      // 执行正常业务
      console.log("startAbilityForResult succeed, result.resultCode = " +
        result.resultCode)
    });
  } catch (paramError) {
    // 处理入参错误异常
    console.log('error.code: ' + JSON.stringify(paramError.code) +
      ' error.message: ' + JSON.stringify(paramError.message));
  }
245 246
  ```

Y
yuyaozhi 已提交
247
## AbilityContext.startAbilityForResult
ahjxliubao2's avatar
ahjxliubao2 已提交
248 249 250

startAbilityForResult(want: Want, options: StartOptions, callback: AsyncCallback<AbilityResult>): void;

251
启动Ability并在该Ability退出的时候返回执行结果(callback形式)。
ahjxliubao2's avatar
ahjxliubao2 已提交
252

Y
yuyaozhi 已提交
253
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
ahjxliubao2's avatar
ahjxliubao2 已提交
254

Y
yuyaozhi 已提交
255
**参数:**
ahjxliubao2's avatar
ahjxliubao2 已提交
256

G
guyuanzhang 已提交
257 258
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
M
m00512953 已提交
259 260 261
| want |[Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| options | [StartOptions](js-apis-application-startOptions.md) | 是 | 启动Ability所携带的参数。 |
| callback | AsyncCallback<[AbilityResult](js-apis-inner-ability-abilityResult.md)> | 是 | 执行结果回调函数。 |
ahjxliubao2's avatar
ahjxliubao2 已提交
262

H
HuangXW 已提交
263 264 265 266 267
**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 401 | Invalid input parameter. |
D
merge  
donglin 已提交
268
其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md)
ahjxliubao2's avatar
ahjxliubao2 已提交
269

Y
yuyaozhi 已提交
270 271
**示例:**

272
  ```ts
H
HuangXW 已提交
273
  var want = {
274 275 276
    deviceId: "",
    bundleName: "com.extreme.test",
    abilityName: "MainAbility"
H
HuangXW 已提交
277
  };
ahjxliubao2's avatar
ahjxliubao2 已提交
278 279 280
  var options = {
    windowMode: 0,
  };
H
HuangXW 已提交
281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298

  try {
    this.context.startAbilityForResult(want, options, (error, result) => {
      if (error.code) {
        // 处理业务逻辑错误
        console.log('startAbilityForResult failed, error.code: ' + JSON.stringify(error.code) +
          ' error.message: ' + JSON.stringify(error.message));
        return;
      }
      // 执行正常业务
      console.log("startAbilityForResult succeed, result.resultCode = " +
        result.resultCode)
    });
  } catch (paramError) {
    // 处理入参错误异常
    console.log('error.code: ' + JSON.stringify(paramError.code) +
      ' error.message: ' + JSON.stringify(paramError.message));
  }
ahjxliubao2's avatar
ahjxliubao2 已提交
299 300
  ```

301

Y
yuyaozhi 已提交
302
## AbilityContext.startAbilityForResult
303

Y
yuyaozhi 已提交
304
startAbilityForResult(want: Want, options?: StartOptions): Promise<AbilityResult>;
305

306
启动Ability并在该Ability退出的时候返回执行结果(promise形式)。
307

Y
yuyaozhi 已提交
308
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
ahjxliubao2's avatar
ahjxliubao2 已提交
309

Y
yuyaozhi 已提交
310
**参数:**
ahjxliubao2's avatar
ahjxliubao2 已提交
311

G
guyuanzhang 已提交
312 313
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
M
m00512953 已提交
314 315
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| options | [StartOptions](js-apis-application-startOptions.md) | 否 | 启动Ability所携带的参数。 |
ahjxliubao2's avatar
ahjxliubao2 已提交
316

317

Y
yuyaozhi 已提交
318 319
**返回值:**

G
guyuanzhang 已提交
320 321
| 类型 | 说明 |
| -------- | -------- |
M
m00512953 已提交
322
| Promise<[AbilityResult](js-apis-inner-ability-abilityResult.md)> | Promise形式返回执行结果。 |
323

H
HuangXW 已提交
324 325 326 327 328
**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 401 | Invalid input parameter. |
D
merge  
donglin 已提交
329
其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md)
H
HuangXW 已提交
330

Y
yuyaozhi 已提交
331 332
**示例:**

333
  ```ts
H
HuangXW 已提交
334
  var want = {
335 336
    bundleName: "com.example.myapp",
    abilityName: "MyAbility"
H
HuangXW 已提交
337
  };
ahjxliubao2's avatar
ahjxliubao2 已提交
338
  var options = {
H
HuangXW 已提交
339
  	windowMode: 0,
ahjxliubao2's avatar
ahjxliubao2 已提交
340
  };
H
HuangXW 已提交
341 342 343 344 345 346 347 348 349

  try {
    this.context.startAbilityForResult(want, options)
      .then((result) => {
        // 执行正常业务
        console.log("startAbilityForResult succeed, result.resultCode = " + result.resultCode);
      })
      .catch((error) => {
        // 处理业务逻辑错误
350 351
        console.log('startAbilityForResult failed, error.code: ' + JSON.stringify(error.code) +
          ' error.message: ' + JSON.stringify(error.message));
H
HuangXW 已提交
352 353 354 355 356 357
      });
  } catch (paramError) {
    // 处理入参错误异常
    console.log('error.code: ' + JSON.stringify(paramError.code) +
      ' error.message: ' + JSON.stringify(paramError.message));
  }
358 359
  ```

360 361
## AbilityContext.startAbilityForResultWithAccount

Y
yuyaozhi 已提交
362
startAbilityForResultWithAccount(want: Want, accountId: number, callback: AsyncCallback\<AbilityResult>): void;
363 364 365 366 367 368 369 370 371 372 373 374 375

启动一个Ability并在该Ability帐号销毁时返回执行结果(callback形式)。

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

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
M
m00512953 已提交
376
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
377
| accountId | number | 是 | 系统帐号的帐号ID,详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
378 379
| callback | AsyncCallback\<AbilityResult\> | 是 | 启动Ability的回调函数,返回Ability结果。 |

H
HuangXW 已提交
380 381 382 383 384
**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 401 | Invalid input parameter. |
D
merge  
donglin 已提交
385
其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md)
H
HuangXW 已提交
386

387 388
**示例:**

389
  ```ts
390
  var want = {
391 392 393
    deviceId: "",
    bundleName: "com.extreme.test",
    abilityName: "MainAbility"
394 395
  };
  var accountId = 100;
H
HuangXW 已提交
396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413

  try {
    this.context.startAbilityForResultWithAccount(want, accountId, (error, result) => {
      if (error.code) {
        // 处理业务逻辑错误
        console.log('startAbilityForResultWithAccount failed, error.code: ' + JSON.stringify(error.code) +
          ' error.message: ' + JSON.stringify(error.message));
        return;
      }
      // 执行正常业务
      console.log("startAbilityForResultWithAccount succeed, result.resultCode = " +
        result.resultCode)
    });
  } catch (paramError) {
    // 处理入参错误异常
    console.log('error.code: ' + JSON.stringify(paramError.code) +
      ' error.message: ' + JSON.stringify(paramError.message));
  }
414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
  ```


## AbilityContext.startAbilityForResultWithAccount

startAbilityForResultWithAccount(want: Want, accountId: number, options: StartOptions, callback: AsyncCallback\<void\>): void;

启动一个Ability并在该Ability帐号销毁时返回执行结果(callback形式)。

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

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
M
m00512953 已提交
433
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
434
| accountId | number | 是 | 系统帐号的帐号ID,详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
M
m00512953 已提交
435
| options | [StartOptions](js-apis-application-startOptions.md) | 是 | 启动Ability所携带的参数。 |
436 437
| callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 |

H
HuangXW 已提交
438 439 440 441 442
**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 401 | Invalid input parameter. |
D
merge  
donglin 已提交
443
其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md)
H
HuangXW 已提交
444

445 446
**示例:**

447
  ```ts
448
  var want = {
449 450 451
    deviceId: "",
    bundleName: "com.extreme.test",
    abilityName: "MainAbility"
452 453 454
  };
  var accountId = 100;
  var options = {
H
HuangXW 已提交
455
    windowMode: 0
456
  };
H
HuangXW 已提交
457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474

  try {
    this.context.startAbilityForResultWithAccount(want, accountId, options, (error, result) => {
      if (error.code) {
        // 处理业务逻辑错误
        console.log('startAbilityForResultWithAccount failed, error.code: ' + JSON.stringify(error.code) +
          ' error.message: ' + JSON.stringify(error.message));
        return;
      }
      // 执行正常业务
      console.log("startAbilityForResultWithAccount succeed, result.resultCode = " +
        result.resultCode)
    });
  } catch (paramError) {
    // 处理入参错误异常
    console.log('error.code: ' + JSON.stringify(paramError.code) +
      ' error.message: ' + JSON.stringify(paramError.message));
  }
475 476 477
  ```


478
## AbilityContext.startAbilityForResultWithAccount
479 480 481

startAbilityForResultWithAccount(want: Want, accountId: number, options?: StartOptions): Promise\<AbilityResult\>;

482
启动一个Ability并在该Ability帐号销毁时返回执行结果(promise形式)。
483 484 485 486 487 488 489 490 491 492 493

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

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
M
m00512953 已提交
494
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
495
| accountId | number | 是 | 系统帐号的帐号ID,详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
M
m00512953 已提交
496
| options | [StartOptions](js-apis-application-startOptions.md) | 否 | 启动Ability所携带的参数。 |
497 498 499 500 501 502 503

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;AbilityResult&gt; | 返回一个Promise,包含Ability结果。 |

H
HuangXW 已提交
504 505 506 507 508
**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 401 | Invalid input parameter. |
D
merge  
donglin 已提交
509
其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md)
H
HuangXW 已提交
510

511 512
**示例:**

513
  ```ts
514
  var want = {
515 516 517
    deviceId: "",
    bundleName: "com.extreme.test",
    abilityName: "MainAbility"
518 519 520
  };
  var accountId = 100;
  var options = {
H
HuangXW 已提交
521
    windowMode: 0
522
  };
H
HuangXW 已提交
523 524 525 526 527 528 529 530 531 532

  try {
    this.context.startAbilityForResultWithAccount(want, accountId, options)
      .then((result) => {
        // 执行正常业务
        console.log("startAbilityForResultWithAccount succeed, result.resultCode = " +
          result.resultCode)
      })
      .catch((error) => {
        // 处理业务逻辑错误
533 534
        console.log('startAbilityForResultWithAccount failed, error.code: ' + JSON.stringify(error.code) +
          ' error.message: ' + JSON.stringify(error.message));
H
HuangXW 已提交
535 536 537 538 539 540
      });
  } catch (paramError) {
    // 处理入参错误异常
    console.log('error.code: ' + JSON.stringify(paramError.code) +
      ' error.message: ' + JSON.stringify(paramError.message));
  }
541
  ```
542 543 544 545 546 547 548 549 550 551 552 553 554 555
## AbilityContext.startServiceExtensionAbility

startServiceExtensionAbility(want: Want, callback: AsyncCallback\<void>): void;

启动一个新的ServiceExtensionAbility(callback形式)。

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
M
m00512953 已提交
556
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
557 558
| callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 |

H
HuangXW 已提交
559 560 561 562 563
**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 401 | Invalid input parameter. |
D
merge  
donglin 已提交
564
其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md)
H
HuangXW 已提交
565

566 567
**示例:**

568
  ```ts
569
  var want = {
570 571 572
    deviceId: "",
    bundleName: "com.extreme.test",
    abilityName: "MainAbility"
573
  };
H
HuangXW 已提交
574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590

  try {
    this.context.startServiceExtensionAbility(want, (error) => {
      if (error.code) {
        // 处理业务逻辑错误
        console.log('startServiceExtensionAbility failed, error.code: ' + JSON.stringify(error.code) +
          ' error.message: ' + JSON.stringify(error.message));
        return;
      }
      // 执行正常业务
      console.log('startServiceExtensionAbility succeed');
    });
  } catch (paramError) {
    // 处理入参错误异常
    console.log('error.code: ' + JSON.stringify(paramError.code) +
      ' error.message: ' + JSON.stringify(paramError.message));
  }
591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606
  ```

## AbilityContext.startServiceExtensionAbility

startServiceExtensionAbility(want: Want): Promise\<void>;

启动一个新的ServiceExtensionAbility(Promise形式)。

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
M
m00512953 已提交
607
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
608

H
HuangXW 已提交
609 610 611 612 613
**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 401 | Invalid input parameter. |
D
merge  
donglin 已提交
614
其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md)
H
HuangXW 已提交
615

616 617
**示例:**

618
  ```ts
619
  var want = {
620 621 622
    deviceId: "",
    bundleName: "com.extreme.test",
    abilityName: "MainAbility"
623
  };
H
HuangXW 已提交
624 625 626 627 628 629 630 631 632

  try {
    this.context.startServiceExtensionAbility(want)
      .then((data) => {
        // 执行正常业务
        console.log('startServiceExtensionAbility succeed');
      })
      .catch((error) => {
        // 处理业务逻辑错误
633 634
        console.log('startServiceExtensionAbility failed, error.code: ' + JSON.stringify(error.code) +
          ' error.message: ' + JSON.stringify(error.message));
H
HuangXW 已提交
635 636 637 638 639 640
      });
  } catch (paramError) {
    // 处理入参错误异常
    console.log('error.code: ' + JSON.stringify(paramError.code) +
      ' error.message: ' + JSON.stringify(paramError.message));
  }
641
  ```
H
HuangXW 已提交
642

643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658
## AbilityContext.startServiceExtensionAbilityWithAccount

startServiceExtensionAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback\<void>): void;

启动一个新的ServiceExtensionAbility(callback形式)。

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

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
M
m00512953 已提交
659
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
660
| accountId | number | 是 | 系统帐号的帐号ID,详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
661 662
| callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 |

H
HuangXW 已提交
663 664 665 666 667
**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 401 | Invalid input parameter. |
D
merge  
donglin 已提交
668
其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md)
H
HuangXW 已提交
669

670 671
**示例:**

672
  ```ts
673
  var want = {
674 675 676
    deviceId: "",
    bundleName: "com.extreme.test",
    abilityName: "MainAbility"
677 678
  };
  var accountId = 100;
H
HuangXW 已提交
679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695

  try {
    this.context.startServiceExtensionAbilityWithAccount(want, accountId, (error) => {
      if (error.code) {
        // 处理业务逻辑错误
        console.log('startServiceExtensionAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) +
          ' error.message: ' + JSON.stringify(error.message));
        return;
      }
      // 执行正常业务
      console.log('startServiceExtensionAbilityWithAccount succeed');
    });
  } catch (paramError) {
    // 处理入参错误异常
    console.log('error.code: ' + JSON.stringify(paramError.code) +
      ' error.message: ' + JSON.stringify(paramError.message));
  }
696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713
  ```

## AbilityContext.startServiceExtensionAbilityWithAccount

startServiceExtensionAbilityWithAccount(want: Want, accountId: number): Promise\<void>;

启动一个新的ServiceExtensionAbility(Promise形式)。

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

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
M
m00512953 已提交
714
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
715
| accountId | number | 是 | 系统帐号的帐号ID,详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
716

H
HuangXW 已提交
717 718 719 720 721
**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 401 | Invalid input parameter. |
D
merge  
donglin 已提交
722
其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md)
H
HuangXW 已提交
723

724 725
**示例:**

726
  ```ts
727
  var want = {
728 729 730
    deviceId: "",
    bundleName: "com.extreme.test",
    abilityName: "MainAbility"
731 732
  };
  var accountId = 100;
H
HuangXW 已提交
733 734 735 736 737 738 739 740 741

  try {
    this.context.startServiceExtensionAbilityWithAccount(want, accountId)
      .then((data) => {
        // 执行正常业务
        console.log('startServiceExtensionAbilityWithAccount succeed');
      })
      .catch((error) => {
        // 处理业务逻辑错误
742 743
        console.log('startServiceExtensionAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) +
          ' error.message: ' + JSON.stringify(error.message));
H
HuangXW 已提交
744 745 746 747 748 749
      });
  } catch (paramError) {
    // 处理入参错误异常
    console.log('error.code: ' + JSON.stringify(paramError.code) +
      ' error.message: ' + JSON.stringify(paramError.message));
  }
750 751
  ```
## AbilityContext.stopServiceExtensionAbility
752

753 754 755 756 757 758 759 760 761 762 763 764
stopServiceExtensionAbility(want: Want, callback: AsyncCallback\<void>): void;

停止同一应用程序内的服务(callback形式)。

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
M
m00512953 已提交
765
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
766 767
| callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 |

H
HuangXW 已提交
768 769 770 771 772
**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 401 | Invalid input parameter. |
D
merge  
donglin 已提交
773
其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md)
H
HuangXW 已提交
774

775 776
**示例:**

777
  ```ts
778
  var want = {
779 780 781
    deviceId: "",
    bundleName: "com.extreme.test",
    abilityName: "MainAbility"
782
  };
H
HuangXW 已提交
783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799

  try {
    this.context.stopServiceExtensionAbility(want, (error) => {
      if (error.code) {
        // 处理业务逻辑错误
        console.log('stopServiceExtensionAbility failed, error.code: ' + JSON.stringify(error.code) +
          ' error.message: ' + JSON.stringify(error.message));
        return;
      }
      // 执行正常业务
      console.log('stopServiceExtensionAbility succeed');
    });
  } catch (paramError) {
    // 处理入参错误异常
    console.log('error.code: ' + JSON.stringify(paramError.code) +
      ' error.message: ' + JSON.stringify(paramError.message));
  }
800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815
  ```

## AbilityContext.stopServiceExtensionAbility

stopServiceExtensionAbility(want: Want): Promise\<void>;

停止同一应用程序内的服务(Promise形式)。

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
M
m00512953 已提交
816
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
817

H
HuangXW 已提交
818 819 820 821 822
**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 401 | Invalid input parameter. |
D
merge  
donglin 已提交
823
其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md)
H
HuangXW 已提交
824

825 826
**示例:**

827
  ```ts
828
  var want = {
829 830 831
    deviceId: "",
    bundleName: "com.extreme.test",
    abilityName: "MainAbility"
832
  };
H
HuangXW 已提交
833 834 835 836 837 838 839 840 841

  try {
    this.context.stopServiceExtensionAbility(want)
      .then((data) => {
        // 执行正常业务
        console.log('stopServiceExtensionAbility succeed');
      })
      .catch((error) => {
        // 处理业务逻辑错误
842 843
        console.log('stopServiceExtensionAbility failed, error.code: ' + JSON.stringify(error.code) +
          ' error.message: ' + JSON.stringify(error.message));
H
HuangXW 已提交
844 845 846 847 848 849
      });
  } catch (paramError) {
    // 处理入参错误异常
    console.log('error.code: ' + JSON.stringify(paramError.code) +
      ' error.message: ' + JSON.stringify(paramError.message));
  }
850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867
  ```

## AbilityContext.stopServiceExtensionAbilityWithAccount

stopServiceExtensionAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback\<void>): void;

使用帐户停止同一应用程序内的服务(callback形式)。

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

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
M
m00512953 已提交
868
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
869
| accountId | number | 是 | 系统帐号的帐号ID,详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
870 871
| callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 |

H
HuangXW 已提交
872 873 874 875 876
**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 401 | Invalid input parameter. |
D
merge  
donglin 已提交
877
其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md)
H
HuangXW 已提交
878

879 880
**示例:**

881
  ```ts
882
  var want = {
883 884 885
    deviceId: "",
    bundleName: "com.extreme.test",
    abilityName: "MainAbility"
886 887
  };
  var accountId = 100;
H
HuangXW 已提交
888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904

  try {
    this.context.stopServiceExtensionAbilityWithAccount(want, accountId, (error) => {
      if (error.code) {
        // 处理业务逻辑错误
        console.log('stopServiceExtensionAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) +
          ' error.message: ' + JSON.stringify(error.message));
        return;
      }
      // 执行正常业务
      console.log('stopServiceExtensionAbilityWithAccount succeed');
    });
  } catch (paramError) {
    // 处理入参错误异常
    console.log('error.code: ' + JSON.stringify(paramError.code) +
      ' error.message: ' + JSON.stringify(paramError.message));
  }
905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922
  ```

## AbilityContext.stopServiceExtensionAbilityWithAccount

stopServiceExtensionAbilityWithAccount(want: Want, accountId: number): Promise\<void>;

使用帐户停止同一应用程序内的服务(Promise形式)。

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

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
M
m00512953 已提交
923
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
924
| accountId | number | 是 | 系统帐号的帐号ID,详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
925

H
HuangXW 已提交
926 927 928 929 930
**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 401 | Invalid input parameter. |
D
merge  
donglin 已提交
931
其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md)
H
HuangXW 已提交
932

933 934
**示例:**

935
  ```ts
936
  var want = {
937 938 939
    deviceId: "",
    bundleName: "com.extreme.test",
    abilityName: "MainAbility"
940 941
  };
  var accountId = 100;
H
HuangXW 已提交
942 943 944 945 946 947 948 949 950

  try {
    this.context.stopServiceExtensionAbilityWithAccount(want, accountId)
      .then((data) => {
        // 执行正常业务
        console.log('stopServiceExtensionAbilityWithAccount succeed');
      })
      .catch((error) => {
        // 处理业务逻辑错误
951 952
        console.log('stopServiceExtensionAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) +
          ' error.message: ' + JSON.stringify(error.message));
H
HuangXW 已提交
953 954 955 956 957 958
      });
  } catch (paramError) {
    // 处理入参错误异常
    console.log('error.code: ' + JSON.stringify(paramError.code) +
      ' error.message: ' + JSON.stringify(paramError.message));
  }
959
  ```
960

Y
yuyaozhi 已提交
961
## AbilityContext.terminateSelf
962

963
terminateSelf(callback: AsyncCallback&lt;void&gt;): void;
964

965
停止Ability自身(callback形式)。
966

Y
yuyaozhi 已提交
967
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
ahjxliubao2's avatar
ahjxliubao2 已提交
968

Y
yuyaozhi 已提交
969
**参数:**
ahjxliubao2's avatar
ahjxliubao2 已提交
970

G
guyuanzhang 已提交
971 972 973
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数,返回接口调用是否成功的结果。 |
974

H
HuangXW 已提交
975 976 977 978 979
**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 401 | Invalid input parameter. |
D
merge  
donglin 已提交
980
其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md)
H
HuangXW 已提交
981

Y
yuyaozhi 已提交
982 983
**示例:**

984
  ```ts
H
HuangXW 已提交
985 986 987 988 989 990 991 992 993
  this.context.terminateSelf((error) => {
    if (error.code) {
      // 处理业务逻辑错误
      console.log('terminateSelf failed, error.code: ' + JSON.stringify(error.code) +
        ' error.message: ' + JSON.stringify(error.message));
      return;
    }
    // 执行正常业务
    console.log('terminateSelf succeed');
ahjxliubao2's avatar
ahjxliubao2 已提交
994
  });
995 996 997
  ```


Y
yuyaozhi 已提交
998
## AbilityContext.terminateSelf
999

1000
terminateSelf(): Promise&lt;void&gt;;
1001

1002
停止Ability自身(promise形式)。
1003

Y
yuyaozhi 已提交
1004
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
ahjxliubao2's avatar
ahjxliubao2 已提交
1005

Y
yuyaozhi 已提交
1006
**返回值:**
ahjxliubao2's avatar
ahjxliubao2 已提交
1007

G
guyuanzhang 已提交
1008 1009 1010
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | 返回一个Promise,包含接口的结果。 |
1011

H
HuangXW 已提交
1012 1013 1014 1015 1016
**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 401 | Invalid input parameter. |
D
merge  
donglin 已提交
1017
其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md)
H
HuangXW 已提交
1018

Y
yuyaozhi 已提交
1019 1020
**示例:**

1021
  ```ts
H
HuangXW 已提交
1022 1023 1024
  this.context.terminateSelf().then((data) => {
    // 执行正常业务
    console.log('terminateSelf succeed');
ahjxliubao2's avatar
ahjxliubao2 已提交
1025
  }).catch((error) => {
H
HuangXW 已提交
1026 1027 1028
    // 处理业务逻辑错误
    console.log('terminateSelf failed, error.code: ' + JSON.stringify(error.code) +
      ' error.message: ' + JSON.stringify(error.message));
1029 1030 1031 1032
  });
  ```


Y
yuyaozhi 已提交
1033
## AbilityContext.terminateSelfWithResult
1034

1035
terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback&lt;void&gt;): void;
1036

1037
停止Ability,配合startAbilityForResult使用,返回给接口调用方AbilityResult信息(callback形式)。
1038

Y
yuyaozhi 已提交
1039
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
ahjxliubao2's avatar
ahjxliubao2 已提交
1040

Y
yuyaozhi 已提交
1041
**参数:**
ahjxliubao2's avatar
ahjxliubao2 已提交
1042

G
guyuanzhang 已提交
1043 1044
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
M
m00512953 已提交
1045
| parameter | [AbilityResult](js-apis-inner-ability-abilityResult.md) | 是 | 返回给调用startAbilityForResult&nbsp;接口调用方的相关信息。 |
G
guyuanzhang 已提交
1046
| callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回停止结果。 |
1047

1048 1049 1050 1051 1052
**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 401 | Invalid input parameter. |
D
merge  
donglin 已提交
1053
其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md)
1054

Y
yuyaozhi 已提交
1055 1056
**示例:**

1057
  ```ts
1058
  var want = {
1059 1060
    bundleName: "com.extreme.myapplication",
    abilityName: "SecondAbility"
1061 1062 1063 1064 1065 1066 1067
  }
  var resultCode = 100;
  // 返回给接口调用方AbilityResult信息
  var abilityResult = {
    want,
    resultCode
  }
1068 1069 1070 1071 1072 1073 1074 1075

  try {
    this.context.terminateSelfWithResult(abilityResult, (error) => {
      if (error.code) {
        // 处理业务逻辑错误
        console.log('terminateSelfWithResult failed, error.code: ' + JSON.stringify(error.code) +
          ' error.message: ' + JSON.stringify(error.message));
        return;
1076
      }
1077 1078 1079 1080 1081 1082 1083 1084
      // 执行正常业务
      console.log('terminateSelfWithResult succeed');
    });
  } catch (paramError) {
      // 处理入参错误异常
      console.log('error.code: ' + JSON.stringify(paramError.code) +
        ' error.message: ' + JSON.stringify(paramError.message));
  }
1085 1086 1087
  ```


Y
yuyaozhi 已提交
1088
## AbilityContext.terminateSelfWithResult
1089

1090
terminateSelfWithResult(parameter: AbilityResult): Promise&lt;void&gt;;
1091

1092
停止Ability,配合startAbilityForResult使用,返回给接口调用方AbilityResult信息(promise形式)。
1093

Y
yuyaozhi 已提交
1094
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
ahjxliubao2's avatar
ahjxliubao2 已提交
1095

Y
yuyaozhi 已提交
1096
**参数:**
ahjxliubao2's avatar
ahjxliubao2 已提交
1097

G
guyuanzhang 已提交
1098 1099
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
M
m00512953 已提交
1100
| parameter | [AbilityResult](js-apis-inner-ability-abilityResult.md) | 是 | 返回给startAbilityForResult&nbsp;调用方的信息。 |
1101

Y
yuyaozhi 已提交
1102 1103
**返回值:**

G
guyuanzhang 已提交
1104 1105 1106
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | promise形式返回停止结果。 |
1107

1108 1109 1110 1111 1112
**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 401 | Invalid input parameter. |
D
merge  
donglin 已提交
1113
其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md)
1114 1115


Y
yuyaozhi 已提交
1116 1117
**示例:**

1118
  ```ts
1119
  var want = {
1120 1121
    bundleName: "com.extreme.myapplication",
    abilityName: "SecondAbility"
1122 1123 1124 1125 1126 1127 1128
  }
  var resultCode = 100;
  // 返回给接口调用方AbilityResult信息
  var abilityResult = {
    want,
    resultCode
  }
1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144

  try {
    this.context.terminateSelfWithResult(abilityResult)
      .then((data) => {
        // 执行正常业务
        console.log('terminateSelfWithResult succeed');
      })
      .catch((error) => {
        // 处理业务逻辑错误
        console.log('terminateSelfWithResult failed, error.code: ' + JSON.stringify(error.code) +
          ' error.message: ' + JSON.stringify(error.message));
      });
  } catch (paramError) {
    // 处理入参错误异常
    console.log('error.code: ' + JSON.stringify(paramError.code) +
      ' error.message: ' + JSON.stringify(paramError.message));
1145 1146
  }
  ```
ahjxliubao2's avatar
ahjxliubao2 已提交
1147

H
HuangXW 已提交
1148
## AbilityContext.connectServiceExtensionAbility
1149

H
HuangXW 已提交
1150
connectServiceExtensionAbility(want: Want, options: ConnectOptions): number;
1151

1152
使用AbilityInfo.AbilityType.SERVICE模板将当前Ability连接到一个Ability。
1153 1154 1155

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

M
m00512953 已提交
1156 1157
**系统API**: 此接口为系统接口,三方应用不支持调用。

1158 1159 1160 1161
**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
M
m00512953 已提交
1162 1163
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| options | [ConnectOptions](js-apis-inner-ability-connectOptions.md) | 否 | 远端对象实例。 |
1164 1165 1166 1167 1168 1169 1170

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
| number | 返回Ability连接的结果code。 |

H
HuangXW 已提交
1171 1172 1173 1174 1175
**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 401 | Invalid input parameter. |
D
merge  
donglin 已提交
1176
其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md)
H
HuangXW 已提交
1177

1178 1179
**示例:**

1180
  ```ts
1181
  var want = {
1182 1183 1184
    deviceId: "",
    bundleName: "com.extreme.test",
    abilityName: "MainAbility"
1185 1186 1187 1188 1189 1190
  };
  var options = {
    onConnect(elementName, remote) { console.log('----------- onConnect -----------') },
    onDisconnect(elementName) { console.log('----------- onDisconnect -----------') },
    onFailed(code) { console.log('----------- onFailed -----------') }
  }
H
HuangXW 已提交
1191 1192 1193 1194 1195 1196 1197 1198 1199

  var connection = null;
  try {
    connection = this.context.connectServiceExtensionAbility(want, options);
  } catch (paramError) {
    // 处理入参错误异常
    console.log('error.code: ' + JSON.stringify(paramError.code) +
      ' error.message: ' + JSON.stringify(paramError.message));
  }
1200 1201 1202
  ```


H
HuangXW 已提交
1203
## AbilityContext.connectServiceExtensionAbilityWithAccount
1204

H
HuangXW 已提交
1205
connectServiceExtensionAbilityWithAccount(want: Want, accountId: number, options: ConnectOptions): number;
1206

1207
使用AbilityInfo.AbilityType.SERVICE模板和account将当前Ability连接到一个Ability。
1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218

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

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
M
m00512953 已提交
1219
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
1220
| accountId | number | 是 | 系统帐号的帐号ID,详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
M
m00512953 已提交
1221
| options | [ConnectOptions](js-apis-inner-ability-connectOptions.md) | 否 | 远端对象实例。 |
1222 1223 1224 1225 1226 1227 1228

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
| number | 返回Ability连接的结果code。 |

H
HuangXW 已提交
1229 1230 1231 1232 1233
**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 401 | Invalid input parameter. |
D
merge  
donglin 已提交
1234
其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md)
H
HuangXW 已提交
1235

1236 1237
**示例:**

1238
  ```ts
1239
  var want = {
1240 1241 1242
    deviceId: "",
    bundleName: "com.extreme.test",
    abilityName: "MainAbility"
1243 1244 1245 1246 1247 1248 1249
  };
  var accountId = 100;
  var options = {
    onConnect(elementName, remote) { console.log('----------- onConnect -----------') },
    onDisconnect(elementName) { console.log('----------- onDisconnect -----------') },
    onFailed(code) { console.log('----------- onFailed -----------') }
  }
H
HuangXW 已提交
1250 1251 1252 1253 1254 1255 1256 1257 1258

  var connection = null;
  try {
    connection = this.context.connectServiceExtensionAbilityWithAccount(want, accountId, options);
  } catch (paramError) {
    // 处理入参错误异常
    console.log('error.code: ' + JSON.stringify(paramError.code) +
      ' error.message: ' + JSON.stringify(paramError.message));
  }
1259 1260
  ```

H
HuangXW 已提交
1261
## AbilityContext.disconnectServiceExtensionAbility
1262

H
HuangXW 已提交
1263
disconnectServiceExtensionAbility(connection: number): Promise\<void>;
1264

1265
断开连接(promise形式)。
1266 1267 1268

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

M
m00512953 已提交
1269 1270
**系统API**: 此接口为系统接口,三方应用不支持调用。

1271 1272 1273 1274
**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
1275
| connection | number | 是 | 连接的Ability的数字代码。 |
1276 1277 1278 1279 1280 1281 1282

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
| Promise\<void> | 返回执行结果。 |

H
HuangXW 已提交
1283 1284 1285 1286 1287
**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 401 | Invalid input parameter. |
D
merge  
donglin 已提交
1288
其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md)
H
HuangXW 已提交
1289

1290
**示例:**
Z
zhangyafei.echo 已提交
1291

1292
  ```ts
M
m00512953 已提交
1293
  // connection为connectServiceExtensionAbility中的返回值
H
HuangXW 已提交
1294 1295 1296 1297 1298 1299 1300 1301 1302 1303
  var connection = 1;

  try {
    this.context.disconnectServiceExtensionAbility(connection)
      .then((data) => {
        // 执行正常业务
        console.log('disconnectServiceExtensionAbility succeed');
      })
      .catch((error) => {
        // 处理业务逻辑错误
1304 1305
        console.log('disconnectServiceExtensionAbility failed, error.code: ' + JSON.stringify(error.code) +
          ' error.message: ' + JSON.stringify(error.message));
H
HuangXW 已提交
1306 1307 1308 1309 1310 1311
      });
  } catch (paramError) {
    // 处理入参错误异常
    console.log('error.code: ' + JSON.stringify(paramError.code) +
      ' error.message: ' + JSON.stringify(paramError.message));
  }
1312 1313
  ```

H
HuangXW 已提交
1314
## AbilityContext.disconnectServiceExtensionAbility
1315

H
HuangXW 已提交
1316
disconnectServiceExtensionAbility(connection: number, callback:AsyncCallback\<void>): void;
1317

1318
断开连接(callback形式)。
1319 1320 1321

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

M
m00512953 已提交
1322 1323
**系统API**: 此接口为系统接口,三方应用不支持调用。

1324 1325 1326 1327
**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
1328
| connection | number | 是 | 连接的Ability的数字代码。 |
1329 1330
| callback | AsyncCallback\<void> | 是 | 表示指定的回调方法。 |

H
HuangXW 已提交
1331 1332 1333 1334 1335
**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 401 | Invalid input parameter. |
D
merge  
donglin 已提交
1336
其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md)
H
HuangXW 已提交
1337

1338 1339
**示例:**

1340
  ```ts
H
HuangXW 已提交
1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353
  // connection为connectServiceExtensionAbility中的返回值
  var connection = 1;

  try {
    this.context.disconnectServiceExtensionAbility(connection, (error) => {
      if (error.code) {
        // 处理业务逻辑错误
        console.log('disconnectServiceExtensionAbility failed, error.code: ' + JSON.stringify(error.code) +
          ' error.message: ' + JSON.stringify(error.message));
        return;
      }
      // 执行正常业务
      console.log('disconnectServiceExtensionAbility succeed');
1354
    });
H
HuangXW 已提交
1355 1356 1357 1358 1359
  } catch (paramError) {
    // 处理入参错误异常
    console.log('error.code: ' + JSON.stringify(paramError.code) +
      ' error.message: ' + JSON.stringify(paramError.message));
  }
1360
  ```
ahjxliubao2's avatar
ahjxliubao2 已提交
1361

Y
yuyaozhi 已提交
1362
## AbilityContext.startAbilityByCall
ahjxliubao2's avatar
ahjxliubao2 已提交
1363 1364 1365

startAbilityByCall(want: Want): Promise&lt;Caller&gt;;

1366
启动指定Ability至前台或后台,同时获取其Caller通信接口,调用方可使用Caller与被启动的Ability进行通信。
ahjxliubao2's avatar
ahjxliubao2 已提交
1367

Y
yuyaozhi 已提交
1368
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
ahjxliubao2's avatar
ahjxliubao2 已提交
1369

Y
yuyaozhi 已提交
1370
**参数:**
ahjxliubao2's avatar
ahjxliubao2 已提交
1371

G
guyuanzhang 已提交
1372 1373
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
M
m00512953 已提交
1374
| want | [Want](js-apis-application-want.md) | 是 | 传入需要启动的Ability的信息,包含abilityName、moduleName、bundleName、deviceId(可选)、parameters(可选),其中deviceId缺省或为空表示启动本地Ability,parameters缺省或为空表示后台启动Ability。 |
ahjxliubao2's avatar
ahjxliubao2 已提交
1375

Y
yuyaozhi 已提交
1376 1377
**返回值:**

G
guyuanzhang 已提交
1378 1379 1380
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;Caller&gt; | 获取要通讯的caller对象。 |
ahjxliubao2's avatar
ahjxliubao2 已提交
1381

Y
yuyaozhi 已提交
1382
**示例:**
Z
zhangyafei.echo 已提交
1383

1384 1385 1386
  后台启动:

  ```ts
H
HuangXW 已提交
1387
  var caller = undefined;
1388 1389 1390 1391 1392 1393 1394 1395

  // 后台启动Ability,不配置parameters
  var wantBackground = {
      bundleName: "com.example.myservice",
      moduleName: "entry",
      abilityName: "MainAbility",
      deviceId: ""
  };
1396 1397 1398 1399 1400

  try {
    this.context.startAbilityByCall(wantBackground)
      .then((obj) => {
        // 执行正常业务
1401
        caller = obj;
1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418
        console.log('startAbilityByCall succeed');
      }).catch((error) => {
        // 处理业务逻辑错误
        console.log('startAbilityByCall failed, error.code: ' + JSON.stringify(error.code) +
          ' error.message: ' + JSON.stringify(error.message));
      });
  } catch (paramError) {
    // 处理入参错误异常
    console.log('error.code: ' + JSON.stringify(paramError.code) +
      ' error.message: ' + JSON.stringify(paramError.message));
  }
  ```

  前台启动:

  ```ts
  var caller = undefined;
1419 1420 1421 1422 1423 1424 1425 1426 1427

  // 前台启动Ability,将parameters中的"ohos.aafwk.param.callAbilityToForeground"配置为true
  var wantForeground = {
      bundleName: "com.example.myservice",
      moduleName: "entry",
      abilityName: "MainAbility",
      deviceId: "",
      parameters: {
        "ohos.aafwk.param.callAbilityToForeground": true
ahjxliubao2's avatar
ahjxliubao2 已提交
1428
      }
1429
  };
1430 1431 1432 1433 1434

  try {
    this.context.startAbilityByCall(wantForeground)
      .then((obj) => {
        // 执行正常业务
1435
        caller = obj;
1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446
        console.log('startAbilityByCall succeed');
      }).catch((error) => {
        // 处理业务逻辑错误
        console.log('startAbilityByCall failed, error.code: ' + JSON.stringify(error.code) +
          ' error.message: ' + JSON.stringify(error.message));
      });
  } catch (paramError) {
    // 处理入参错误异常
    console.log('error.code: ' + JSON.stringify(paramError.code) +
      ' error.message: ' + JSON.stringify(paramError.message));
  }
ahjxliubao2's avatar
ahjxliubao2 已提交
1447 1448
  ```

1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464
## AbilityContext.startAbilityWithAccount

startAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback\<void\>): void;

根据account启动Ability(callback形式)。

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

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
M
m00512953 已提交
1465
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
1466
| accountId | number | 是 | 系统帐号的帐号ID,详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
1467 1468
| callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 |

H
HuangXW 已提交
1469 1470 1471 1472 1473
**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 401 | Invalid input parameter. |
D
merge  
donglin 已提交
1474
其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md)
H
HuangXW 已提交
1475

1476 1477
**示例:**

1478
  ```ts
1479
  var want = {
1480 1481 1482
    deviceId: "",
    bundleName: "com.extreme.test",
    abilityName: "MainAbility"
1483 1484
  };
  var accountId = 100;
H
HuangXW 已提交
1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501

  try {
    this.context.startAbilityWithAccount(want, accountId, (error) => {
      if (error.code) {
        // 处理业务逻辑错误
        console.log('startAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) +
          ' error.message: ' + JSON.stringify(error.message));
        return;
      }
      // 执行正常业务
      console.log('startAbilityWithAccount succeed');
    });
  } catch (paramError) {
    // 处理入参错误异常
    console.log('error.code: ' + JSON.stringify(paramError.code) +
      ' error.message: ' + JSON.stringify(paramError.message));
  }
1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520
  ```


## AbilityContext.startAbilityWithAccount

startAbilityWithAccount(want: Want, accountId: number, options: StartOptions, callback: AsyncCallback\<void\>): void;

根据account启动Ability(callback形式)。

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

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
M
m00512953 已提交
1521
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
1522
| accountId | number | 是 | 系统帐号的帐号ID,详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。|
M
m00512953 已提交
1523
| options | [StartOptions](js-apis-application-startOptions.md) | 否 | 启动Ability所携带的参数。 |
1524 1525
| callback | AsyncCallback\<void\> | 是 | 启动Ability的回调函数。 |

H
HuangXW 已提交
1526 1527 1528 1529 1530
**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 401 | Invalid input parameter. |
D
merge  
donglin 已提交
1531
其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md)
H
HuangXW 已提交
1532

1533 1534
**示例:**

1535
  ```ts
1536
  var want = {
1537 1538 1539
    deviceId: "",
    bundleName: "com.extreme.test",
    abilityName: "MainAbility"
1540 1541 1542
  };
  var accountId = 100;
  var options = {
H
HuangXW 已提交
1543
    windowMode: 0
1544
  };
H
HuangXW 已提交
1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561

  try {
    this.context.startAbilityWithAccount(want, accountId, options, (error) => {
      if (error.code) {
        // 处理业务逻辑错误
        console.log('startAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) +
          ' error.message: ' + JSON.stringify(error.message));
        return;
      }
      // 执行正常业务
      console.log('startAbilityWithAccount succeed');
    });
  } catch (paramError) {
    // 处理入参错误异常
    console.log('error.code: ' + JSON.stringify(paramError.code) +
      ' error.message: ' + JSON.stringify(paramError.message));
  }
1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580
  ```


## AbilityContext.startAbilityWithAccount

startAbilityWithAccount(want: Want, accountId: number, options?: StartOptions): Promise\<void\>;

根据account启动Ability(Promise形式)。

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

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
M
m00512953 已提交
1581
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
1582
| accountId | number | 是 | 系统帐号的帐号ID,详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess)。 |
M
m00512953 已提交
1583
| options | [StartOptions](js-apis-application-startOptions.md) | 否 | 启动Ability所携带的参数。 |
1584

H
HuangXW 已提交
1585 1586 1587 1588 1589
**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 401 | Invalid input parameter. |
D
merge  
donglin 已提交
1590
其他ID见[元能力子系统错误码](../errorcodes/errorcode-ability.md)
H
HuangXW 已提交
1591

1592 1593
**示例:**

1594
  ```ts
1595
  var want = {
1596 1597 1598
    deviceId: "",
    bundleName: "com.extreme.test",
    abilityName: "MainAbility"
1599 1600 1601
  };
  var accountId = 100;
  var options = {
H
HuangXW 已提交
1602
    windowMode: 0
1603
  };
H
HuangXW 已提交
1604 1605 1606 1607 1608 1609 1610 1611 1612

  try {
    this.context.startAbilityWithAccount(want, accountId, options)
      .then((data) => {
        // 执行正常业务
        console.log('startAbilityWithAccount succeed');
      })
      .catch((error) => {
        // 处理业务逻辑错误
1613 1614
        console.log('startAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) +
          ' error.message: ' + JSON.stringify(error.message));
H
HuangXW 已提交
1615 1616 1617 1618 1619 1620
      });
  } catch (paramError) {
    // 处理入参错误异常
    console.log('error.code: ' + JSON.stringify(paramError.code) +
      ' error.message: ' + JSON.stringify(paramError.message));
  }
1621
  ```
ahjxliubao2's avatar
ahjxliubao2 已提交
1622

Y
yuyaozhi 已提交
1623
## AbilityContext.requestPermissionsFromUser
ahjxliubao2's avatar
ahjxliubao2 已提交
1624 1625 1626

requestPermissionsFromUser(permissions: Array&lt;string&gt;, requestCallback: AsyncCallback&lt;PermissionRequestResult&gt;) : void;

1627
拉起弹窗请求用户授权(callback形式)。
ahjxliubao2's avatar
ahjxliubao2 已提交
1628

Y
yuyaozhi 已提交
1629
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
ahjxliubao2's avatar
ahjxliubao2 已提交
1630

Y
yuyaozhi 已提交
1631
**参数:**
ahjxliubao2's avatar
ahjxliubao2 已提交
1632

G
guyuanzhang 已提交
1633 1634 1635
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| permissions | Array&lt;string&gt; | 是 | 权限列表。 |
M
m00512953 已提交
1636
| callback | AsyncCallback&lt;[PermissionRequestResult](js-apis-inner-application-permissionRequestResult.md)&gt; | 是 | 回调函数,返回接口调用是否成功的结果。 |
ahjxliubao2's avatar
ahjxliubao2 已提交
1637

Y
yuyaozhi 已提交
1638
**示例:**
Z
zhangyafei.echo 已提交
1639

1640
  ```ts
Y
yuyaozhi 已提交
1641 1642 1643
       var permissions=['com.example.permission']
       this.context.requestPermissionsFromUser(permissions,(result) => {
       console.log('requestPermissionsFromUserresult:' + JSON.stringify(result));
ahjxliubao2's avatar
ahjxliubao2 已提交
1644
  });
Z
zhangyafei.echo 已提交
1645

ahjxliubao2's avatar
ahjxliubao2 已提交
1646 1647 1648
  ```


Y
yuyaozhi 已提交
1649
## AbilityContext.requestPermissionsFromUser
ahjxliubao2's avatar
ahjxliubao2 已提交
1650 1651 1652

requestPermissionsFromUser(permissions: Array&lt;string&gt;) : Promise&lt;PermissionRequestResult&gt;;

1653
拉起弹窗请求用户授权(promise形式)。
ahjxliubao2's avatar
ahjxliubao2 已提交
1654

Y
yuyaozhi 已提交
1655
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
ahjxliubao2's avatar
ahjxliubao2 已提交
1656

Y
yuyaozhi 已提交
1657
**参数:**
ahjxliubao2's avatar
ahjxliubao2 已提交
1658

G
guyuanzhang 已提交
1659 1660 1661
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| permissions | Array&lt;string&gt; | 是 | 权限列表。 |
Y
yuyaozhi 已提交
1662 1663

**返回值:**
ahjxliubao2's avatar
ahjxliubao2 已提交
1664

G
guyuanzhang 已提交
1665 1666
| 类型 | 说明 |
| -------- | -------- |
M
m00512953 已提交
1667
| Promise&lt;[PermissionRequestResult](js-apis-inner-application-permissionRequestResult.md)&gt; | 返回一个Promise,包含接口的结果。 |
ahjxliubao2's avatar
ahjxliubao2 已提交
1668

Y
yuyaozhi 已提交
1669
**示例:**
Z
zhangyafei.echo 已提交
1670

1671
  ```ts
Y
yuyaozhi 已提交
1672 1673
   var permissions=['com.example.permission']
       this.context.requestPermissionsFromUser(permissions).then((data) => {
R
RayShih 已提交
1674
      console.log('success:' + JSON.stringify(data));
ahjxliubao2's avatar
ahjxliubao2 已提交
1675
  }).catch((error) => {
R
RayShih 已提交
1676
      console.log('failed:' + JSON.stringify(error));
ahjxliubao2's avatar
ahjxliubao2 已提交
1677
  });
Y
yuyaozhi 已提交
1678

ahjxliubao2's avatar
ahjxliubao2 已提交
1679 1680 1681
  ```


Y
yuyaozhi 已提交
1682
## AbilityContext.setMissionLabel
ahjxliubao2's avatar
ahjxliubao2 已提交
1683 1684 1685

setMissionLabel(label: string, callback:AsyncCallback&lt;void&gt;): void;

1686
设置ability在任务中显示的名称(callback形式)。
ahjxliubao2's avatar
ahjxliubao2 已提交
1687

Y
yuyaozhi 已提交
1688
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
ahjxliubao2's avatar
ahjxliubao2 已提交
1689

Y
yuyaozhi 已提交
1690
**参数:**
ahjxliubao2's avatar
ahjxliubao2 已提交
1691

G
guyuanzhang 已提交
1692 1693 1694 1695
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| label | string | 是 | 显示名称。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数,返回接口调用是否成功的结果。 |
ahjxliubao2's avatar
ahjxliubao2 已提交
1696

Y
yuyaozhi 已提交
1697
**示例:**
Z
zhangyafei.echo 已提交
1698

1699
  ```ts
ahjxliubao2's avatar
ahjxliubao2 已提交
1700
  this.context.setMissionLabel("test",(result) => {
R
RayShih 已提交
1701
      console.log('requestPermissionsFromUserresult:' + JSON.stringify(result));
ahjxliubao2's avatar
ahjxliubao2 已提交
1702 1703 1704 1705
  });
  ```


Y
yuyaozhi 已提交
1706
## AbilityContext.setMissionLabel
ahjxliubao2's avatar
ahjxliubao2 已提交
1707

Y
yuyaozhi 已提交
1708
setMissionLabel(label: string): Promise&lt;void&gt;;
ahjxliubao2's avatar
ahjxliubao2 已提交
1709

1710
设置ability在任务中显示的名称(promise形式)。
ahjxliubao2's avatar
ahjxliubao2 已提交
1711

Y
yuyaozhi 已提交
1712
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
ahjxliubao2's avatar
ahjxliubao2 已提交
1713

Y
yuyaozhi 已提交
1714
**参数:**
ahjxliubao2's avatar
ahjxliubao2 已提交
1715

G
guyuanzhang 已提交
1716 1717 1718
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| label | string | 是 | 显示名称。 |
ahjxliubao2's avatar
ahjxliubao2 已提交
1719

Y
yuyaozhi 已提交
1720 1721
**返回值:**

G
guyuanzhang 已提交
1722 1723 1724
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | 返回一个Promise,包含接口的结果。 |
ahjxliubao2's avatar
ahjxliubao2 已提交
1725

Y
yuyaozhi 已提交
1726
**示例:**
Z
zhangyafei.echo 已提交
1727

1728
  ```ts
F
fangJinliang1 已提交
1729 1730
  this.context.setMissionLabel("test").then(() => {
      console.log('success');
ahjxliubao2's avatar
ahjxliubao2 已提交
1731
  }).catch((error) => {
R
RayShih 已提交
1732
      console.log('failed:' + JSON.stringify(error));
ahjxliubao2's avatar
ahjxliubao2 已提交
1733 1734
  });
  ```
1735 1736 1737 1738
## AbilityContext.setMissionIcon

setMissionIcon(icon: image.PixelMap, callback:AsyncCallback\<void>): void;

1739
设置当前ability在任务中显示的图标(callback形式)。
1740 1741 1742 1743 1744 1745 1746 1747 1748

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
1749
| icon | image.PixelMap | 是 | 在最近的任务中显示的ability图标。 |
1750 1751 1752
| callback | AsyncCallback\<void> | 是 | 指定的回调函数的结果。 |

**示例:**
Z
zhangyafei.echo 已提交
1753

1754
  ```ts
Y
yuyaozhi 已提交
1755
    import image from '@ohos.multimedia.image';
1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780
    var imagePixelMap;
    var color = new ArrayBuffer(0);
    var initializationOptions = {
       size: {
           height: 100,
           width: 100
       }
    };
    image.createPixelMap(color, initializationOptions)
       .then((data) => {
           imagePixelMap = data;
       })
       .catch((err) => {
           console.log('--------- createPixelMap fail, err: ---------', err)
       });
    this.context.setMissionIcon(imagePixelMap, (err) => {
       console.log('---------- setMissionIcon fail, err: -----------', err);
    })
  ```


## AbilityContext.setMissionIcon

setMissionIcon(icon: image.PixelMap): Promise\<void>;

1781
设置当前ability在任务中显示的图标(promise形式)。
1782 1783 1784 1785 1786 1787 1788 1789 1790

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**系统API**: 此接口为系统接口,三方应用不支持调用。

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
1791
| icon | image.PixelMap | 是 | 在最近的任务中显示的ability图标。 |
1792 1793 1794 1795 1796 1797 1798 1799

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | 返回一个Promise,包含接口的结果。 |

**示例:**
Z
zhangyafei.echo 已提交
1800

1801
  ```ts
Y
yuyaozhi 已提交
1802
    import image from '@ohos.multimedia.image';
1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818
    var imagePixelMap;
    var color = new ArrayBuffer(0);
    var initializationOptions = {
      size: {
          height: 100,
          width: 100
      }
    };
    image.createPixelMap(color, initializationOptions)
      .then((data) => {
          imagePixelMap = data;
      })
      .catch((err) => {
          console.log('--------- createPixelMap fail, err: ---------', err)
      });
    this.context.setMissionIcon(imagePixelMap)
F
fangJinliang1 已提交
1819 1820
      .then(() => {
          console.log('-------------- setMissionIcon success -------------');
1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837
      })
      .catch((err) => {
          console.log('-------------- setMissionIcon fail, err: -------------', err);
      });
  ```
## AbilityContext.restoreWindowStage

restoreWindowStage(localStorage: LocalStorage) : void;

恢复ability中的window stage数据。

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
M
m00512953 已提交
1838
| localStorage | image.LocalStorage | 是 | 用于恢复window stage的存储数据。 |
1839 1840 1841

**示例:**

1842
  ```ts
1843 1844 1845
    var storage = new LocalStorage();
    this.context.restoreWindowStage(storage);
  ```
ahjxliubao2's avatar
ahjxliubao2 已提交
1846

G
guyuanzhang 已提交
1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862
## AbilityContext.isTerminating

isTerminating(): boolean;

查询ability是否在terminating状态。

**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
| bool | true:ability当前处于terminating状态;false:不处于terminating状态。 |

**示例:**

1863
  ```ts
G
guyuanzhang 已提交
1864 1865 1866
  var isTerminating = this.context.isTerminating();
  console.log('ability state :' + isTerminating);
  ```