js-apis-service-extension.md 3.5 KB
Newer Older
1 2 3 4 5 6
# ServiceExtension

> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。


7
提供ServiceExtension服务扩展相关接口。
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23


## 导入模块

```
import ServiceExtension from '@ohos.application.ServiceExtension';
```


## 权限




## 属性

24
| 名称 | 参数类型 | 可读 | 可写 | 说明 | 
25
| -------- | -------- | -------- | -------- | -------- |
26
| context | [ServiceExtensionContext](js-apis-service-extension-context.md)  | 是 | 否 | ServiceExtension的上下文环境,继承自ExtensionContext。 | 
27 28 29 30


## onCreate

31
onCreate(want: Want): void;
32

33
Extension生命周期回调,在创建时回调,执行初始化业务逻辑操作。
34 35

- 参数:
36
  | 参数名 | 类型 | 必填 | 说明 | 
37
  | -------- | -------- | -------- | -------- |
38
  | want |  [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 | 
39 40 41 42 43 44 45 46 47 48 49

- 示例:
  ```
  onCreate(want) {
      console.log('onCreate, want:' + want.abilityName);
  }
  ```


## onDestroy

50
onDestroy(): void;
51

52
Extension生命周期回调,在销毁时回调,执行资源清理等操作。
53 54 55 56 57

- 示例:
  ```
  onDestroy() {
      console.log('onDestroy');
58
      destory();
59 60 61 62 63 64
  }
  ```


## onRequest

65
onRequest(want: Want, startId: number): void;
66

67
Extension生命周期回调,如果是startAbility拉起的服务,会在onCreate之后回调。每次拉起服务都会回调,startId会递增。
68 69

- 参数:
70
  | 参数名 | 类型 | 必填 | 说明 | 
71
  | -------- | -------- | -------- | -------- |
72 73
  | want |  [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 | 
  | startId | number | 是 | 返回拉起次数。首次拉起初始值返回1,多次之后自动递增。 | 
74 75 76 77 78 79 80 81 82 83 84

- 示例:
  ```
  onRequest(want: Want, startId: number) {
      console.log('onRequest, want:' + want.abilityName);
  }
  ```


## onConnect

85
onConnect(want: Want): rpc.RemoteObject;
86

87
Extension生命周期回调,如果是connectAbility拉起的服务,会在onCreate之后回调。返回一个RemoteObject对象,用于和客户端进行通信。
88 89

- 参数:
90
  | 参数名 | 类型 | 必填 | 说明 | 
91
  | -------- | -------- | -------- | -------- |
92
  | want |  [Want](js-apis-featureAbility.md#Want类型说明)| 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 | 
93 94

- 返回值:
95
  | 类型 | 说明 | 
96
  | -------- | -------- |
97
  | rpc.RemoteObject | 一个RemoteObject对象,用于和客户端进行通信。 | 
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118

- 示例:
  ```
  import rpc from '@ohos.rpc'
  class StubTest extends rpc.RemoteObject{
      constructor(des) {
          super(des);
      }
      onRemoteRequest(code, data, reply, option) {
      }
  }
  ...
  onConnect(want) {
      console.log('onConnect , want:' + want.abilityName);
      return new StubTest("test");
  }
  ```


## onDisconnect

119
onDisconnect(want: Want): void;
120 121 122 123

Extension的生命周期,断开服务连接时回调。

- 参数:
124
  | 参数名 | 类型 | 必填 | 说明 | 
125
  | -------- | -------- | -------- | -------- |
126
  | want |[Want](js-apis-featureAbility.md#Want类型说明)| 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 | 
127 128 129 130 131 132 133

- 示例:
  ```
  onDisconnect(want) {
      console.log('onDisconnect, want:' + want.abilityName);
  }
  ```