js-apis-inner-application-uiAbilityContext.md 79.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

**示例:**

  ```ts
Z
zhangyafei.echo 已提交
64
  let want = {
M
mingxihua 已提交
65 66
    bundleName: 'com.example.myapp',
    abilityName: 'MyAbility'
M
m00512953 已提交
67 68 69 70 71 72 73
  };

  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

**示例:**

  ```ts
Z
zhangyafei.echo 已提交
129
  let want = {
M
mingxihua 已提交
130 131 132
    deviceId: '',
    bundleName: 'com.example.myapplication',
    abilityName: 'EntryAbility'
M
m00512953 已提交
133
  };
Z
zhangyafei.echo 已提交
134
  let options = {
M
m00512953 已提交
135 136 137 138 139 140 141 142
    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

**示例:**

  ```ts
Z
zhangyafei.echo 已提交
203
  let want = {
M
mingxihua 已提交
204 205
    bundleName: 'com.example.myapp',
    abilityName: 'MyAbility'
M
m00512953 已提交
206
  };
Z
zhangyafei.echo 已提交
207
  let 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
mingxihua 已提交
233
启动一个Ability。Ability被启动后,有如下情况(callback形式):
M
mingxihua 已提交
234
 - 正常情况下可通过调用[terminateSelfWithResult](#uiabilitycontextterminateselfwithresult)接口使之终止并且返回结果给调用方。
M
mingxihua 已提交
235
 - 异常情况下比如杀死Ability会返回异常信息给调用方, 异常信息中resultCode为-1。
M
mingxihua 已提交
236
 - 如果被启动的Ability模式是单实例模式, 不同应用多次调用该接口启动这个Ability,当这个Ability调用[terminateSelfWithResult](#uiabilitycontextterminateselfwithresult)接口使之终止时,只将正常结果返回给最后一个调用方, 其它调用方返回异常信息, 异常信息中resultCode为-1。
M
m00512953 已提交
237

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

M
m00512953 已提交
243 244 245 246 247 248 249 250 251 252 253 254 255
**系统能力**: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 已提交
256 257 258 259 260 261 262 263 264 265 266 267 268
| 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 已提交
269 270 271 272

**示例:**

  ```ts
Z
zhangyafei.echo 已提交
273
  let want = {
M
mingxihua 已提交
274 275 276
    deviceId: '',
    bundleName: 'com.example.myapplication',
    abilityName: 'EntryAbility'
M
m00512953 已提交
277 278 279 280 281 282 283
  };

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

Z
zhongjianfei 已提交
297
## UIAbilityContext.startAbilityForResult
M
m00512953 已提交
298 299 300

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

M
mingxihua 已提交
301
启动一个Ability。Ability被启动后,有如下情况(callback形式):
M
mingxihua 已提交
302
 - 正常情况下可通过调用[terminateSelfWithResult](#uiabilitycontextterminateselfwithresult)接口使之终止并且返回结果给调用方。
M
mingxihua 已提交
303
 - 异常情况下比如杀死Ability会返回异常信息给调用方, 异常信息中resultCode为-1。
M
mingxihua 已提交
304
 - 如果被启动的Ability模式是单实例模式, 不同应用多次调用该接口启动这个Ability,当这个Ability调用[terminateSelfWithResult](#uiabilitycontextterminateselfwithresult)接口使之终止时,只将正常结果返回给最后一个调用方, 其它调用方返回异常信息, 异常信息中resultCode为-1。
M
m00512953 已提交
305

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

**系统能力**: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 已提交
325 326 327 328 329 330 331 332 333 334 335 336 337
| 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 已提交
338 339 340 341

**示例:**

  ```ts
Z
zhangyafei.echo 已提交
342
  let want = {
M
mingxihua 已提交
343 344 345
    deviceId: '',
    bundleName: 'com.example.myapplication',
    abilityName: 'EntryAbility'
M
m00512953 已提交
346
  };
Z
zhangyafei.echo 已提交
347
  let options = {
M
m00512953 已提交
348 349 350 351 352 353 354 355
    windowMode: 0,
  };

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


Z
zhongjianfei 已提交
370
## UIAbilityContext.startAbilityForResult
M
m00512953 已提交
371 372 373

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

M
mingxihua 已提交
374
启动一个Ability。Ability被启动后,有如下情况(promise形式):
M
mingxihua 已提交
375
 - 正常情况下可通过调用[terminateSelfWithResult](#uiabilitycontextterminateselfwithresult)接口使之终止并且返回结果给调用方。
M
mingxihua 已提交
376
 - 异常情况下比如杀死Ability会返回异常信息给调用方, 异常信息中resultCode为-1。
M
mingxihua 已提交
377
 - 如果被启动的Ability模式是单实例模式, 不同应用多次调用该接口启动这个Ability,当这个Ability调用[terminateSelfWithResult](#uiabilitycontextterminateselfwithresult)接口使之终止时,只将正常结果返回给最后一个调用方, 其它调用方返回异常信息, 异常信息中resultCode为-1。
M
m00512953 已提交
378

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

M
m00512953 已提交
384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403
**系统能力**: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 已提交
404 405 406 407 408 409 410 411 412 413 414 415 416
| 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 已提交
417 418 419 420

**示例:**

  ```ts
Z
zhangyafei.echo 已提交
421
let want = {
M
mingxihua 已提交
422 423
    bundleName: 'com.example.myapplication',
    abilityName: 'EntryAbility'
424
};
Z
zhangyafei.echo 已提交
425
let options = {
426
    windowMode: 0,
427
};
M
m00512953 已提交
428

429
try {
M
m00512953 已提交
430
    this.context.startAbilityForResult(want, options)
431
        .then((result) => {
M
m00512953 已提交
432
        // 执行正常业务
M
mingxihua 已提交
433
        console.log('startAbilityForResult succeed, result.resultCode = ' + result.resultCode);
434 435
    })
        .catch((error) => {
M
m00512953 已提交
436 437
        // 处理业务逻辑错误
        console.log('startAbilityForResult failed, error.code: ' + JSON.stringify(error.code) +
438 439 440
                    ' error.message: ' + JSON.stringify(error.message));
    });
} catch (paramError) {
M
m00512953 已提交
441
    // 处理入参错误异常
442
    console.log('startAbilityForResult failed, error.code: ' + JSON.stringify(paramError.code) +
443 444
                ' error.message: ' + JSON.stringify(paramError.message));
}
M
m00512953 已提交
445 446
  ```

Z
zhongjianfei 已提交
447
## UIAbilityContext.startAbilityForResultWithAccount
M
m00512953 已提交
448 449 450

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

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

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

D
donglin 已提交
458
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS,当accountId为当前用户时,不需要校验该权限。
M
m00512953 已提交
459 460 461 462 463 464 465 466 467 468

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

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

**参数:**

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

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
476 477 478 479 480 481 482 483 484 485 486 487 488
| 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 已提交
489 490 491 492

**示例:**

  ```ts
Z
zhangyafei.echo 已提交
493
  let want = {
M
mingxihua 已提交
494 495 496
    deviceId: '',
    bundleName: 'com.example.myapplication',
    abilityName: 'EntryAbility'
M
m00512953 已提交
497
  };
Z
zhangyafei.echo 已提交
498
  let accountId = 100;
M
m00512953 已提交
499 500 501 502 503 504

  try {
    this.context.startAbilityForResultWithAccount(want, accountId, (error, result) => {
      if (error.code) {
        // 处理业务逻辑错误
        console.log('startAbilityForResultWithAccount failed, error.code: ' + JSON.stringify(error.code) +
505
        ' error.message: ' + JSON.stringify(error.message));
M
m00512953 已提交
506 507 508
        return;
      }
      // 执行正常业务
M
mingxihua 已提交
509 510
      console.log('startAbilityForResultWithAccount succeed, result.resultCode = ' +
      result.resultCode + ' result.want = ' + JSON.stringify(result.want));
M
m00512953 已提交
511 512 513
    });
  } catch (paramError) {
    // 处理入参错误异常
514
    console.log('startAbilityForResultWithAccount failed, error.code: ' + JSON.stringify(paramError.code) +
515
    ' error.message: ' + JSON.stringify(paramError.message));
M
m00512953 已提交
516 517 518 519
  }
  ```


Z
zhongjianfei 已提交
520
## UIAbilityContext.startAbilityForResultWithAccount
M
m00512953 已提交
521 522 523

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

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

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

D
donglin 已提交
531
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS,当accountId为当前用户时,不需要校验该权限。
M
m00512953 已提交
532 533 534 535 536 537 538 539 540 541

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

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

**参数:**

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

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
550 551 552 553 554 555 556 557 558 559 560 561 562
| 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 已提交
563 564 565 566

**示例:**

  ```ts
Z
zhangyafei.echo 已提交
567
  let want = {
M
mingxihua 已提交
568 569 570
    deviceId: '',
    bundleName: 'com.example.myapplication',
    abilityName: 'EntryAbility'
M
m00512953 已提交
571
  };
Z
zhangyafei.echo 已提交
572 573
  let accountId = 100;
  let options = {
M
m00512953 已提交
574 575 576 577
    windowMode: 0
  };

  try {
578
    this.context.startAbilityForResultWithAccount(want, accountId, options, (error) => {
M
m00512953 已提交
579 580 581
      if (error.code) {
        // 处理业务逻辑错误
        console.log('startAbilityForResultWithAccount failed, error.code: ' + JSON.stringify(error.code) +
582
        ' error.message: ' + JSON.stringify(error.message));
M
m00512953 已提交
583 584 585
        return;
      }
      // 执行正常业务
M
mingxihua 已提交
586
      console.log('startAbilityForResultWithAccount succeed');
M
m00512953 已提交
587 588 589
    });
  } catch (paramError) {
    // 处理入参错误异常
590
    console.log('startAbilityForResultWithAccount failed, error.code: ' + JSON.stringify(paramError.code) +
591
    ' error.message: ' + JSON.stringify(paramError.message));
M
m00512953 已提交
592 593 594 595
  }
  ```


Z
zhongjianfei 已提交
596
## UIAbilityContext.startAbilityForResultWithAccount
M
m00512953 已提交
597 598 599

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

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

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

D
donglin 已提交
607
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS,当accountId为当前用户时,不需要校验该权限。
M
m00512953 已提交
608 609 610 611 612 613 614 615 616 617

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

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

**参数:**

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

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
625
| Promise&lt;[AbilityResult](js-apis-inner-ability-abilityResult.md)&gt; | Ability被销毁时的回调函数,包含AbilityResult参数。 |
M
m00512953 已提交
626 627 628 629 630

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
631 632 633 634 635 636 637 638 639 640 641 642 643
| 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 已提交
644 645 646 647

**示例:**

  ```ts
Z
zhangyafei.echo 已提交
648
  let want = {
M
mingxihua 已提交
649 650 651
    deviceId: '',
    bundleName: 'com.example.myapplication',
    abilityName: 'EntryAbility'
M
m00512953 已提交
652
  };
Z
zhangyafei.echo 已提交
653 654
  let accountId = 100;
  let options = {
M
m00512953 已提交
655 656 657 658 659 660 661
    windowMode: 0
  };

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

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

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

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

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
690 691
| want | [Want](js-apis-application-want.md) | 是 | 启动ServiceExtensionAbility的want信息。 |
| callback | AsyncCallback\<void\> | 是 | 启动ServiceExtensionAbility的回调函数。 |
M
m00512953 已提交
692 693 694 695 696

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
697 698 699 700 701 702 703 704
| 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 已提交
705 706 707 708

**示例:**

  ```ts
Z
zhangyafei.echo 已提交
709
  let want = {
M
mingxihua 已提交
710 711 712
    deviceId: '',
    bundleName: 'com.example.myapplication',
    abilityName: 'ServiceExtensionAbility'
M
m00512953 已提交
713 714 715 716 717 718 719
  };

  try {
    this.context.startServiceExtensionAbility(want, (error) => {
      if (error.code) {
        // 处理业务逻辑错误
        console.log('startServiceExtensionAbility failed, error.code: ' + JSON.stringify(error.code) +
720
        ' error.message: ' + JSON.stringify(error.message));
M
m00512953 已提交
721 722 723 724 725 726 727
        return;
      }
      // 执行正常业务
      console.log('startServiceExtensionAbility succeed');
    });
  } catch (paramError) {
    // 处理入参错误异常
728
    console.log('startServiceExtensionAbility failed, error.code: ' + JSON.stringify(paramError.code) +
729
    ' error.message: ' + JSON.stringify(paramError.message));
M
m00512953 已提交
730 731 732
  }
  ```

Z
zhongjianfei 已提交
733
## UIAbilityContext.startServiceExtensionAbility
M
m00512953 已提交
734 735 736 737 738 739 740 741 742 743 744 745 746

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

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

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

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
747
| want | [Want](js-apis-application-want.md) | 是 | 启动ServiceExtensionAbility的want信息。 |
M
m00512953 已提交
748 749 750 751 752

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
753 754 755 756 757 758 759 760
| 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 已提交
761 762 763 764

**示例:**

  ```ts
Z
zhangyafei.echo 已提交
765
  let want = {
M
mingxihua 已提交
766 767 768
    deviceId: '',
    bundleName: 'com.example.myapplication',
    abilityName: 'ServiceExtensionAbility'
M
m00512953 已提交
769 770 771 772
  };

  try {
    this.context.startServiceExtensionAbility(want)
773
      .then(() => {
M
m00512953 已提交
774 775 776 777 778 779
        // 执行正常业务
        console.log('startServiceExtensionAbility succeed');
      })
      .catch((error) => {
        // 处理业务逻辑错误
        console.log('startServiceExtensionAbility failed, error.code: ' + JSON.stringify(error.code) +
780
        ' error.message: ' + JSON.stringify(error.message));
M
m00512953 已提交
781 782 783
      });
  } catch (paramError) {
    // 处理入参错误异常
784
    console.log('startServiceExtensionAbility failed, error.code: ' + JSON.stringify(paramError.code) +
785
    ' error.message: ' + JSON.stringify(paramError.message));
M
m00512953 已提交
786 787 788
  }
  ```

Z
zhongjianfei 已提交
789
## UIAbilityContext.startServiceExtensionAbilityWithAccount
M
m00512953 已提交
790 791 792 793 794

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

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

D
donglin 已提交
795
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS,当accountId为当前用户时,不需要校验该权限。
M
m00512953 已提交
796 797 798 799 800 801 802 803 804

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

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
805
| want | [Want](js-apis-application-want.md) | 是 | 启动ServiceExtensionAbility的want信息。 |
806
| accountId | number | 是 | 系统帐号的帐号ID,详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getCreatedOsAccountsCount)。 |
807
| callback | AsyncCallback\<void\> | 是 | 启动ServiceExtensionAbility的回调函数。 |
M
m00512953 已提交
808 809 810 811 812

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
813 814 815 816 817 818 819 820
| 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 已提交
821 822 823 824

**示例:**

  ```ts
Z
zhangyafei.echo 已提交
825
  let want = {
M
mingxihua 已提交
826 827 828
    deviceId: '',
    bundleName: 'com.example.myapplication',
    abilityName: 'ServiceExtensionAbility'
M
m00512953 已提交
829
  };
Z
zhangyafei.echo 已提交
830
  let accountId = 100;
M
m00512953 已提交
831 832 833 834 835 836

  try {
    this.context.startServiceExtensionAbilityWithAccount(want, accountId, (error) => {
      if (error.code) {
        // 处理业务逻辑错误
        console.log('startServiceExtensionAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) +
837
        ' error.message: ' + JSON.stringify(error.message));
M
m00512953 已提交
838 839 840 841 842 843 844
        return;
      }
      // 执行正常业务
      console.log('startServiceExtensionAbilityWithAccount succeed');
    });
  } catch (paramError) {
    // 处理入参错误异常
845
    console.log('startServiceExtensionAbilityWithAccount failed, error.code: ' + JSON.stringify(paramError.code) +
846
    ' error.message: ' + JSON.stringify(paramError.message));
M
m00512953 已提交
847 848 849
  }
  ```

Z
zhongjianfei 已提交
850
## UIAbilityContext.startServiceExtensionAbilityWithAccount
M
m00512953 已提交
851 852 853 854 855

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

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

D
donglin 已提交
856
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS,当accountId为当前用户时,不需要校验该权限。
M
m00512953 已提交
857 858 859 860 861 862 863 864 865 866

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

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

**参数:**

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

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
873 874 875 876 877 878 879 880
| 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 已提交
881 882 883 884

**示例:**

  ```ts
Z
zhangyafei.echo 已提交
885
  let want = {
M
mingxihua 已提交
886 887 888
    deviceId: '',
    bundleName: 'com.example.myapplication',
    abilityName: 'ServiceExtensionAbility'
M
m00512953 已提交
889
  };
Z
zhangyafei.echo 已提交
890
  let accountId = 100;
M
m00512953 已提交
891 892 893

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

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

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

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

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
923 924
| want | [Want](js-apis-application-want.md) | 是 | 停止ServiceExtensionAbility的want信息。 |
| callback | AsyncCallback\<void\> | 是 | 停止ServiceExtensionAbility的回调函数。 |
M
m00512953 已提交
925 926 927 928 929

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
930 931 932 933 934 935 936
| 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 已提交
937 938 939 940

**示例:**

  ```ts
Z
zhangyafei.echo 已提交
941
  let want = {
M
mingxihua 已提交
942 943 944
    deviceId: '',
    bundleName: 'com.example.myapplication',
    abilityName: 'ServiceExtensionAbility'
M
m00512953 已提交
945 946 947 948 949 950 951
  };

  try {
    this.context.stopServiceExtensionAbility(want, (error) => {
      if (error.code) {
        // 处理业务逻辑错误
        console.log('stopServiceExtensionAbility failed, error.code: ' + JSON.stringify(error.code) +
952
        ' error.message: ' + JSON.stringify(error.message));
M
m00512953 已提交
953 954 955 956 957 958 959
        return;
      }
      // 执行正常业务
      console.log('stopServiceExtensionAbility succeed');
    });
  } catch (paramError) {
    // 处理入参错误异常
960
    console.log('stopServiceExtensionAbility failed, error.code: ' + JSON.stringify(paramError.code) +
961
    ' error.message: ' + JSON.stringify(paramError.message));
M
m00512953 已提交
962 963 964
  }
  ```

Z
zhongjianfei 已提交
965
## UIAbilityContext.stopServiceExtensionAbility
M
m00512953 已提交
966 967 968 969 970 971 972 973 974 975 976 977 978

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

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

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

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
979
| want | [Want](js-apis-application-want.md) | 是 | 停止ServiceExtensionAbility的want信息。 |
M
m00512953 已提交
980 981 982 983 984

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
985 986 987 988 989 990 991
| 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 已提交
992 993 994 995

**示例:**

  ```ts
Z
zhangyafei.echo 已提交
996
  let want = {
M
mingxihua 已提交
997 998 999
    deviceId: '',
    bundleName: 'com.example.myapplication',
    abilityName: 'ServiceExtensionAbility'
M
m00512953 已提交
1000 1001 1002 1003
  };

  try {
    this.context.stopServiceExtensionAbility(want)
Z
zhangyafei.echo 已提交
1004
      .then(() => {
M
m00512953 已提交
1005 1006 1007 1008 1009 1010
        // 执行正常业务
        console.log('stopServiceExtensionAbility succeed');
      })
      .catch((error) => {
        // 处理业务逻辑错误
        console.log('stopServiceExtensionAbility failed, error.code: ' + JSON.stringify(error.code) +
1011
        ' error.message: ' + JSON.stringify(error.message));
M
m00512953 已提交
1012 1013 1014
      });
  } catch (paramError) {
    // 处理入参错误异常
1015
    console.log('stopServiceExtensionAbility failed, error.code: ' + JSON.stringify(paramError.code) +
1016
    ' error.message: ' + JSON.stringify(paramError.message));
M
m00512953 已提交
1017 1018 1019
  }
  ```

Z
zhongjianfei 已提交
1020
## UIAbilityContext.stopServiceExtensionAbilityWithAccount
M
m00512953 已提交
1021 1022 1023

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

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

D
donglin 已提交
1026
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS,当accountId为当前用户时,不需要校验该权限。
M
m00512953 已提交
1027 1028 1029 1030 1031 1032 1033 1034 1035

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

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
1036 1037 1038
| want | [Want](js-apis-application-want.md) | 是 | 停止ServiceExtensionAbility的want信息。 |
| accountId | number | 是 | 系统帐号的帐号ID,详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getCreatedOsAccountsCount)。 |
| callback | AsyncCallback\<void\> | 是 | 停止ServiceExtensionAbility的回调函数。 |
M
m00512953 已提交
1039 1040 1041 1042 1043

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
1044 1045 1046 1047 1048 1049 1050
| 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 已提交
1051 1052 1053 1054

**示例:**

  ```ts
Z
zhangyafei.echo 已提交
1055
  let want = {
M
mingxihua 已提交
1056 1057 1058
    deviceId: '',
    bundleName: 'com.example.myapplication',
    abilityName: 'ServiceExtensionAbility'
M
m00512953 已提交
1059
  };
Z
zhangyafei.echo 已提交
1060
  let accountId = 100;
M
m00512953 已提交
1061 1062 1063 1064 1065 1066

  try {
    this.context.stopServiceExtensionAbilityWithAccount(want, accountId, (error) => {
      if (error.code) {
        // 处理业务逻辑错误
        console.log('stopServiceExtensionAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) +
1067
        ' error.message: ' + JSON.stringify(error.message));
M
m00512953 已提交
1068 1069 1070 1071 1072 1073 1074
        return;
      }
      // 执行正常业务
      console.log('stopServiceExtensionAbilityWithAccount succeed');
    });
  } catch (paramError) {
    // 处理入参错误异常
1075
    console.log('stopServiceExtensionAbilityWithAccount failed, error.code: ' + JSON.stringify(paramError.code) +
1076
    ' error.message: ' + JSON.stringify(paramError.message));
M
m00512953 已提交
1077 1078 1079
  }
  ```

Z
zhongjianfei 已提交
1080
## UIAbilityContext.stopServiceExtensionAbilityWithAccount
M
m00512953 已提交
1081 1082 1083

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

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

D
donglin 已提交
1086
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS,当accountId为当前用户时,不需要校验该权限。
M
m00512953 已提交
1087 1088 1089 1090 1091 1092 1093 1094 1095

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

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
1096 1097
| want | [Want](js-apis-application-want.md) | 是 | 停止ServiceExtensionAbility的want信息。 |
| accountId | number | 是 | 系统帐号的帐号ID,详情参考[getCreatedOsAccountsCount](js-apis-osAccount.md#getCreatedOsAccountsCount)。 |
M
m00512953 已提交
1098 1099 1100 1101 1102

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
1103 1104 1105 1106 1107 1108 1109
| 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 已提交
1110 1111 1112 1113

**示例:**

  ```ts
Z
zhangyafei.echo 已提交
1114
  let want = {
M
mingxihua 已提交
1115 1116 1117
    deviceId: '',
    bundleName: 'com.example.myapplication',
    abilityName: 'ServiceExtensionAbility'
M
m00512953 已提交
1118
  };
Z
zhangyafei.echo 已提交
1119
  let accountId = 100;
M
m00512953 已提交
1120 1121 1122

  try {
    this.context.stopServiceExtensionAbilityWithAccount(want, accountId)
Z
zhangyafei.echo 已提交
1123
      .then(() => {
M
m00512953 已提交
1124 1125 1126 1127 1128 1129
        // 执行正常业务
        console.log('stopServiceExtensionAbilityWithAccount succeed');
      })
      .catch((error) => {
        // 处理业务逻辑错误
        console.log('stopServiceExtensionAbilityWithAccount failed, error.code: ' + JSON.stringify(error.code) +
1130
        ' error.message: ' + JSON.stringify(error.message));
M
m00512953 已提交
1131 1132 1133
      });
  } catch (paramError) {
    // 处理入参错误异常
1134
    console.log('stopServiceExtensionAbilityWithAccount failed, error.code: ' + JSON.stringify(paramError.code) +
1135
    ' error.message: ' + JSON.stringify(paramError.message));
M
m00512953 已提交
1136 1137 1138
  }
  ```

Z
zhongjianfei 已提交
1139
## UIAbilityContext.terminateSelf
M
m00512953 已提交
1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150

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

停止Ability自身(callback形式)。

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
1151
| callback | AsyncCallback&lt;void&gt; | 是 | 停止Ability自身的回调函数。 |
M
m00512953 已提交
1152 1153 1154 1155 1156

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
1157 1158 1159 1160 1161 1162
| 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 已提交
1163 1164 1165 1166

**示例:**

  ```ts
1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182
  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 已提交
1183 1184 1185
  ```


Z
zhongjianfei 已提交
1186
## UIAbilityContext.terminateSelf
M
m00512953 已提交
1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197

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

停止Ability自身(promise形式)。

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

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
1198
| Promise&lt;void&gt; | 停止Ability自身的回调函数。 |
M
m00512953 已提交
1199 1200 1201 1202 1203

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
1204 1205 1206 1207 1208 1209
| 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 已提交
1210 1211 1212 1213

**示例:**

  ```ts
1214 1215 1216 1217 1218 1219 1220 1221 1222
  try {
    this.context.terminateSelf()
      .then(() => {
        // 执行正常业务
        console.log('terminateSelf succeed');
      })
      .catch((error) => {
        // 处理业务逻辑错误
        console.log('terminateSelf failed, error.code: ' + JSON.stringify(error.code) +
1223
        ' error.message: ' + JSON.stringify(error.message));
1224 1225 1226
      });
  } catch (error) {
    // 捕获同步的参数错误
M
m00512953 已提交
1227
    console.log('terminateSelf failed, error.code: ' + JSON.stringify(error.code) +
1228
    ' error.message: ' + JSON.stringify(error.message));
1229
  }
M
m00512953 已提交
1230 1231 1232
  ```


Z
zhongjianfei 已提交
1233
## UIAbilityContext.terminateSelfWithResult
M
m00512953 已提交
1234 1235 1236

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

M
m00512953 已提交
1237
停止当前的Ability。如果该Ability是通过调用[startAbilityForResult](#uiabilitycontextstartabilityforresult)接口被拉起的,调用terminateSelfWithResult接口时会将结果返回给调用者,如果该Ability不是通过调用[startAbilityForResult](#uiabilitycontextstartabilityforresult)接口被拉起的,调用terminateSelfWithResult接口时不会有结果返回给调用者(callback形式)。
M
m00512953 已提交
1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251

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

**参数:**

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

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
1252 1253 1254 1255 1256 1257
| 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 已提交
1258 1259 1260 1261

**示例:**

  ```ts
Z
zhangyafei.echo 已提交
1262
  let want = {
M
mingxihua 已提交
1263 1264 1265
    bundleName: 'com.example.myapplication',
    abilityName: 'EntryAbility'
  };
Z
zhangyafei.echo 已提交
1266
  let resultCode = 100;
M
m00512953 已提交
1267
  // 返回给接口调用方AbilityResult信息
Z
zhangyafei.echo 已提交
1268
  let abilityResult = {
M
m00512953 已提交
1269 1270
    want,
    resultCode
M
mingxihua 已提交
1271
  };
M
m00512953 已提交
1272 1273 1274 1275 1276 1277

  try {
    this.context.terminateSelfWithResult(abilityResult, (error) => {
      if (error.code) {
        // 处理业务逻辑错误
        console.log('terminateSelfWithResult failed, error.code: ' + JSON.stringify(error.code) +
1278
        ' error.message: ' + JSON.stringify(error.message));
M
m00512953 已提交
1279 1280 1281 1282 1283 1284
        return;
      }
      // 执行正常业务
      console.log('terminateSelfWithResult succeed');
    });
  } catch (paramError) {
1285 1286 1287
    // 处理入参错误异常
    console.log('terminateSelfWithResult failed, error.code: ' + JSON.stringify(paramError.code) +
    ' error.message: ' + JSON.stringify(paramError.message));
M
m00512953 已提交
1288 1289 1290 1291
  }
  ```


Z
zhongjianfei 已提交
1292
## UIAbilityContext.terminateSelfWithResult
M
m00512953 已提交
1293 1294 1295

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

M
m00512953 已提交
1296
停止当前的Ability。如果该Ability是通过调用[startAbilityForResult](#uiabilitycontextstartabilityforresult)接口被拉起的,调用terminateSelfWithResult接口时会将结果返回给调用者,如果该Ability不是通过调用[startAbilityForResult](#uiabilitycontextstartabilityforresult)接口被拉起的,调用terminateSelfWithResult接口时不会有结果返回给调用者(promise形式)。
M
m00512953 已提交
1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315

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

**参数:**

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

**返回值:**

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

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
1316 1317 1318 1319 1320 1321
| 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 已提交
1322 1323 1324 1325

**示例:**

  ```ts
Z
zhangyafei.echo 已提交
1326
  let want = {
M
mingxihua 已提交
1327 1328 1329
    bundleName: 'com.example.myapplication',
    abilityName: 'EntryAbility'
  };
Z
zhangyafei.echo 已提交
1330
  let resultCode = 100;
M
m00512953 已提交
1331
  // 返回给接口调用方AbilityResult信息
Z
zhangyafei.echo 已提交
1332
  let abilityResult = {
M
m00512953 已提交
1333 1334
    want,
    resultCode
M
mingxihua 已提交
1335
  };
M
m00512953 已提交
1336 1337 1338

  try {
    this.context.terminateSelfWithResult(abilityResult)
Z
zhangyafei.echo 已提交
1339
      .then(() => {
M
m00512953 已提交
1340 1341 1342 1343 1344 1345
        // 执行正常业务
        console.log('terminateSelfWithResult succeed');
      })
      .catch((error) => {
        // 处理业务逻辑错误
        console.log('terminateSelfWithResult failed, error.code: ' + JSON.stringify(error.code) +
1346
        ' error.message: ' + JSON.stringify(error.message));
M
m00512953 已提交
1347 1348 1349
      });
  } catch (paramError) {
    // 处理入参错误异常
1350
    console.log('terminateSelfWithResult failed, error.code: ' + JSON.stringify(paramError.code) +
1351
    ' error.message: ' + JSON.stringify(paramError.message));
M
m00512953 已提交
1352 1353 1354
  }
  ```

Z
zhongjianfei 已提交
1355
## UIAbilityContext.connectServiceExtensionAbility
M
m00512953 已提交
1356 1357 1358

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

1359
将当前Ability连接到一个使用AbilityInfo.AbilityType.SERVICE模板的Ability。
M
m00512953 已提交
1360 1361 1362 1363 1364 1365 1366

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
1367 1368
| want | [Want](js-apis-application-want.md) | 是 | 连接ServiceExtensionAbility的want信息。 |
| options | [ConnectOptions](js-apis-inner-ability-connectOptions.md) | 是 | 与ServiceExtensionAbility建立连接后回调函数的实例。 |
M
m00512953 已提交
1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379

**返回值:**

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

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
1380 1381 1382 1383
| 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 已提交
1384 1385 1386 1387

**示例:**

  ```ts
Z
zhangyafei.echo 已提交
1388
  let want = {
M
mingxihua 已提交
1389 1390 1391
    deviceId: '',
    bundleName: 'com.example.myapplication',
    abilityName: 'ServiceExtensionAbility'
M
m00512953 已提交
1392
  };
Z
zhangyafei.echo 已提交
1393
  let options = {
1394 1395 1396 1397 1398 1399 1400 1401 1402
    onConnect(elementName, remote) {
      console.log('----------- onConnect -----------')
    },
    onDisconnect(elementName) {
      console.log('----------- onDisconnect -----------')
    },
    onFailed(code) {
      console.log('----------- onFailed -----------')
    }
M
mingxihua 已提交
1403
  };
M
m00512953 已提交
1404

Z
zhangyafei.echo 已提交
1405
  let connection = null;
M
m00512953 已提交
1406 1407 1408 1409 1410
  try {
    connection = this.context.connectServiceExtensionAbility(want, options);
  } catch (paramError) {
    // 处理入参错误异常
    console.log('error.code: ' + JSON.stringify(paramError.code) +
1411
    ' error.message: ' + JSON.stringify(paramError.message));
M
m00512953 已提交
1412 1413 1414 1415
  }
  ```


Z
zhongjianfei 已提交
1416
## UIAbilityContext.connectServiceExtensionAbilityWithAccount
M
m00512953 已提交
1417 1418 1419

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

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

D
donglin 已提交
1422
**需要权限:** ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS,当accountId为当前用户时,不需要校验该权限。
M
m00512953 已提交
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432

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

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

**参数:**

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

**返回值:**

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

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
1446 1447 1448 1449
| 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 已提交
1450 1451 1452 1453

**示例:**

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

Z
zhangyafei.echo 已提交
1472
  let connection = null;
M
m00512953 已提交
1473 1474 1475 1476 1477
  try {
    connection = this.context.connectServiceExtensionAbilityWithAccount(want, accountId, options);
  } catch (paramError) {
    // 处理入参错误异常
    console.log('error.code: ' + JSON.stringify(paramError.code) +
1478
    ' error.message: ' + JSON.stringify(paramError.message));
M
m00512953 已提交
1479 1480 1481
  }
  ```

Z
zhongjianfei 已提交
1482
## UIAbilityContext.disconnectServiceExtensionAbility
M
m00512953 已提交
1483 1484 1485

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

1486
断开与ServiceExtensionAbility的连接(promise形式)。
M
m00512953 已提交
1487 1488 1489 1490 1491 1492 1493

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
1494
| connection | number | 是 | 连接的ServiceExtensionAbility的数字代码,即connectServiceExtensionAbility返回的connectionId。 |
M
m00512953 已提交
1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505

**返回值:**

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

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
1506 1507 1508 1509
| 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 已提交
1510 1511 1512 1513 1514

**示例:**

  ```ts
  // connection为connectServiceExtensionAbility中的返回值
Z
zhangyafei.echo 已提交
1515
  let connection = 1;
M
m00512953 已提交
1516 1517 1518

  try {
    this.context.disconnectServiceExtensionAbility(connection)
Z
zhangyafei.echo 已提交
1519
      .then(() => {
M
m00512953 已提交
1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534
        // 执行正常业务
        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 已提交
1535
## UIAbilityContext.disconnectServiceExtensionAbility
M
m00512953 已提交
1536 1537 1538

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

1539
断开与ServiceExtensionAbility的连接(callback形式)。
M
m00512953 已提交
1540 1541 1542 1543 1544 1545 1546

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
1547
| connection | number | 是 | 连接的ServiceExtensionAbility的数字代码,即connectServiceExtensionAbility返回的connectionId。 |
1548
| callback | AsyncCallback\<void> | 是 | callback形式返回断开连接的结果。 |
M
m00512953 已提交
1549 1550 1551 1552 1553

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
1554 1555 1556 1557
| 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 已提交
1558 1559 1560 1561 1562

**示例:**

  ```ts
  // connection为connectServiceExtensionAbility中的返回值
Z
zhangyafei.echo 已提交
1563
  let connection = 1;
M
m00512953 已提交
1564 1565 1566 1567 1568 1569

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

Z
zhongjianfei 已提交
1583
## UIAbilityContext.startAbilityByCall
M
m00512953 已提交
1584 1585 1586 1587 1588

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

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

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

M
m00512953 已提交
1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| 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 已提交
1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625
**错误码:**

| 错误码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 已提交
1626 1627 1628 1629 1630
**示例:**

  后台启动:

  ```ts
M
mingxihua 已提交
1631
  let caller;
M
m00512953 已提交
1632 1633

  // 后台启动Ability,不配置parameters
Z
zhangyafei.echo 已提交
1634
  let wantBackground = {
M
mingxihua 已提交
1635 1636 1637 1638
    bundleName: 'com.example.myservice',
    moduleName: 'entry',
    abilityName: 'EntryAbility',
    deviceId: ''
M
m00512953 已提交
1639 1640 1641 1642 1643 1644 1645 1646 1647
  };

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

  前台启动:

  ```ts
M
mingxihua 已提交
1662
  let caller;
M
m00512953 已提交
1663

M
mingxihua 已提交
1664
  // 前台启动Ability,将parameters中的'ohos.aafwk.param.callAbilityToForeground'配置为true
Z
zhangyafei.echo 已提交
1665
  let wantForeground = {
M
mingxihua 已提交
1666 1667 1668 1669
    bundleName: 'com.example.myservice',
    moduleName: 'entry',
    abilityName: 'EntryAbility',
    deviceId: '',
1670
    parameters: {
M
mingxihua 已提交
1671
      'ohos.aafwk.param.callAbilityToForeground': true
1672
    }
M
m00512953 已提交
1673 1674 1675 1676 1677 1678 1679 1680 1681
  };

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

Z
zhongjianfei 已提交
1693
## UIAbilityContext.startAbilityWithAccount
M
m00512953 已提交
1694 1695 1696

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

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

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

D
donglin 已提交
1704
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS,当accountId为当前用户时,不需要校验该权限。
M
m00512953 已提交
1705 1706 1707 1708 1709 1710 1711 1712 1713 1714

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

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

**参数:**

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

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734
| 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 已提交
1735 1736 1737 1738

**示例:**

  ```ts
Z
zhangyafei.echo 已提交
1739
  let want = {
M
mingxihua 已提交
1740 1741 1742
    deviceId: '',
    bundleName: 'com.example.myapplication',
    abilityName: 'EntryAbility'
M
m00512953 已提交
1743
  };
Z
zhangyafei.echo 已提交
1744
  let accountId = 100;
M
m00512953 已提交
1745 1746 1747 1748 1749 1750

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


Z
zhongjianfei 已提交
1765
## UIAbilityContext.startAbilityWithAccount
M
m00512953 已提交
1766 1767 1768

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

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

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

D
donglin 已提交
1776
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS,当accountId为当前用户时,不需要校验该权限。
M
m00512953 已提交
1777 1778 1779 1780 1781 1782 1783 1784 1785 1786

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

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

**参数:**

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

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807
| 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 已提交
1808 1809 1810 1811

**示例:**

  ```ts
Z
zhangyafei.echo 已提交
1812
  let want = {
M
mingxihua 已提交
1813 1814 1815
    deviceId: '',
    bundleName: 'com.example.myapplication',
    abilityName: 'EntryAbility'
M
m00512953 已提交
1816
  };
Z
zhangyafei.echo 已提交
1817 1818
  let accountId = 100;
  let options = {
M
m00512953 已提交
1819 1820 1821 1822 1823 1824 1825 1826
    windowMode: 0
  };

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


Z
zhongjianfei 已提交
1841
## UIAbilityContext.startAbilityWithAccount
M
m00512953 已提交
1842 1843 1844

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

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

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

D
donglin 已提交
1852
**需要权限**: ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS,当accountId为当前用户时,不需要校验该权限。
M
m00512953 已提交
1853 1854 1855 1856 1857 1858 1859 1860 1861 1862

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

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

**参数:**

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

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
Z
zhangyafei.echo 已提交
1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882
| 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 已提交
1883 1884 1885 1886

**示例:**

  ```ts
Z
zhangyafei.echo 已提交
1887
  let want = {
M
mingxihua 已提交
1888 1889 1890
    deviceId: '',
    bundleName: 'com.example.myapplication',
    abilityName: 'EntryAbility'
M
m00512953 已提交
1891
  };
Z
zhangyafei.echo 已提交
1892 1893
  let accountId = 100;
  let options = {
M
m00512953 已提交
1894 1895 1896 1897 1898
    windowMode: 0
  };

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

Z
zhongjianfei 已提交
1915
## UIAbilityContext.setMissionLabel
M
m00512953 已提交
1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932

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

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

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

**参数:**

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

**示例:**

  ```ts
M
mingxihua 已提交
1933
  this.context.setMissionLabel('test', (result) => {
1934
    console.log('setMissionLabel:' + JSON.stringify(result));
M
m00512953 已提交
1935 1936 1937
  });
  ```

Z
zhongjianfei 已提交
1938
## UIAbilityContext.setMissionLabel
M
m00512953 已提交
1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957

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

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

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

**参数:**

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

**返回值:**

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

Z
zhangyafei.echo 已提交
1958 1959 1960 1961 1962 1963 1964
**错误码:**

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

M
m00512953 已提交
1965 1966 1967
**示例:**

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

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 已提交
1991 1992 1993 1994 1995 1996 1997
**错误码:**

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

M
m00512953 已提交
1998 1999 2000
**示例:**

  ```ts
2001
  import image from '@ohos.multimedia.image';
Z
zhangyafei.echo 已提交
2002 2003 2004
  let imagePixelMap;
  let color = new ArrayBuffer(0);
  let initializationOptions = {
2005 2006 2007 2008 2009 2010 2011 2012
    size: {
      height: 100,
      width: 100
    }
  };
  image.createPixelMap(color, initializationOptions)
    .then((data) => {
      imagePixelMap = data;
M
m00512953 已提交
2013
    })
2014
    .catch((err) => {
M
mingxihua 已提交
2015
      console.log('--------- createPixelMap fail, err: ---------', err);
2016 2017 2018 2019
    });
  this.context.setMissionIcon(imagePixelMap, (err) => {
    console.log('---------- setMissionIcon fail, err: -----------', err);
  })
M
m00512953 已提交
2020 2021 2022
  ```


Z
zhongjianfei 已提交
2023
## UIAbilityContext.setMissionIcon
M
m00512953 已提交
2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044

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 已提交
2045 2046 2047 2048 2049 2050 2051
**错误码:**

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

M
m00512953 已提交
2052 2053 2054
**示例:**

  ```ts
Z
zhangyafei.echo 已提交
2055 2056 2057
  let imagePixelMap;
  let color = new ArrayBuffer(0);
  let initializationOptions = {
2058 2059 2060 2061 2062 2063 2064 2065 2066 2067
    size: {
      height: 100,
      width: 100
    }
  };
  image.createPixelMap(color, initializationOptions)
    .then((data) => {
      imagePixelMap = data;
    })
    .catch((err) => {
M
mingxihua 已提交
2068
      console.log('--------- createPixelMap fail, err: ---------', err);
2069 2070 2071 2072 2073 2074 2075 2076
    });
  this.context.setMissionIcon(imagePixelMap)
    .then(() => {
      console.log('-------------- setMissionIcon success -------------');
    })
    .catch((err) => {
      console.log('-------------- setMissionIcon fail, err: -------------', err);
    });
M
m00512953 已提交
2077
  ```
Z
zhongjianfei 已提交
2078
## UIAbilityContext.restoreWindowStage
M
m00512953 已提交
2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091

restoreWindowStage(localStorage: LocalStorage) : void;

恢复ability中的window stage数据。

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

**参数:**

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

Z
zhangyafei.echo 已提交
2092 2093 2094 2095 2096 2097 2098
**错误码:**

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

M
m00512953 已提交
2099 2100 2101
**示例:**

  ```ts
Z
zhangyafei.echo 已提交
2102
  let storage = new LocalStorage();
2103
  this.context.restoreWindowStage(storage);
M
m00512953 已提交
2104 2105
  ```

Z
zhongjianfei 已提交
2106
## UIAbilityContext.isTerminating
M
m00512953 已提交
2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119

isTerminating(): boolean;

查询ability是否在terminating状态。

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

**返回值:**

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

Z
zhangyafei.echo 已提交
2120 2121 2122 2123 2124 2125 2126
**错误码:**

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

M
m00512953 已提交
2127 2128 2129
**示例:**

  ```ts
Z
zhangyafei.echo 已提交
2130
  let isTerminating = this.context.isTerminating();
M
m00512953 已提交
2131
  console.log('ability state :' + isTerminating);
2132
  ```
C
caochunlei 已提交
2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159

## UIAbilityContext.requestDialogService

requestDialogService(want: Want, result: AsyncCallback&lt;dialogRequest.RequestResult&gt;): void;

启动一个支持模态弹框的ServiceExtensionAbility。ServiceExtensionAbility被启动后,应用弹出模态弹框,通过调用[setRequestResult](js-apis-app-ability-dialogRequest.md#requestcallbacksetrequestresult)接口返回结果给调用者。

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

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |[Want](js-apis-application-want.md) | 是 | 启动ServiceExtensionAbility的want信息。 |
| result | AsyncCallback&lt;[dialogRequest.RequestResult](js-apis-app-ability-dialogRequest.md)&gt; | 是 | 执行结果回调函数。 |

**示例:**

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

  let want = {
M
mingxihua 已提交
2160 2161 2162
    deviceId: '',
    bundleName: 'com.example.myapplication',
    abilityName: 'AuthAccountServiceExtension'
C
caochunlei 已提交
2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173
  };

  try {
    this.context.requestDialogService(want, (error, result) => {
      if (error && error.code) {
        // 处理业务逻辑错误
        console.log('requestDialogService failed, error.code: ' + JSON.stringify(error.code) +
        ' error.message: ' + JSON.stringify(error.message));
        return;
      }
      // 执行正常业务
M
mingxihua 已提交
2174
      console.log('requestDialogService succeed, result = ' + JSON.stringify(result));
C
caochunlei 已提交
2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214
    });
  } catch (paramError) {
    // 处理入参错误异常
    console.log('requestDialogService failed, error.code: ' + JSON.stringify(paramError.code) +
    ' error.message: ' + JSON.stringify(paramError.message));
  }
  ```

  ## UIAbilityContext.requestDialogService

requestDialogService(want: Want): Promise&lt;dialogRequest.RequestResult&gt;;

启动一个支持模态弹框的ServiceExtensionAbility。ServiceExtensionAbility被启动后,应用弹出模态弹框,通过调用[setRequestResult](js-apis-app-ability-dialogRequest.md#requestcallbacksetrequestresult)接口返回结果给调用者(promise形式)。

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

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

**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want | [Want](js-apis-application-want.md) | 是 | 启动ServiceExtensionAbility的want信息。 |


**返回值:**

| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;[dialogRequest.RequestResult](js-apis-app-ability-dialogRequest.md)&gt; | Promise形式返回执行结果。

**示例:**

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

let want = {
M
mingxihua 已提交
2215 2216
    bundleName: 'com.example.myapplication',
    abilityName: 'AuthAccountServiceExtension'
C
caochunlei 已提交
2217 2218 2219 2220 2221 2222
};

try {
    this.context.requestDialogService(want)
        .then((result) => {
        // 执行正常业务
M
mingxihua 已提交
2223
        console.log('requestDialogService succeed, result = ' + JSON.stringify(result));
C
caochunlei 已提交
2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234
    })
        .catch((error) => {
        // 处理业务逻辑错误
        console.log('requestDialogService failed, error= ' + JSON.stringify(error));
    });
} catch (paramError) {
    // 处理入参错误异常
    console.log('requestDialogService failed, error.code: ' + JSON.stringify(paramError.code) +
                ' error.message: ' + JSON.stringify(paramError.message));
}
  ```