js-apis-inner-ability-connectOptions.md 1.6 KB
Newer Older
M
m00512953 已提交
1 2
# ConnectOptions

D
dy_study 已提交
3
在连接指定的后台服务时作为入参,用于接收连接过程中的状态变化,如作为[connectServiceExtensionAbility](js-apis-inner-application-uiAbilityContext.md#uiabilitycontextconnectserviceextensionability)的入参,连接指定的ServiceExtensionAbility。
M
m00512953 已提交
4

5 6 7 8
> **说明:**
> 
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。  

9 10 11 12 13 14
## 导入模块

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

Y
yuyaozhi 已提交
15 16
## 属性

M
m00512953 已提交
17 18
**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core

D
merge  
donglin 已提交
19 20
| 参数名           | 类型       | 必填   | 说明                        |
| ------------ | -------- | ---- | ------------------------- |
Z
zhongjianfei 已提交
21 22 23
| onConnect<sup>7+</sup>    | function | 是    | 建立连接时的回调函数。      |
| onDisconnect<sup>7+</sup> | function | 是    | 断开连接时的回调函数。           |
| onFailed<sup>7+</sup>     | function | 是    | 连接失败时的回调函数。 |
M
m00512953 已提交
24

M
mingxihua 已提交
25 26 27 28
**示例:**

  ```ts
  let want = {
M
mingxihua 已提交
29 30
    bundleName: 'com.example.myapp',
    abilityName: 'MyAbility'
M
mingxihua 已提交
31 32
  };

33
  let connectOptions: common.ConnectOptions = {
M
mingxihua 已提交
34
    onConnect(elementName, remote) { 
M
mingxihua 已提交
35
        console.log('onConnect elementName: ${elementName}');
M
mingxihua 已提交
36 37
    },
    onDisconnect(elementName) { 
M
mingxihua 已提交
38
        console.log('onDisconnect elementName: ${elementName}');
M
mingxihua 已提交
39 40
    },
    onFailed(code) { 
M
mingxihua 已提交
41
        console.error('onFailed code: ${code}');
M
mingxihua 已提交
42
    }
M
mingxihua 已提交
43
  };
M
mingxihua 已提交
44 45 46

  let connection = this.context.connectAbility(want, connectOptions);
  ```