js-apis-inner-application-uiAbilityContext.md 74.9 KB
Newer Older
M
m00512953 已提交
1 2
# UIAbilityContext

3
UIAbilityContext是[UIAbility](js-apis-app-ability-uiAbility.md)的上下文环境,继承自[Context](js-apis-inner-application-context.md),提供UIAbility的相关配置信息以及操作UIAbility和ServiceExtensionAbility的方法,如启动UIAbility,停止当前UIAbilityContext所属的UIAbility,启动、停止、连接、断开连接ServiceExtensionAbility等。
M
m00512953 已提交
4 5 6 7 8 9 10 11 12 13

> **说明:**
>
>  - 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>  - 本模块接口仅可在Stage模型下使用。

## 属性

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

D
merge  
donglin 已提交
14
| 名称 | 类型 | 可读 | 可写 | 说明 |
M
m00512953 已提交
15
| -------- | -------- | -------- | -------- | -------- |
16
| abilityInfo | [AbilityInfo](js-apis-bundleManager-abilityInfo.md) | 是 | 否 | UIAbility的相关信息。 |
zyjhandsome's avatar
zyjhandsome 已提交
17
| currentHapModuleInfo | [HapModuleInfo](js-apis-bundleManager-hapModuleInfo.md) | 是 | 否 | 当前HAP的信息。 |
18 19 20 21
| config | [Configuration](js-apis-app-ability-configuration.md) | 是 | 否 | 与UIAbility相关的配置信息,如语言、颜色模式等。 |

> **关于示例代码的说明:**
> - 本文档中的示例,通过this.context获取UIAbilityContext,this代表的是继承自UIAbility的UIAbility实例,若需要在页面中使用UIAbilityContext的能力,请参照[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)
M
m00512953 已提交
22

Z
zhongjianfei 已提交
23
## UIAbilityContext.startAbility
M
m00512953 已提交
24 25 26 27 28

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

启动Ability(callback形式)。

M
m00512953 已提交
29 30
使用规则:
 - 调用方应用位于后台时,使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限
M
m00512953 已提交
31
 - 跨应用场景下,目标Ability的visible属性若配置为false,调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限
M
m00512953 已提交
32 33
 - 组件启动规则详见:[组件启动规则(Stage模型)](../../application-models/component-startup-rules.md)

M
m00512953 已提交
34 35 36 37 38 39 40
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
41
| callback | AsyncCallback<void> | 是 | callback形式返回启动结果。 |
M
m00512953 已提交
42 43 44 45 46

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
47 48 49 50 51 52 53 54 55 56 57 58 59
| 16000001 | The specified ability does not exist. |
| 16000002 | Incorrect ability type. |
| 16000004 | Can not start invisible component. |
| 16000005 | The specified process does not have the permission. |
| 16000006 | Cross-user operations are not allowed. |
| 16000008 | The crowdtesting application expires. |
| 16000009 | An ability cannot be started or stopped in Wukong mode. |
| 16000010 | The call with the continuation flag is forbidden. |
| 16000011 | The context does not exist. |
| 16000050 | Internal error. |
| 16000053 | The ability is not on the top of the UI. |
| 16000055 | Installation-free timed out. |
| 16200001 | The caller has been released. |
M
m00512953 已提交
60 61 62 63 64 65 66 67 68 69 70 71 72 73

**示例:**

  ```ts
  var want = {
    bundleName: "com.example.myapp",
    abilityName: "MyAbility"
  };

  try {
    this.context.startAbility(want, (error) => {
      if (error.code) {
        // 处理业务逻辑错误
        console.log('startAbility failed, error.code: ' + JSON.stringify(error.code) +
74
        ' error.message: ' + JSON.stringify(error.message));
M
m00512953 已提交
75 76 77 78 79 80 81
        return;
      }
      // 执行正常业务
      console.log('startAbility succeed');
    });
  } catch (paramError) {
    // 处理入参错误异常
82 83
    console.log('startAbility failed, error.code: ' + JSON.stringify(paramError.code) +
    ' error.message: ' + JSON.stringify(paramError.message));
M
m00512953 已提交
84 85 86
  }
  ```

Z
zhongjianfei 已提交
87
## UIAbilityContext.startAbility
M
m00512953 已提交
88 89 90 91 92

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

启动Ability(callback形式)。

M
m00512953 已提交
93 94
使用规则:
 - 调用方应用位于后台时,使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限
M
m00512953 已提交
95
 - 跨应用场景下,目标Ability的visible属性若配置为false,调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限
M
m00512953 已提交
96 97
 - 组件启动规则详见:[组件启动规则(Stage模型)](../../application-models/component-startup-rules.md)

M
m00512953 已提交
98 99 100 101 102 103 104 105 106 107 108 109
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-want.md)  | 是 | 启动Ability的want信息。 |
| options | [StartOptions](js-apis-app-ability-startOptions.md) | 是 | 启动Ability所携带的参数。 |
| callback | AsyncCallback<void> | 是 | callback形式返回启动结果。 |

**错误码:**

Z
zhongjianfei 已提交
110
| 错误码ID | 错误信息 |
M
m00512953 已提交
111
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
112 113 114 115 116 117 118 119 120 121 122 123 124
| 16000001 | The specified ability does not exist. |
| 16000002 | Incorrect ability type. |
| 16000004 | Can not start invisible component. |
| 16000005 | The specified process does not have the permission. |
| 16000006 | Cross-user operations are not allowed. |
| 16000008 | The crowdtesting application expires. |
| 16000009 | An ability cannot be started or stopped in Wukong mode. |
| 16000010 | The call with the continuation flag is forbidden. |
| 16000011 | The context does not exist. |
| 16000050 | Internal error. |
| 16000053 | The ability is not on the top of the UI. |
| 16000055 | Installation-free timed out. |
| 16200001 | The caller has been released. |
M
m00512953 已提交
125 126 127 128 129 130

**示例:**

  ```ts
  var want = {
    deviceId: "",
131
    bundleName: "com.example.myapplication",
132
    abilityName: "EntryAbility"
M
m00512953 已提交
133 134 135 136 137 138 139 140 141 142
  };
  var options = {
    windowMode: 0
  };

  try {
    this.context.startAbility(want, options, (error) => {
      if (error.code) {
        // 处理业务逻辑错误
        console.log('startAbility failed, error.code: ' + JSON.stringify(error.code) +
143
        ' error.message: ' + JSON.stringify(error.message));
M
m00512953 已提交
144 145 146 147 148 149 150
        return;
      }
      // 执行正常业务
      console.log('startAbility succeed');
    });
  } catch (paramError) {
    // 处理入参错误异常
151
    console.log('startAbility failed, error.code: ' + JSON.stringify(paramError.code) +
152
    ' error.message: ' + JSON.stringify(paramError.message));
M
m00512953 已提交
153 154 155
  }
  ```

Z
zhongjianfei 已提交
156
## UIAbilityContext.startAbility
M
m00512953 已提交
157 158 159 160 161

startAbility(want: Want, options?: StartOptions): Promise<void>;

启动Ability(promise形式)。

M
m00512953 已提交
162 163
使用规则:
 - 调用方应用位于后台时,使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限
M
m00512953 已提交
164
 - 跨应用场景下,目标Ability的visible属性若配置为false,调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限
M
m00512953 已提交
165 166
 - 组件启动规则详见:[组件启动规则(Stage模型)](../../application-models/component-startup-rules.md)

M
m00512953 已提交
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| options | [StartOptions](js-apis-app-ability-startOptions.md) | 否 | 启动Ability所携带的参数。 |

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
| Promise<void> | Promise形式返回启动结果。 |

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
186 187 188 189 190 191 192 193 194 195 196 197 198
| 16000001 | The specified ability does not exist. |
| 16000002 | Incorrect ability type. |
| 16000004 | Can not start invisible component. |
| 16000005 | The specified process does not have the permission. |
| 16000006 | Cross-user operations are not allowed. |
| 16000008 | The crowdtesting application expires. |
| 16000009 | An ability cannot be started or stopped in Wukong mode. |
| 16000010 | The call with the continuation flag is forbidden. |
| 16000011 | The context does not exist. |
| 16000050 | Internal error. |
| 16000053 | The ability is not on the top of the UI. |
| 16000055 | Installation-free timed out. |
| 16200001 | The caller has been released. |
M
m00512953 已提交
199 200 201 202 203 204 205 206 207

**示例:**

  ```ts
  var want = {
    bundleName: "com.example.myapp",
    abilityName: "MyAbility"
  };
  var options = {
208
    windowMode: 0,
M
m00512953 已提交
209 210 211 212
  };

  try {
    this.context.startAbility(want, options)
213
      .then(() => {
M
m00512953 已提交
214 215 216 217 218 219
        // 执行正常业务
        console.log('startAbility succeed');
      })
      .catch((error) => {
        // 处理业务逻辑错误
        console.log('startAbility failed, error.code: ' + JSON.stringify(error.code) +
220
        ' error.message: ' + JSON.stringify(error.message));
M
m00512953 已提交
221 222 223
      });
  } catch (paramError) {
    // 处理入参错误异常
224
    console.log('startAbility failed, error.code: ' + JSON.stringify(paramError.code) +
225
    ' error.message: ' + JSON.stringify(paramError.message));
M
m00512953 已提交
226 227 228
  }
  ```

Z
zhongjianfei 已提交
229
## UIAbilityContext.startAbilityForResult
M
m00512953 已提交
230 231 232

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

M
m00512953 已提交
233
启动一个Ability。Ability被启动后,正常情况下可通过调用[terminateSelfWithResult](#uiabilitycontextterminateselfwithresult)接口使之终止并且返回结果给调用者。异常情况下比如杀死Ability会返回异常信息给调用者(callback形式)。
M
m00512953 已提交
234

M
m00512953 已提交
235 236
使用规则:
 - 调用方应用位于后台时,使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限
M
m00512953 已提交
237
 - 跨应用场景下,目标Ability的visible属性若配置为false,调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限
M
m00512953 已提交
238 239
 - 组件启动规则详见:[组件启动规则(Stage模型)](../../application-models/component-startup-rules.md)

M
m00512953 已提交
240 241 242 243 244 245 246 247 248 249 250 251 252
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |[Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| callback | AsyncCallback<[AbilityResult](js-apis-inner-ability-abilityResult.md)> | 是 | 执行结果回调函数。 |

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
253 254 255 256 257 258 259 260 261 262 263 264 265
| 16000001 | The specified ability does not exist. |
| 16000002 | Incorrect ability type. |
| 16000004 | Can not start invisible component. |
| 16000005 | The specified process does not have the permission. |
| 16000006 | Cross-user operations are not allowed. |
| 16000008 | The crowdtesting application expires. |
| 16000009 | An ability cannot be started or stopped in Wukong mode. |
| 16000010 | The call with the continuation flag is forbidden. |
| 16000011 | The context does not exist. |
| 16000050 | Internal error. |
| 16000053 | The ability is not on the top of the UI. |
| 16000055 | Installation-free timed out. |
| 16200001 | The caller has been released. |
M
m00512953 已提交
266 267 268 269 270 271

**示例:**

  ```ts
  var want = {
    deviceId: "",
272
    bundleName: "com.example.myapplication",
273
    abilityName: "EntryAbility"
M
m00512953 已提交
274 275 276 277 278 279 280
  };

  try {
    this.context.startAbilityForResult(want, (error, result) => {
      if (error.code) {
        // 处理业务逻辑错误
        console.log('startAbilityForResult failed, error.code: ' + JSON.stringify(error.code) +
281
        ' error.message: ' + JSON.stringify(error.message));
M
m00512953 已提交
282 283 284
        return;
      }
      // 执行正常业务
285
      console.log("startAbilityForResult succeed, result.resultCode = " + result.resultCode)
M
m00512953 已提交
286 287 288
    });
  } catch (paramError) {
    // 处理入参错误异常
289
    console.log('startAbilityForResult failed, error.code: ' + JSON.stringify(paramError.code) +
290
    ' error.message: ' + JSON.stringify(paramError.message));
M
m00512953 已提交
291 292 293
  }
  ```

Z
zhongjianfei 已提交
294
## UIAbilityContext.startAbilityForResult
M
m00512953 已提交
295 296 297

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

M
m00512953 已提交
298
启动一个Ability。Ability被启动后,正常情况下可通过调用[terminateSelfWithResult](#uiabilitycontextterminateselfwithresult)接口使之终止并且返回结果给调用者。异常情况下比如杀死Ability会返回异常信息给调用者(callback形式)。
M
m00512953 已提交
299

M
m00512953 已提交
300 301
使用规则:
 - 调用方应用位于后台时,使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限
M
m00512953 已提交
302
 - 跨应用场景下,目标Ability的visible属性若配置为false,调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限
M
m00512953 已提交
303
 - 组件启动规则详见:[组件启动规则(Stage模型)](../../application-models/component-startup-rules.md)
M
m00512953 已提交
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |[Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| options | [StartOptions](js-apis-app-ability-startOptions.md) | 是 | 启动Ability所携带的参数。 |
| callback | AsyncCallback<[AbilityResult](js-apis-inner-ability-abilityResult.md)> | 是 | 执行结果回调函数。 |

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
319 320 321 322 323 324 325 326 327 328 329 330 331
| 16000001 | The specified ability does not exist. |
| 16000002 | Incorrect ability type. |
| 16000004 | Can not start invisible component. |
| 16000005 | The specified process does not have the permission. |
| 16000006 | Cross-user operations are not allowed. |
| 16000008 | The crowdtesting application expires. |
| 16000009 | An ability cannot be started or stopped in Wukong mode. |
| 16000010 | The call with the continuation flag is forbidden. |
| 16000011 | The context does not exist. |
| 16000050 | Internal error. |
| 16000053 | The ability is not on the top of the UI. |
| 16000055 | Installation-free timed out. |
| 16200001 | The caller has been released. |
M
m00512953 已提交
332 333 334 335 336 337

**示例:**

  ```ts
  var want = {
    deviceId: "",
338
    bundleName: "com.example.myapplication",
339
    abilityName: "EntryAbility"
M
m00512953 已提交
340 341 342 343 344 345 346 347 348 349
  };
  var options = {
    windowMode: 0,
  };

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


Z
zhongjianfei 已提交
364
## UIAbilityContext.startAbilityForResult
M
m00512953 已提交
365 366 367

startAbilityForResult(want: Want, options?: StartOptions): Promise<AbilityResult>;

M
m00512953 已提交
368
启动一个Ability。Ability被启动后,正常情况下可通过调用[terminateSelfWithResult](#uiabilitycontextterminateselfwithresult)接口使之终止并且返回结果给调用者。异常情况下比如杀死Ability会返回异常信息给调用者(promise形式)。
M
m00512953 已提交
369

M
m00512953 已提交
370 371
使用规则:
 - 调用方应用位于后台时,使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限
M
m00512953 已提交
372
 - 跨应用场景下,目标Ability的visible属性若配置为false,调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限
M
m00512953 已提交
373 374
 - 组件启动规则详见:[组件启动规则(Stage模型)](../../application-models/component-startup-rules.md)

M
m00512953 已提交
375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
| options | [StartOptions](js-apis-app-ability-startOptions.md) | 否 | 启动Ability所携带的参数。 |


**返回值:**

| 类型 | 说明 |
| -------- | -------- |
| Promise<[AbilityResult](js-apis-inner-ability-abilityResult.md)> | Promise形式返回执行结果。 |

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
395 396 397 398 399 400 401 402 403 404 405 406 407
| 16000001 | The specified ability does not exist. |
| 16000002 | Incorrect ability type. |
| 16000004 | Can not start invisible component. |
| 16000005 | The specified process does not have the permission. |
| 16000006 | Cross-user operations are not allowed. |
| 16000008 | The crowdtesting application expires. |
| 16000009 | An ability cannot be started or stopped in Wukong mode. |
| 16000010 | The call with the continuation flag is forbidden. |
| 16000011 | The context does not exist. |
| 16000050 | Internal error. |
| 16000053 | The ability is not on the top of the UI. |
| 16000055 | Installation-free timed out. |
| 16200001 | The caller has been released. |
M
m00512953 已提交
408 409 410 411

**示例:**

  ```ts
412
var want = {
413
    bundleName: "com.example.myapplication",
414 415 416
    abilityName: "EntryAbility"
};
var options = {
417
    windowMode: 0,
418
};
M
m00512953 已提交
419

420
try {
M
m00512953 已提交
421
    this.context.startAbilityForResult(want, options)
422
        .then((result) => {
M
m00512953 已提交
423 424
        // 执行正常业务
        console.log("startAbilityForResult succeed, result.resultCode = " + result.resultCode);
425 426
    })
        .catch((error) => {
M
m00512953 已提交
427 428
        // 处理业务逻辑错误
        console.log('startAbilityForResult failed, error.code: ' + JSON.stringify(error.code) +
429 430 431
                    ' error.message: ' + JSON.stringify(error.message));
    });
} catch (paramError) {
M
m00512953 已提交
432
    // 处理入参错误异常
433
    console.log('startAbilityForResult failed, error.code: ' + JSON.stringify(paramError.code) +
434 435
                ' error.message: ' + JSON.stringify(paramError.message));
}
M
m00512953 已提交
436 437
  ```

Z
zhongjianfei 已提交
438
## UIAbilityContext.startAbilityForResultWithAccount
M
m00512953 已提交
439 440 441

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

442
启动一个Ability并在该Ability销毁时返回执行结果(callback形式)。
M
m00512953 已提交
443

M
m00512953 已提交
444 445
使用规则:
 - 调用方应用位于后台时,使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限
M
m00512953 已提交
446
 - 跨应用场景下,目标Ability的visible属性若配置为false,调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限
M
m00512953 已提交
447 448
 - 组件启动规则详见:[组件启动规则(Stage模型)](../../application-models/component-startup-rules.md)

D
donglin 已提交
449
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS,当accountId为当前用户时,不需要校验该权限。
M
m00512953 已提交
450 451 452 453 454 455 456 457 458 459

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

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
460 461
| accountId | number | 是 | 系统帐号的帐号ID,详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getCreatedOsAccountsCount)。 |
| callback | AsyncCallback&lt;[AbilityResult](js-apis-inner-ability-abilityResult.md)&gt; | 是 | 启动Ability的回调函数,返回Ability结果。 |
M
m00512953 已提交
462 463 464 465 466

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
467 468 469 470 471 472 473 474 475 476 477 478 479
| 16000001 | The specified ability does not exist. |
| 16000002 | Incorrect ability type. |
| 16000004 | Can not start invisible component. |
| 16000005 | The specified process does not have the permission. |
| 16000006 | Cross-user operations are not allowed. |
| 16000008 | The crowdtesting application expires. |
| 16000009 | An ability cannot be started or stopped in Wukong mode. |
| 16000010 | The call with the continuation flag is forbidden. |
| 16000011 | The context does not exist. |
| 16000050 | Internal error. |
| 16000053 | The ability is not on the top of the UI. |
| 16000055 | Installation-free timed out. |
| 16200001 | The caller has been released. |
M
m00512953 已提交
480 481 482 483 484 485

**示例:**

  ```ts
  var want = {
    deviceId: "",
486
    bundleName: "com.example.myapplication",
487
    abilityName: "EntryAbility"
M
m00512953 已提交
488 489 490 491 492 493 494 495
  };
  var accountId = 100;

  try {
    this.context.startAbilityForResultWithAccount(want, accountId, (error, result) => {
      if (error.code) {
        // 处理业务逻辑错误
        console.log('startAbilityForResultWithAccount failed, error.code: ' + JSON.stringify(error.code) +
496
        ' error.message: ' + JSON.stringify(error.message));
M
m00512953 已提交
497 498 499 500
        return;
      }
      // 执行正常业务
      console.log("startAbilityForResultWithAccount succeed, result.resultCode = " +
501
      result.resultCode + ' result.want = ' + JSON.stringify(result.want))
M
m00512953 已提交
502 503 504
    });
  } catch (paramError) {
    // 处理入参错误异常
505
    console.log('startAbilityForResultWithAccount failed, error.code: ' + JSON.stringify(paramError.code) +
506
    ' error.message: ' + JSON.stringify(paramError.message));
M
m00512953 已提交
507 508 509 510
  }
  ```


Z
zhongjianfei 已提交
511
## UIAbilityContext.startAbilityForResultWithAccount
M
m00512953 已提交
512 513 514

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

515
启动一个Ability并在该Ability销毁时返回执行结果(callback形式)。
M
m00512953 已提交
516

M
m00512953 已提交
517 518
使用规则:
 - 调用方应用位于后台时,使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限
M
m00512953 已提交
519
 - 跨应用场景下,目标Ability的visible属性若配置为false,调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限
M
m00512953 已提交
520 521
 - 组件启动规则详见:[组件启动规则(Stage模型)](../../application-models/component-startup-rules.md)

D
donglin 已提交
522
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS,当accountId为当前用户时,不需要校验该权限。
M
m00512953 已提交
523 524 525 526 527 528 529 530 531 532

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

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
533
| accountId | number | 是 | 系统帐号的帐号ID,详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getCreatedOsAccountsCount)。 |
M
m00512953 已提交
534
| options | [StartOptions](js-apis-app-ability-startOptions.md) | 是 | 启动Ability所携带的参数。 |
535
| callback | AsyncCallback\<void\> | 是 | 启动Ability后,Ability被销毁时的回调函数。 |
M
m00512953 已提交
536 537 538 539 540

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
541 542 543 544 545 546 547 548 549 550 551 552 553
| 16000001 | The specified ability does not exist. |
| 16000002 | Incorrect ability type. |
| 16000004 | Can not start invisible component. |
| 16000005 | The specified process does not have the permission. |
| 16000006 | Cross-user operations are not allowed. |
| 16000008 | The crowdtesting application expires. |
| 16000009 | An ability cannot be started or stopped in Wukong mode. |
| 16000010 | The call with the continuation flag is forbidden. |
| 16000011 | The context does not exist. |
| 16000050 | Internal error. |
| 16000053 | The ability is not on the top of the UI. |
| 16000055 | Installation-free timed out. |
| 16200001 | The caller has been released. |
M
m00512953 已提交
554 555 556 557 558 559

**示例:**

  ```ts
  var want = {
    deviceId: "",
560
    bundleName: "com.example.myapplication",
561
    abilityName: "EntryAbility"
M
m00512953 已提交
562 563 564 565 566 567 568
  };
  var accountId = 100;
  var options = {
    windowMode: 0
  };

  try {
569
    this.context.startAbilityForResultWithAccount(want, accountId, options, (error) => {
M
m00512953 已提交
570 571 572
      if (error.code) {
        // 处理业务逻辑错误
        console.log('startAbilityForResultWithAccount failed, error.code: ' + JSON.stringify(error.code) +
573
        ' error.message: ' + JSON.stringify(error.message));
M
m00512953 已提交
574 575 576
        return;
      }
      // 执行正常业务
577
      console.log("startAbilityForResultWithAccount succeed")
M
m00512953 已提交
578 579 580
    });
  } catch (paramError) {
    // 处理入参错误异常
581
    console.log('startAbilityForResultWithAccount failed, error.code: ' + JSON.stringify(paramError.code) +
582
    ' error.message: ' + JSON.stringify(paramError.message));
M
m00512953 已提交
583 584 585 586
  }
  ```


Z
zhongjianfei 已提交
587
## UIAbilityContext.startAbilityForResultWithAccount
M
m00512953 已提交
588 589 590

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

591
启动一个Ability并在该Ability销毁时返回执行结果(promise形式)。
M
m00512953 已提交
592

M
m00512953 已提交
593 594
使用规则:
 - 调用方应用位于后台时,使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限
M
m00512953 已提交
595
 - 跨应用场景下,目标Ability的visible属性若配置为false,调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限
M
m00512953 已提交
596 597
 - 组件启动规则详见:[组件启动规则(Stage模型)](../../application-models/component-startup-rules.md)

D
donglin 已提交
598
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS,当accountId为当前用户时,不需要校验该权限。
M
m00512953 已提交
599 600 601 602 603 604 605 606 607 608

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

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

**参数:**

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

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
616
| Promise&lt;[AbilityResult](js-apis-inner-ability-abilityResult.md)&gt; | Ability被销毁时的回调函数,包含AbilityResult参数。 |
M
m00512953 已提交
617 618 619 620 621

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
622 623 624 625 626 627 628 629 630 631 632 633 634
| 16000001 | The specified ability does not exist. |
| 16000002 | Incorrect ability type. |
| 16000004 | Can not start invisible component. |
| 16000005 | The specified process does not have the permission. |
| 16000006 | Cross-user operations are not allowed. |
| 16000008 | The crowdtesting application expires. |
| 16000009 | An ability cannot be started or stopped in Wukong mode. |
| 16000010 | The call with the continuation flag is forbidden. |
| 16000011 | The context does not exist. |
| 16000050 | Internal error. |
| 16000053 | The ability is not on the top of the UI. |
| 16000055 | Installation-free timed out. |
| 16200001 | The caller has been released. |
M
m00512953 已提交
635 636 637 638 639 640

**示例:**

  ```ts
  var want = {
    deviceId: "",
641
    bundleName: "com.example.myapplication",
642
    abilityName: "EntryAbility"
M
m00512953 已提交
643 644 645 646 647 648 649 650 651 652 653
  };
  var accountId = 100;
  var options = {
    windowMode: 0
  };

  try {
    this.context.startAbilityForResultWithAccount(want, accountId, options)
      .then((result) => {
        // 执行正常业务
        console.log("startAbilityForResultWithAccount succeed, result.resultCode = " +
654
        result.resultCode)
M
m00512953 已提交
655 656 657 658
      })
      .catch((error) => {
        // 处理业务逻辑错误
        console.log('startAbilityForResultWithAccount failed, error.code: ' + JSON.stringify(error.code) +
659
        ' error.message: ' + JSON.stringify(error.message));
M
m00512953 已提交
660 661 662
      });
  } catch (paramError) {
    // 处理入参错误异常
663 664
    console.log('startAbilityForResultWithAccount failed, error.code: ' + JSON.stringify(paramError.code) +
    ' error.message: ' + JSON.stringify(paramError.message));
M
m00512953 已提交
665 666
  }
  ```
Z
zhongjianfei 已提交
667
## UIAbilityContext.startServiceExtensionAbility
M
m00512953 已提交
668 669 670 671 672 673 674 675 676 677 678 679 680

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

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

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

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
681 682
| want | [Want](js-apis-application-want.md) | 是 | 启动ServiceExtensionAbility的want信息。 |
| callback | AsyncCallback\<void\> | 是 | 启动ServiceExtensionAbility的回调函数。 |
M
m00512953 已提交
683 684 685 686 687

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
688 689 690 691 692 693 694 695
| 16000001 | The specified ability does not exist. |
| 16000002 | Incorrect ability type. |
| 16000005 | The specified process does not have the permission. |
| 16000006 | Cross-user operations are not allowed. |
| 16000008 | The crowdtesting application expires. |
| 16000011 | The context does not exist. |
| 16000050 | Internal error. |
| 16200001 | The caller has been released. |
M
m00512953 已提交
696 697 698 699 700 701

**示例:**

  ```ts
  var want = {
    deviceId: "",
702 703
    bundleName: "com.example.myapplication",
    abilityName: "ServiceExtensionAbility"
M
m00512953 已提交
704 705 706 707 708 709 710
  };

  try {
    this.context.startServiceExtensionAbility(want, (error) => {
      if (error.code) {
        // 处理业务逻辑错误
        console.log('startServiceExtensionAbility failed, error.code: ' + JSON.stringify(error.code) +
711
        ' error.message: ' + JSON.stringify(error.message));
M
m00512953 已提交
712 713 714 715 716 717 718
        return;
      }
      // 执行正常业务
      console.log('startServiceExtensionAbility succeed');
    });
  } catch (paramError) {
    // 处理入参错误异常
719
    console.log('startServiceExtensionAbility failed, error.code: ' + JSON.stringify(paramError.code) +
720
    ' error.message: ' + JSON.stringify(paramError.message));
M
m00512953 已提交
721 722 723
  }
  ```

Z
zhongjianfei 已提交
724
## UIAbilityContext.startServiceExtensionAbility
M
m00512953 已提交
725 726 727 728 729 730 731 732 733 734 735 736 737

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

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

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

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
738
| want | [Want](js-apis-application-want.md) | 是 | 启动ServiceExtensionAbility的want信息。 |
M
m00512953 已提交
739 740 741 742 743

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
744 745 746 747 748 749 750 751
| 16000001 | The specified ability does not exist. |
| 16000002 | Incorrect ability type. |
| 16000005 | The specified process does not have the permission. |
| 16000006 | Cross-user operations are not allowed. |
| 16000008 | The crowdtesting application expires. |
| 16000011 | The context does not exist. |
| 16000050 | Internal error. |
| 16200001 | The caller has been released. |
M
m00512953 已提交
752 753 754 755 756 757

**示例:**

  ```ts
  var want = {
    deviceId: "",
758 759
    bundleName: "com.example.myapplication",
    abilityName: "ServiceExtensionAbility"
M
m00512953 已提交
760 761 762 763
  };

  try {
    this.context.startServiceExtensionAbility(want)
764
      .then(() => {
M
m00512953 已提交
765 766 767 768 769 770
        // 执行正常业务
        console.log('startServiceExtensionAbility succeed');
      })
      .catch((error) => {
        // 处理业务逻辑错误
        console.log('startServiceExtensionAbility failed, error.code: ' + JSON.stringify(error.code) +
771
        ' error.message: ' + JSON.stringify(error.message));
M
m00512953 已提交
772 773 774
      });
  } catch (paramError) {
    // 处理入参错误异常
775
    console.log('startServiceExtensionAbility failed, error.code: ' + JSON.stringify(paramError.code) +
776
    ' error.message: ' + JSON.stringify(paramError.message));
M
m00512953 已提交
777 778 779
  }
  ```

Z
zhongjianfei 已提交
780
## UIAbilityContext.startServiceExtensionAbilityWithAccount
M
m00512953 已提交
781 782 783 784 785

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

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

D
donglin 已提交
786
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS,当accountId为当前用户时,不需要校验该权限。
M
m00512953 已提交
787 788 789 790 791 792 793 794 795

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

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
796
| want | [Want](js-apis-application-want.md) | 是 | 启动ServiceExtensionAbility的want信息。 |
797
| accountId | number | 是 | 系统帐号的帐号ID,详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getCreatedOsAccountsCount)。 |
798
| callback | AsyncCallback\<void\> | 是 | 启动ServiceExtensionAbility的回调函数。 |
M
m00512953 已提交
799 800 801 802 803

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
804 805 806 807 808 809 810 811
| 16000001 | The specified ability does not exist. |
| 16000002 | Incorrect ability type. |
| 16000005 | The specified process does not have the permission. |
| 16000006 | Cross-user operations are not allowed. |
| 16000008 | The crowdtesting application expires. |
| 16000011 | The context does not exist. |
| 16000050 | Internal error. |
| 16200001 | The caller has been released. |
M
m00512953 已提交
812 813 814 815 816 817

**示例:**

  ```ts
  var want = {
    deviceId: "",
818 819
    bundleName: "com.example.myapplication",
    abilityName: "ServiceExtensionAbility"
M
m00512953 已提交
820 821 822 823 824 825 826 827
  };
  var accountId = 100;

  try {
    this.context.startServiceExtensionAbilityWithAccount(want, accountId, (error) => {
      if (error.code) {
        // 处理业务逻辑错误
        console.log('startServiceExtensionAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) +
828
        ' error.message: ' + JSON.stringify(error.message));
M
m00512953 已提交
829 830 831 832 833 834 835
        return;
      }
      // 执行正常业务
      console.log('startServiceExtensionAbilityWithAccount succeed');
    });
  } catch (paramError) {
    // 处理入参错误异常
836
    console.log('startServiceExtensionAbilityWithAccount failed, error.code: ' + JSON.stringify(paramError.code) +
837
    ' error.message: ' + JSON.stringify(paramError.message));
M
m00512953 已提交
838 839 840
  }
  ```

Z
zhongjianfei 已提交
841
## UIAbilityContext.startServiceExtensionAbilityWithAccount
M
m00512953 已提交
842 843 844 845 846

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

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

D
donglin 已提交
847
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS,当accountId为当前用户时,不需要校验该权限。
M
m00512953 已提交
848 849 850 851 852 853 854 855 856 857

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

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

**参数:**

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

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
864 865 866 867 868 869 870 871
| 16000001 | The specified ability does not exist. |
| 16000002 | Incorrect ability type. |
| 16000005 | The specified process does not have the permission. |
| 16000006 | Cross-user operations are not allowed. |
| 16000008 | The crowdtesting application expires. |
| 16000011 | The context does not exist. |
| 16000050 | Internal error. |
| 16200001 | The caller has been released. |
M
m00512953 已提交
872 873 874 875 876 877

**示例:**

  ```ts
  var want = {
    deviceId: "",
878 879
    bundleName: "com.example.myapplication",
    abilityName: "ServiceExtensionAbility"
M
m00512953 已提交
880 881 882 883 884 885 886 887 888 889 890 891
  };
  var accountId = 100;

  try {
    this.context.startServiceExtensionAbilityWithAccount(want, accountId)
      .then((data) => {
        // 执行正常业务
        console.log('startServiceExtensionAbilityWithAccount succeed');
      })
      .catch((error) => {
        // 处理业务逻辑错误
        console.log('startServiceExtensionAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) +
892
        ' error.message: ' + JSON.stringify(error.message));
M
m00512953 已提交
893 894 895
      });
  } catch (paramError) {
    // 处理入参错误异常
896
    console.log('startServiceExtensionAbilityWithAccount failed, error.code: ' + JSON.stringify(paramError.code) +
897
    ' error.message: ' + JSON.stringify(paramError.message));
M
m00512953 已提交
898 899
  }
  ```
Z
zhongjianfei 已提交
900
## UIAbilityContext.stopServiceExtensionAbility
M
m00512953 已提交
901 902 903 904 905 906 907 908 909 910 911 912 913

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

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

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

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
914 915
| want | [Want](js-apis-application-want.md) | 是 | 停止ServiceExtensionAbility的want信息。 |
| callback | AsyncCallback\<void\> | 是 | 停止ServiceExtensionAbility的回调函数。 |
M
m00512953 已提交
916 917 918 919 920

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
921 922 923 924 925 926 927
| 16000001 | The specified ability does not exist. |
| 16000002 | Incorrect ability type. |
| 16000005 | The specified process does not have the permission. |
| 16000006 | Cross-user operations are not allowed. |
| 16000011 | The context does not exist. |
| 16000050 | Internal error. |
| 16200001 | The caller has been released. |
M
m00512953 已提交
928 929 930 931 932 933

**示例:**

  ```ts
  var want = {
    deviceId: "",
934 935
    bundleName: "com.example.myapplication",
    abilityName: "ServiceExtensionAbility"
M
m00512953 已提交
936 937 938 939 940 941 942
  };

  try {
    this.context.stopServiceExtensionAbility(want, (error) => {
      if (error.code) {
        // 处理业务逻辑错误
        console.log('stopServiceExtensionAbility failed, error.code: ' + JSON.stringify(error.code) +
943
        ' error.message: ' + JSON.stringify(error.message));
M
m00512953 已提交
944 945 946 947 948 949 950
        return;
      }
      // 执行正常业务
      console.log('stopServiceExtensionAbility succeed');
    });
  } catch (paramError) {
    // 处理入参错误异常
951
    console.log('stopServiceExtensionAbility failed, error.code: ' + JSON.stringify(paramError.code) +
952
    ' error.message: ' + JSON.stringify(paramError.message));
M
m00512953 已提交
953 954 955
  }
  ```

Z
zhongjianfei 已提交
956
## UIAbilityContext.stopServiceExtensionAbility
M
m00512953 已提交
957 958 959 960 961 962 963 964 965 966 967 968 969

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

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

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

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
970
| want | [Want](js-apis-application-want.md) | 是 | 停止ServiceExtensionAbility的want信息。 |
M
m00512953 已提交
971 972 973 974 975

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
976 977 978 979 980 981 982
| 16000001 | The specified ability does not exist. |
| 16000002 | Incorrect ability type. |
| 16000005 | The specified process does not have the permission. |
| 16000006 | Cross-user operations are not allowed. |
| 16000011 | The context does not exist. |
| 16000050 | Internal error. |
| 16200001 | The caller has been released. |
M
m00512953 已提交
983 984 985 986 987 988

**示例:**

  ```ts
  var want = {
    deviceId: "",
989 990
    bundleName: "com.example.myapplication",
    abilityName: "ServiceExtensionAbility"
M
m00512953 已提交
991 992 993 994 995 996 997 998 999 1000 1001
  };

  try {
    this.context.stopServiceExtensionAbility(want)
      .then((data) => {
        // 执行正常业务
        console.log('stopServiceExtensionAbility succeed');
      })
      .catch((error) => {
        // 处理业务逻辑错误
        console.log('stopServiceExtensionAbility failed, error.code: ' + JSON.stringify(error.code) +
1002
        ' error.message: ' + JSON.stringify(error.message));
M
m00512953 已提交
1003 1004 1005
      });
  } catch (paramError) {
    // 处理入参错误异常
1006
    console.log('stopServiceExtensionAbility failed, error.code: ' + JSON.stringify(paramError.code) +
1007
    ' error.message: ' + JSON.stringify(paramError.message));
M
m00512953 已提交
1008 1009 1010
  }
  ```

Z
zhongjianfei 已提交
1011
## UIAbilityContext.stopServiceExtensionAbilityWithAccount
M
m00512953 已提交
1012 1013 1014

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

1015
停止同一应用程序内指定账户的服务(callback形式)。
M
m00512953 已提交
1016

D
donglin 已提交
1017
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS,当accountId为当前用户时,不需要校验该权限。
M
m00512953 已提交
1018 1019 1020 1021 1022 1023 1024 1025 1026

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

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
1027 1028 1029
| want | [Want](js-apis-application-want.md) | 是 | 停止ServiceExtensionAbility的want信息。 |
| accountId | number | 是 | 系统帐号的帐号ID,详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getCreatedOsAccountsCount)。 |
| callback | AsyncCallback\<void\> | 是 | 停止ServiceExtensionAbility的回调函数。 |
M
m00512953 已提交
1030 1031 1032 1033 1034

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
1035 1036 1037 1038 1039 1040 1041
| 16000001 | The specified ability does not exist. |
| 16000002 | Incorrect ability type. |
| 16000005 | The specified process does not have the permission. |
| 16000006 | Cross-user operations are not allowed. |
| 16000011 | The context does not exist. |
| 16000050 | Internal error. |
| 16200001 | The caller has been released. |
M
m00512953 已提交
1042 1043 1044 1045 1046 1047

**示例:**

  ```ts
  var want = {
    deviceId: "",
1048 1049
    bundleName: "com.example.myapplication",
    abilityName: "ServiceExtensionAbility"
M
m00512953 已提交
1050 1051 1052 1053 1054 1055 1056 1057
  };
  var accountId = 100;

  try {
    this.context.stopServiceExtensionAbilityWithAccount(want, accountId, (error) => {
      if (error.code) {
        // 处理业务逻辑错误
        console.log('stopServiceExtensionAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) +
1058
        ' error.message: ' + JSON.stringify(error.message));
M
m00512953 已提交
1059 1060 1061 1062 1063 1064 1065
        return;
      }
      // 执行正常业务
      console.log('stopServiceExtensionAbilityWithAccount succeed');
    });
  } catch (paramError) {
    // 处理入参错误异常
1066
    console.log('stopServiceExtensionAbilityWithAccount failed, error.code: ' + JSON.stringify(paramError.code) +
1067
    ' error.message: ' + JSON.stringify(paramError.message));
M
m00512953 已提交
1068 1069 1070
  }
  ```

Z
zhongjianfei 已提交
1071
## UIAbilityContext.stopServiceExtensionAbilityWithAccount
M
m00512953 已提交
1072 1073 1074

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

1075
停止同一应用程序内指定账户的服务(Promise形式)。
M
m00512953 已提交
1076

D
donglin 已提交
1077
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS,当accountId为当前用户时,不需要校验该权限。
M
m00512953 已提交
1078 1079 1080 1081 1082 1083 1084 1085 1086

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

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
1087 1088
| want | [Want](js-apis-application-want.md) | 是 | 停止ServiceExtensionAbility的want信息。 |
| accountId | number | 是 | 系统帐号的帐号ID,详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getCreatedOsAccountsCount)。 |
M
m00512953 已提交
1089 1090 1091 1092 1093

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
1094 1095 1096 1097 1098 1099 1100
| 16000001 | The specified ability does not exist. |
| 16000002 | Incorrect ability type. |
| 16000005 | The specified process does not have the permission. |
| 16000006 | Cross-user operations are not allowed. |
| 16000011 | The context does not exist. |
| 16000050 | Internal error. |
| 16200001 | The caller has been released. |
M
m00512953 已提交
1101 1102 1103 1104 1105 1106

**示例:**

  ```ts
  var want = {
    deviceId: "",
1107 1108
    bundleName: "com.example.myapplication",
    abilityName: "ServiceExtensionAbility"
M
m00512953 已提交
1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120
  };
  var accountId = 100;

  try {
    this.context.stopServiceExtensionAbilityWithAccount(want, accountId)
      .then((data) => {
        // 执行正常业务
        console.log('stopServiceExtensionAbilityWithAccount succeed');
      })
      .catch((error) => {
        // 处理业务逻辑错误
        console.log('stopServiceExtensionAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) +
1121
        ' error.message: ' + JSON.stringify(error.message));
M
m00512953 已提交
1122 1123 1124
      });
  } catch (paramError) {
    // 处理入参错误异常
1125
    console.log('stopServiceExtensionAbilityWithAccount failed, error.code: ' + JSON.stringify(paramError.code) +
1126
    ' error.message: ' + JSON.stringify(paramError.message));
M
m00512953 已提交
1127 1128 1129
  }
  ```

Z
zhongjianfei 已提交
1130
## UIAbilityContext.terminateSelf
M
m00512953 已提交
1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141

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

停止Ability自身(callback形式)。

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
1142
| callback | AsyncCallback&lt;void&gt; | 是 | 停止Ability自身的回调函数。 |
M
m00512953 已提交
1143 1144 1145 1146 1147

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
1148 1149 1150 1151 1152 1153
| 16000001 | The specified ability does not exist. |
| 16000004 | Can not start invisible component. |
| 16000005 | The specified process does not have the permission. |
| 16000009 | An ability cannot be started or stopped in Wukong mode. |
| 16000011 | The context does not exist. |
| 16000050 | Internal error. |
M
m00512953 已提交
1154 1155 1156 1157

**示例:**

  ```ts
1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173
  try {
    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');
    });
  } catch (error) {
    // 捕获同步的参数错误
    console.log('terminateSelf failed, error.code: ' + JSON.stringify(error.code) +
      ' error.message: ' + JSON.stringify(error.message));
  }
M
m00512953 已提交
1174 1175 1176
  ```


Z
zhongjianfei 已提交
1177
## UIAbilityContext.terminateSelf
M
m00512953 已提交
1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188

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

停止Ability自身(promise形式)。

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

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
1189
| Promise&lt;void&gt; | 停止Ability自身的回调函数。 |
M
m00512953 已提交
1190 1191 1192 1193 1194

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
1195 1196 1197 1198 1199 1200
| 16000001 | The specified ability does not exist. |
| 16000004 | Can not start invisible component. |
| 16000005 | The specified process does not have the permission. |
| 16000009 | An ability cannot be started or stopped in Wukong mode. |
| 16000011 | The context does not exist. |
| 16000050 | Internal error. |
M
m00512953 已提交
1201 1202 1203 1204

**示例:**

  ```ts
1205 1206 1207 1208 1209 1210 1211 1212 1213
  try {
    this.context.terminateSelf()
      .then(() => {
        // 执行正常业务
        console.log('terminateSelf succeed');
      })
      .catch((error) => {
        // 处理业务逻辑错误
        console.log('terminateSelf failed, error.code: ' + JSON.stringify(error.code) +
1214
        ' error.message: ' + JSON.stringify(error.message));
1215 1216 1217
      });
  } catch (error) {
    // 捕获同步的参数错误
M
m00512953 已提交
1218
    console.log('terminateSelf failed, error.code: ' + JSON.stringify(error.code) +
1219
    ' error.message: ' + JSON.stringify(error.message));
1220
  }
M
m00512953 已提交
1221 1222 1223
  ```


Z
zhongjianfei 已提交
1224
## UIAbilityContext.terminateSelfWithResult
M
m00512953 已提交
1225 1226 1227

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

M
m00512953 已提交
1228
停止当前的Ability。如果该Ability是通过调用[startAbilityForResult](#uiabilitycontextstartabilityforresult)接口被拉起的,调用terminateSelfWithResult接口时会将结果返回给调用者,如果该Ability不是通过调用[startAbilityForResult](#uiabilitycontextstartabilityforresult)接口被拉起的,调用terminateSelfWithResult接口时不会有结果返回给调用者(callback形式)。
M
m00512953 已提交
1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242

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

**参数:**

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

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
1243 1244 1245 1246 1247 1248
| 16000001 | The specified ability does not exist. |
| 16000004 | Can not start invisible component. |
| 16000005 | The specified process does not have the permission. |
| 16000009 | An ability cannot be started or stopped in Wukong mode. |
| 16000011 | The context does not exist. |
| 16000050 | Internal error. |
M
m00512953 已提交
1249 1250 1251 1252 1253

**示例:**

  ```ts
  var want = {
1254
    bundleName: "com.example.myapplication",
1255
    abilityName: "EntryAbility"
M
m00512953 已提交
1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268
  }
  var resultCode = 100;
  // 返回给接口调用方AbilityResult信息
  var abilityResult = {
    want,
    resultCode
  }

  try {
    this.context.terminateSelfWithResult(abilityResult, (error) => {
      if (error.code) {
        // 处理业务逻辑错误
        console.log('terminateSelfWithResult failed, error.code: ' + JSON.stringify(error.code) +
1269
        ' error.message: ' + JSON.stringify(error.message));
M
m00512953 已提交
1270 1271 1272 1273 1274 1275
        return;
      }
      // 执行正常业务
      console.log('terminateSelfWithResult succeed');
    });
  } catch (paramError) {
1276 1277 1278
    // 处理入参错误异常
    console.log('terminateSelfWithResult failed, error.code: ' + JSON.stringify(paramError.code) +
    ' error.message: ' + JSON.stringify(paramError.message));
M
m00512953 已提交
1279 1280 1281 1282
  }
  ```


Z
zhongjianfei 已提交
1283
## UIAbilityContext.terminateSelfWithResult
M
m00512953 已提交
1284 1285 1286

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

M
m00512953 已提交
1287
停止当前的Ability。如果该Ability是通过调用[startAbilityForResult](#uiabilitycontextstartabilityforresult)接口被拉起的,调用terminateSelfWithResult接口时会将结果返回给调用者,如果该Ability不是通过调用[startAbilityForResult](#uiabilitycontextstartabilityforresult)接口被拉起的,调用terminateSelfWithResult接口时不会有结果返回给调用者(promise形式)。
M
m00512953 已提交
1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| parameter | [AbilityResult](js-apis-inner-ability-abilityResult.md) | 是 | 返回给startAbilityForResult&nbsp;调用方的信息。 |

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | promise形式返回停止结果。 |

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
1307 1308 1309 1310 1311 1312
| 16000001 | The specified ability does not exist. |
| 16000004 | Can not start invisible component. |
| 16000005 | The specified process does not have the permission. |
| 16000009 | An ability cannot be started or stopped in Wukong mode. |
| 16000011 | The context does not exist. |
| 16000050 | Internal error. |
M
m00512953 已提交
1313 1314 1315 1316 1317

**示例:**

  ```ts
  var want = {
1318
    bundleName: "com.example.myapplication",
1319
    abilityName: "EntryAbility"
M
m00512953 已提交
1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336
  }
  var resultCode = 100;
  // 返回给接口调用方AbilityResult信息
  var abilityResult = {
    want,
    resultCode
  }

  try {
    this.context.terminateSelfWithResult(abilityResult)
      .then((data) => {
        // 执行正常业务
        console.log('terminateSelfWithResult succeed');
      })
      .catch((error) => {
        // 处理业务逻辑错误
        console.log('terminateSelfWithResult failed, error.code: ' + JSON.stringify(error.code) +
1337
        ' error.message: ' + JSON.stringify(error.message));
M
m00512953 已提交
1338 1339 1340
      });
  } catch (paramError) {
    // 处理入参错误异常
1341
    console.log('terminateSelfWithResult failed, error.code: ' + JSON.stringify(paramError.code) +
1342
    ' error.message: ' + JSON.stringify(paramError.message));
M
m00512953 已提交
1343 1344 1345
  }
  ```

Z
zhongjianfei 已提交
1346
## UIAbilityContext.connectServiceExtensionAbility
M
m00512953 已提交
1347 1348 1349

connectServiceExtensionAbility(want: Want, options: ConnectOptions): number;

1350
将当前Ability连接到一个使用AbilityInfo.AbilityType.SERVICE模板的Ability。
M
m00512953 已提交
1351 1352 1353 1354 1355 1356 1357 1358 1359

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

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
1360 1361
| want | [Want](js-apis-application-want.md) | 是 | 连接ServiceExtensionAbility的want信息。 |
| options | [ConnectOptions](js-apis-inner-ability-connectOptions.md) | 是 | 与ServiceExtensionAbility建立连接后回调函数的实例。 |
M
m00512953 已提交
1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372

**返回值:**

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

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
1373 1374 1375 1376
| 16000001 | The specified ability does not exist. |
| 16000005 | The specified process does not have the permission. |
| 16000011 | The context does not exist. |
| 16000050 | Internal error. |
M
m00512953 已提交
1377 1378 1379 1380 1381 1382

**示例:**

  ```ts
  var want = {
    deviceId: "",
1383 1384
    bundleName: "com.example.myapplication",
    abilityName: "ServiceExtensionAbility"
M
m00512953 已提交
1385 1386
  };
  var options = {
1387 1388 1389 1390 1391 1392 1393 1394 1395
    onConnect(elementName, remote) {
      console.log('----------- onConnect -----------')
    },
    onDisconnect(elementName) {
      console.log('----------- onDisconnect -----------')
    },
    onFailed(code) {
      console.log('----------- onFailed -----------')
    }
M
m00512953 已提交
1396 1397 1398 1399 1400 1401 1402 1403
  }

  var connection = null;
  try {
    connection = this.context.connectServiceExtensionAbility(want, options);
  } catch (paramError) {
    // 处理入参错误异常
    console.log('error.code: ' + JSON.stringify(paramError.code) +
1404
    ' error.message: ' + JSON.stringify(paramError.message));
M
m00512953 已提交
1405 1406 1407 1408
  }
  ```


Z
zhongjianfei 已提交
1409
## UIAbilityContext.connectServiceExtensionAbilityWithAccount
M
m00512953 已提交
1410 1411 1412

connectServiceExtensionAbilityWithAccount(want: Want, accountId: number, options: ConnectOptions): number;

1413
将当前Ability连接到一个使用AbilityInfo.AbilityType.SERVICE模板的指定account的Ability。
M
m00512953 已提交
1414

D
donglin 已提交
1415
**需要权限:** ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS,当accountId为当前用户时,不需要校验该权限。
M
m00512953 已提交
1416 1417 1418 1419 1420 1421 1422 1423 1424 1425

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

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-want.md) | 是 | 启动Ability的want信息。 |
1426
| accountId | number | 是 | 系统帐号的帐号ID,详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getCreatedOsAccountsCount)。 |
1427
| options | [ConnectOptions](js-apis-inner-ability-connectOptions.md) | 是 | 与ServiceExtensionAbility建立连接后回调函数的实例。。 |
M
m00512953 已提交
1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438

**返回值:**

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

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
1439 1440 1441 1442
| 16000001 | The specified ability does not exist. |
| 16000005 | The specified process does not have the permission. |
| 16000011 | The context does not exist. |
| 16000050 | Internal error. |
M
m00512953 已提交
1443 1444 1445 1446 1447 1448

**示例:**

  ```ts
  var want = {
    deviceId: "",
1449 1450
    bundleName: "com.example.myapplication",
    abilityName: "ServiceExtensionAbility"
M
m00512953 已提交
1451 1452 1453
  };
  var accountId = 100;
  var options = {
1454 1455 1456 1457 1458 1459 1460 1461 1462
    onConnect(elementName, remote) {
      console.log('----------- onConnect -----------')
    },
    onDisconnect(elementName) {
      console.log('----------- onDisconnect -----------')
    },
    onFailed(code) {
      console.log('----------- onFailed -----------')
    }
M
m00512953 已提交
1463 1464 1465 1466 1467 1468 1469 1470
  }

  var connection = null;
  try {
    connection = this.context.connectServiceExtensionAbilityWithAccount(want, accountId, options);
  } catch (paramError) {
    // 处理入参错误异常
    console.log('error.code: ' + JSON.stringify(paramError.code) +
1471
    ' error.message: ' + JSON.stringify(paramError.message));
M
m00512953 已提交
1472 1473 1474
  }
  ```

Z
zhongjianfei 已提交
1475
## UIAbilityContext.disconnectServiceExtensionAbility
M
m00512953 已提交
1476 1477 1478

disconnectServiceExtensionAbility(connection: number): Promise\<void>;

1479
断开与ServiceExtensionAbility的连接(promise形式)。
M
m00512953 已提交
1480 1481 1482 1483 1484 1485 1486

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
1487
| connection | number | 是 | 连接的ServiceExtensionAbility的数字代码,即connectServiceExtensionAbility返回的connectionId。 |
M
m00512953 已提交
1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498

**返回值:**

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

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
1499 1500 1501 1502
| 16000001 | The specified ability does not exist. |
| 16000005 | The specified process does not have the permission. |
| 16000011 | The context does not exist. |
| 16000050 | Internal error. |
M
m00512953 已提交
1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527

**示例:**

  ```ts
  // connection为connectServiceExtensionAbility中的返回值
  var connection = 1;

  try {
    this.context.disconnectServiceExtensionAbility(connection)
      .then((data) => {
        // 执行正常业务
        console.log('disconnectServiceExtensionAbility succeed');
      })
      .catch((error) => {
        // 处理业务逻辑错误
        console.log('disconnectServiceExtensionAbility 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));
  }
  ```

Z
zhongjianfei 已提交
1528
## UIAbilityContext.disconnectServiceExtensionAbility
M
m00512953 已提交
1529 1530 1531

disconnectServiceExtensionAbility(connection: number, callback:AsyncCallback\<void>): void;

1532
断开与ServiceExtensionAbility的连接(callback形式)。
M
m00512953 已提交
1533 1534 1535 1536 1537 1538 1539

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
1540
| connection | number | 是 | 连接的ServiceExtensionAbility的数字代码,即connectServiceExtensionAbility返回的connectionId。 |
1541
| callback | AsyncCallback\<void> | 是 | callback形式返回断开连接的结果。 |
M
m00512953 已提交
1542 1543 1544 1545 1546

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
1547 1548 1549 1550
| 16000001 | The specified ability does not exist. |
| 16000005 | The specified process does not have the permission. |
| 16000011 | The context does not exist. |
| 16000050 | Internal error. |
M
m00512953 已提交
1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562

**示例:**

  ```ts
  // connection为connectServiceExtensionAbility中的返回值
  var connection = 1;

  try {
    this.context.disconnectServiceExtensionAbility(connection, (error) => {
      if (error.code) {
        // 处理业务逻辑错误
        console.log('disconnectServiceExtensionAbility failed, error.code: ' + JSON.stringify(error.code) +
1563
        ' error.message: ' + JSON.stringify(error.message));
M
m00512953 已提交
1564 1565 1566 1567 1568 1569 1570 1571
        return;
      }
      // 执行正常业务
      console.log('disconnectServiceExtensionAbility succeed');
    });
  } catch (paramError) {
    // 处理入参错误异常
    console.log('error.code: ' + JSON.stringify(paramError.code) +
1572
    ' error.message: ' + JSON.stringify(paramError.message));
M
m00512953 已提交
1573 1574 1575
  }
  ```

Z
zhongjianfei 已提交
1576
## UIAbilityContext.startAbilityByCall
M
m00512953 已提交
1577 1578 1579 1580 1581

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

启动指定Ability至前台或后台,同时获取其Caller通信接口,调用方可使用Caller与被启动的Ability进行通信。

M
m00512953 已提交
1582 1583
使用规则:
 - 调用方应用位于后台时,使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限
M
m00512953 已提交
1584 1585
 - 跨应用场景下,目标Ability的visible属性若配置为false,调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限
 - 同设备与跨设备场景下,该接口的使用规则存在差异,详见:[组件启动规则(Stage模型)](../../application-models/component-startup-rules.md)
M
m00512953 已提交
1586

M
m00512953 已提交
1587 1588
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

Z
zhangyafei.echo 已提交
1589 1590
**系统API**: 此接口为系统接口,三方应用不支持调用。

M
m00512953 已提交
1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602
**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-want.md) | 是 | 传入需要启动的Ability的信息,包含abilityName、moduleName、bundleName、deviceId(可选)、parameters(可选),其中deviceId缺省或为空表示启动本地Ability,parameters缺省或为空表示后台启动Ability。 |

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;Caller&gt; | 获取要通讯的caller对象。 |

Z
zhangyafei.echo 已提交
1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620
**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 16000001 | The specified ability does not exist. |
| 16000002 | Incorrect ability type. |
| 16000004 | Can not start invisible component. |
| 16000005 | The specified process does not have the permission. |
| 16000006 | Cross-user operations are not allowed. |
| 16000008 | The crowdtesting application expires. |
| 16000009 | An ability cannot be started or stopped in Wukong mode. |
| 16000010 | The call with the continuation flag is forbidden. |
| 16000011 | The context does not exist. |
| 16000050 | Internal error. |
| 16000053 | The ability is not on the top of the UI. |
| 16000055 | Installation-free timed out. |
| 16200001 | The caller has been released. |

M
m00512953 已提交
1621 1622 1623 1624 1625 1626 1627 1628 1629
**示例:**

  后台启动:

  ```ts
  var caller = undefined;

  // 后台启动Ability,不配置parameters
  var wantBackground = {
1630 1631
    bundleName: "com.example.myservice",
    moduleName: "entry",
1632
    abilityName: "EntryAbility",
1633
    deviceId: ""
M
m00512953 已提交
1634 1635 1636 1637 1638 1639 1640 1641 1642
  };

  try {
    this.context.startAbilityByCall(wantBackground)
      .then((obj) => {
        // 执行正常业务
        caller = obj;
        console.log('startAbilityByCall succeed');
      }).catch((error) => {
1643 1644 1645 1646
      // 处理业务逻辑错误
      console.log('startAbilityByCall failed, error.code: ' + JSON.stringify(error.code) +
      ' error.message: ' + JSON.stringify(error.message));
    });
M
m00512953 已提交
1647 1648 1649
  } catch (paramError) {
    // 处理入参错误异常
    console.log('error.code: ' + JSON.stringify(paramError.code) +
1650
    ' error.message: ' + JSON.stringify(paramError.message));
M
m00512953 已提交
1651 1652 1653 1654 1655 1656 1657 1658 1659 1660
  }
  ```

  前台启动:

  ```ts
  var caller = undefined;

  // 前台启动Ability,将parameters中的"ohos.aafwk.param.callAbilityToForeground"配置为true
  var wantForeground = {
1661 1662
    bundleName: "com.example.myservice",
    moduleName: "entry",
1663
    abilityName: "EntryAbility",
1664 1665 1666 1667
    deviceId: "",
    parameters: {
      "ohos.aafwk.param.callAbilityToForeground": true
    }
M
m00512953 已提交
1668 1669 1670 1671 1672 1673 1674 1675 1676
  };

  try {
    this.context.startAbilityByCall(wantForeground)
      .then((obj) => {
        // 执行正常业务
        caller = obj;
        console.log('startAbilityByCall succeed');
      }).catch((error) => {
1677 1678 1679 1680
      // 处理业务逻辑错误
      console.log('startAbilityByCall failed, error.code: ' + JSON.stringify(error.code) +
      ' error.message: ' + JSON.stringify(error.message));
    });
M
m00512953 已提交
1681 1682 1683
  } catch (paramError) {
    // 处理入参错误异常
    console.log('error.code: ' + JSON.stringify(paramError.code) +
1684
    ' error.message: ' + JSON.stringify(paramError.message));
M
m00512953 已提交
1685 1686 1687
  }
  ```

Z
zhongjianfei 已提交
1688
## UIAbilityContext.startAbilityWithAccount
M
m00512953 已提交
1689 1690 1691

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

1692
根据want和accountId启动Ability(callback形式)。
M
m00512953 已提交
1693

M
m00512953 已提交
1694 1695
使用规则:
 - 调用方应用位于后台时,使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限
M
m00512953 已提交
1696
 - 跨应用场景下,目标Ability的visible属性若配置为false,调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限
M
m00512953 已提交
1697 1698
 - 组件启动规则详见:[组件启动规则(Stage模型)](../../application-models/component-startup-rules.md)

D
donglin 已提交
1699
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS,当accountId为当前用户时,不需要校验该权限。
M
m00512953 已提交
1700 1701 1702 1703 1704 1705 1706 1707 1708 1709

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

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

**参数:**

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

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729
| 16000001 | The specified ability does not exist. |
| 16000002 | Incorrect ability type. |
| 16000004 | Can not start invisible component. |
| 16000005 | The specified process does not have the permission. |
| 16000006 | Cross-user operations are not allowed. |
| 16000008 | The crowdtesting application expires. |
| 16000009 | An ability cannot be started or stopped in Wukong mode. |
| 16000010 | The call with the continuation flag is forbidden. |
| 16000011 | The context does not exist. |
| 16000050 | Internal error. |
| 16000053 | The ability is not on the top of the UI. |
| 16000055 | Installation-free timed out. |
| 16200001 | The caller has been released. |
M
m00512953 已提交
1730 1731 1732 1733 1734 1735

**示例:**

  ```ts
  var want = {
    deviceId: "",
1736
    bundleName: "com.example.myapplication",
1737
    abilityName: "EntryAbility"
M
m00512953 已提交
1738 1739 1740 1741 1742 1743 1744 1745
  };
  var accountId = 100;

  try {
    this.context.startAbilityWithAccount(want, accountId, (error) => {
      if (error.code) {
        // 处理业务逻辑错误
        console.log('startAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) +
1746
        ' error.message: ' + JSON.stringify(error.message));
M
m00512953 已提交
1747 1748 1749 1750 1751 1752 1753 1754
        return;
      }
      // 执行正常业务
      console.log('startAbilityWithAccount succeed');
    });
  } catch (paramError) {
    // 处理入参错误异常
    console.log('error.code: ' + JSON.stringify(paramError.code) +
1755
    ' error.message: ' + JSON.stringify(paramError.message));
M
m00512953 已提交
1756 1757 1758 1759
  }
  ```


Z
zhongjianfei 已提交
1760
## UIAbilityContext.startAbilityWithAccount
M
m00512953 已提交
1761 1762 1763

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

1764
根据want、accountId及startOptions启动Ability(callback形式)。
M
m00512953 已提交
1765

M
m00512953 已提交
1766 1767
使用规则:
 - 调用方应用位于后台时,使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限
M
m00512953 已提交
1768
 - 跨应用场景下,目标Ability的visible属性若配置为false,调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限
M
m00512953 已提交
1769 1770
 - 组件启动规则详见:[组件启动规则(Stage模型)](../../application-models/component-startup-rules.md)

D
donglin 已提交
1771
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS,当accountId为当前用户时,不需要校验该权限。
M
m00512953 已提交
1772 1773 1774 1775 1776 1777 1778 1779 1780 1781

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

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

**参数:**

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

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802
| 16000001 | The specified ability does not exist. |
| 16000002 | Incorrect ability type. |
| 16000004 | Can not start invisible component. |
| 16000005 | The specified process does not have the permission. |
| 16000006 | Cross-user operations are not allowed. |
| 16000008 | The crowdtesting application expires. |
| 16000009 | An ability cannot be started or stopped in Wukong mode. |
| 16000010 | The call with the continuation flag is forbidden. |
| 16000011 | The context does not exist. |
| 16000050 | Internal error. |
| 16000053 | The ability is not on the top of the UI. |
| 16000055 | Installation-free timed out. |
| 16200001 | The caller has been released. |
M
m00512953 已提交
1803 1804 1805 1806 1807 1808

**示例:**

  ```ts
  var want = {
    deviceId: "",
1809
    bundleName: "com.example.myapplication",
1810
    abilityName: "EntryAbility"
M
m00512953 已提交
1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821
  };
  var accountId = 100;
  var options = {
    windowMode: 0
  };

  try {
    this.context.startAbilityWithAccount(want, accountId, options, (error) => {
      if (error.code) {
        // 处理业务逻辑错误
        console.log('startAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) +
1822
        ' error.message: ' + JSON.stringify(error.message));
M
m00512953 已提交
1823 1824 1825 1826 1827 1828 1829
        return;
      }
      // 执行正常业务
      console.log('startAbilityWithAccount succeed');
    });
  } catch (paramError) {
    // 处理入参错误异常
1830
    console.log('startAbilityWithAccount failed, error.code: ' + JSON.stringify(paramError.code) +
1831
    ' error.message: ' + JSON.stringify(paramError.message));
M
m00512953 已提交
1832 1833 1834 1835
  }
  ```


Z
zhongjianfei 已提交
1836
## UIAbilityContext.startAbilityWithAccount
M
m00512953 已提交
1837 1838 1839

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

1840
根据want、accountId和startOptions启动Ability(Promise形式)。
M
m00512953 已提交
1841

M
m00512953 已提交
1842 1843
使用规则:
 - 调用方应用位于后台时,使用该接口启动Ability需申请`ohos.permission.START_ABILITIES_FROM_BACKGROUND`权限
M
m00512953 已提交
1844
 - 跨应用场景下,目标Ability的visible属性若配置为false,调用方应用需申请`ohos.permission.START_INVISIBLE_ABILITY`权限
M
m00512953 已提交
1845 1846
 - 组件启动规则详见:[组件启动规则(Stage模型)](../../application-models/component-startup-rules.md)

D
donglin 已提交
1847
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS,当accountId为当前用户时,不需要校验该权限。
M
m00512953 已提交
1848 1849 1850 1851 1852 1853 1854 1855 1856 1857

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

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

**参数:**

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

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877
| 16000001 | The specified ability does not exist. |
| 16000002 | Incorrect ability type. |
| 16000004 | Can not start invisible component. |
| 16000005 | The specified process does not have the permission. |
| 16000006 | Cross-user operations are not allowed. |
| 16000008 | The crowdtesting application expires. |
| 16000009 | An ability cannot be started or stopped in Wukong mode. |
| 16000010 | The call with the continuation flag is forbidden. |
| 16000011 | The context does not exist. |
| 16000050 | Internal error. |
| 16000053 | The ability is not on the top of the UI. |
| 16000055 | Installation-free timed out. |
| 16200001 | The caller has been released. |
M
m00512953 已提交
1878 1879 1880 1881 1882 1883

**示例:**

  ```ts
  var want = {
    deviceId: "",
1884
    bundleName: "com.example.myapplication",
1885
    abilityName: "EntryAbility"
M
m00512953 已提交
1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900
  };
  var accountId = 100;
  var options = {
    windowMode: 0
  };

  try {
    this.context.startAbilityWithAccount(want, accountId, options)
      .then((data) => {
        // 执行正常业务
        console.log('startAbilityWithAccount succeed');
      })
      .catch((error) => {
        // 处理业务逻辑错误
        console.log('startAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) +
1901
        ' error.message: ' + JSON.stringify(error.message));
M
m00512953 已提交
1902 1903 1904
      });
  } catch (paramError) {
    // 处理入参错误异常
1905
    console.log('startAbilityWithAccount failed, error.code: ' + JSON.stringify(paramError.code) +
1906
    ' error.message: ' + JSON.stringify(paramError.message));
M
m00512953 已提交
1907 1908 1909
  }
  ```

Z
zhongjianfei 已提交
1910
## UIAbilityContext.setMissionLabel
M
m00512953 已提交
1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927

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

设置ability在任务中显示的名称(callback形式)。

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| label | string | 是 | 显示名称。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数,返回接口调用是否成功的结果。 |

**示例:**

  ```ts
1928
  this.context.setMissionLabel("test", (result) => {
1929
    console.log('setMissionLabel:' + JSON.stringify(result));
M
m00512953 已提交
1930 1931 1932
  });
  ```

Z
zhongjianfei 已提交
1933
## UIAbilityContext.setMissionLabel
M
m00512953 已提交
1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952

setMissionLabel(label: string): Promise&lt;void&gt;;

设置ability在任务中显示的名称(promise形式)。

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| label | string | 是 | 显示名称。 |

**返回值:**

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

Z
zhangyafei.echo 已提交
1953 1954 1955 1956 1957 1958 1959
**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 16000011 | The context does not exist. |
| 16000050 | Internal error. |

M
m00512953 已提交
1960 1961 1962 1963
**示例:**

  ```ts
  this.context.setMissionLabel("test").then(() => {
1964
    console.log('success');
M
m00512953 已提交
1965
  }).catch((error) => {
1966
    console.log('failed:' + JSON.stringify(error));
M
m00512953 已提交
1967 1968
  });
  ```
Z
zhongjianfei 已提交
1969
## UIAbilityContext.setMissionIcon
M
m00512953 已提交
1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985

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

设置当前ability在任务中显示的图标(callback形式)。

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

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

**参数:**

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

Z
zhangyafei.echo 已提交
1986 1987 1988 1989 1990 1991 1992
**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 16000011 | The context does not exist. |
| 16000050 | Internal error. |

M
m00512953 已提交
1993 1994 1995
**示例:**

  ```ts
1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007
  import image from '@ohos.multimedia.image';
  var imagePixelMap;
  var color = new ArrayBuffer(0);
  var initializationOptions = {
    size: {
      height: 100,
      width: 100
    }
  };
  image.createPixelMap(color, initializationOptions)
    .then((data) => {
      imagePixelMap = data;
M
m00512953 已提交
2008
    })
2009 2010 2011 2012 2013 2014
    .catch((err) => {
      console.log('--------- createPixelMap fail, err: ---------', err)
    });
  this.context.setMissionIcon(imagePixelMap, (err) => {
    console.log('---------- setMissionIcon fail, err: -----------', err);
  })
M
m00512953 已提交
2015 2016 2017
  ```


Z
zhongjianfei 已提交
2018
## UIAbilityContext.setMissionIcon
M
m00512953 已提交
2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039

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

设置当前ability在任务中显示的图标(promise形式)。

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

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| icon | image.PixelMap | 是 | 在最近的任务中显示的ability图标。 |

**返回值:**

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

Z
zhangyafei.echo 已提交
2040 2041 2042 2043 2044 2045 2046
**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 16000011 | The context does not exist. |
| 16000050 | Internal error. |

M
m00512953 已提交
2047 2048 2049
**示例:**

  ```ts
2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071
  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)
    .then(() => {
      console.log('-------------- setMissionIcon success -------------');
    })
    .catch((err) => {
      console.log('-------------- setMissionIcon fail, err: -------------', err);
    });
M
m00512953 已提交
2072
  ```
Z
zhongjianfei 已提交
2073
## UIAbilityContext.restoreWindowStage
M
m00512953 已提交
2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086

restoreWindowStage(localStorage: LocalStorage) : void;

恢复ability中的window stage数据。

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| localStorage | image.LocalStorage | 是 | 用于恢复window stage的存储数据。 |

Z
zhangyafei.echo 已提交
2087 2088 2089 2090 2091 2092 2093
**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 16000011 | The context does not exist. |
| 16000050 | Internal error. |

M
m00512953 已提交
2094 2095 2096
**示例:**

  ```ts
2097 2098
  var storage = new LocalStorage();
  this.context.restoreWindowStage(storage);
M
m00512953 已提交
2099 2100
  ```

Z
zhongjianfei 已提交
2101
## UIAbilityContext.isTerminating
M
m00512953 已提交
2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114

isTerminating(): boolean;

查询ability是否在terminating状态。

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

**返回值:**

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

Z
zhangyafei.echo 已提交
2115 2116 2117 2118 2119 2120 2121
**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 16000011 | The context does not exist. |
| 16000050 | Internal error. |

M
m00512953 已提交
2122 2123 2124 2125 2126
**示例:**

  ```ts
  var isTerminating = this.context.isTerminating();
  console.log('ability state :' + isTerminating);
2127
  ```