• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# ConnectOptions
2
3在连接指定的后台服务时作为入参用于接收连接过程中的状态变化,如作为[connectServiceExtensionAbility](js-apis-inner-application-serviceExtensionContext.md#serviceextensioncontextconnectserviceextensionability)的入参连接指定的ServiceExtensionAbility。
4
5> **说明:**
6>
7> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
8
9## 导入模块
10
11```ts
12import common from '@ohos.app.ability.common';
13```
14
15**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
16
17| 参数名           | 类型       | 必填   | 说明                        |
18| ------------ | -------- | ---- | ------------------------- |
19| onConnect<sup>7+</sup>    | function | 是    | 建立连接时的回调函数。      |
20| onDisconnect<sup>7+</sup> | function | 是    | 断开连接时的回调函数。           |
21| onFailed<sup>7+</sup>     | function | 是    | 连接失败时的回调函数。 |
22
23**示例:**
24
25  ```ts
26  let want = {
27    bundleName: 'com.example.myapp',
28    abilityName: 'MyAbility'
29  };
30
31  let connectOptions: common.ConnectOptions = {
32    onConnect(elementName, remote) {
33        console.log('onConnect elementName: ' + elementName);
34    },
35    onDisconnect(elementName) {
36        console.log('onDisconnect elementName: ' + elementName);
37    },
38    onFailed(code) {
39        console.error('onFailed code: ' + code);
40    }
41  };
42
43  let connection = this.context.connectAbility(want, connectOptions);
44  ```