js-apis-featureAbility.md 32.9 KB
Newer Older
1
# FeatureAbility模块(JS端SDK接口)
X
xuchenghua09 已提交
2

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

Z
zengyawen 已提交
6
## 使用限制
X
xuchenghua09 已提交
7 8 9

FeatureAbility模块的接口只能在Page类型的Ability调用

Z
zengyawen 已提交
10
## 导入模块
X
xuchenghua09 已提交
11 12 13 14 15

```
import featureAbility from '@ohos.ability.featureAbility'
```

Z
zengyawen 已提交
16
## featureAbility.startAbility
X
xuchenghua09 已提交
17

Z
zengyawen 已提交
18
startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\<number>): void
X
xuchenghua09 已提交
19

Z
zengyawen 已提交
20
启动新的ability(callback形式)。
X
xuchenghua09 已提交
21

Y
yuyaozhi 已提交
22
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
ahjxliubao2's avatar
ahjxliubao2 已提交
23

Z
zengyawen 已提交
24
**参数:**
X
xuchenghua09 已提交
25

H
HelloCrease 已提交
26 27 28 29
| 名称        | 类型                                       | 必填   | 描述             |
| --------- | ---------------------------------------- | ---- | -------------- |
| parameter | [StartAbilityParameter](#startabilityparameter) | 是    | 表示被启动的Ability。 |
| callback  | AsyncCallback\<number>                   | 是    | 被指定的回调方法。      |
X
xuchenghua09 已提交
30

Z
zengyawen 已提交
31
**示例:**
X
xuchenghua09 已提交
32 33 34

```javascript
import featureAbility from '@ohos.ability.featureAbility'
35
import wantConstant from '@ohos.ability.wantConstant'
X
xuchenghua09 已提交
36
featureAbility.startAbility(
37
    {
X
xuchenghua09 已提交
38 39 40 41 42
        want:
        {
            action: "",
            entities: [""],
            type: "",
43
            flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION,
X
xuchenghua09 已提交
44
            deviceId: "",
G
guyuanzhang 已提交
45 46
            bundleName: "com.example.myapplication",
            /* FA模型中abilityName由package + Ability name组成 */
Y
yuyaozhi 已提交
47
            abilityName: "com.example.entry.secondAbility",
X
xuchenghua09 已提交
48 49 50
            uri: ""
        },
    },
51
);
X
xuchenghua09 已提交
52 53 54 55
```



Z
zengyawen 已提交
56
## featureAbility.startAbility
X
xuchenghua09 已提交
57

Z
zengyawen 已提交
58
startAbility(parameter: StartAbilityParameter): Promise\<number>
X
xuchenghua09 已提交
59

Z
zengyawen 已提交
60
启动新的ability(Promise形式)。
X
xuchenghua09 已提交
61

Y
yuyaozhi 已提交
62
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
ahjxliubao2's avatar
ahjxliubao2 已提交
63

Z
zengyawen 已提交
64
**参数:**
X
xuchenghua09 已提交
65

H
HelloCrease 已提交
66 67 68
| 名称        | 类型                                       | 必填   | 描述             |
| --------- | ---------------------------------------- | ---- | -------------- |
| parameter | [StartAbilityParameter](#startabilityparameter) | 是    | 表示被启动的Ability。 |
X
xuchenghua09 已提交
69

Z
zengyawen 已提交
70
**示例:**
X
xuchenghua09 已提交
71 72 73

```javascript
import featureAbility from '@ohos.ability.featureAbility'
74
import wantConstant from '@ohos.ability.wantConstant'
X
xuchenghua09 已提交
75 76 77 78
featureAbility.startAbility(
    {
        want:
        {
79
            action: "action.system.home",
X
xuchenghua09 已提交
80 81
            entities: ["entity.system.home"],
            type: "MIMETYPE",
82 83
			flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION,
            deviceId: "",
G
guyuanzhang 已提交
84 85 86
            bundleName: "com.example.myapplication",
            /* FA模型中abilityName由package + Ability name组成 */
            abilityName: "com.example.entry.secondAbility",
X
xuchenghua09 已提交
87 88 89
            uri: ""
        },
    }
90
).then((data) => {
X
xuchenghua09 已提交
91 92 93 94
	console.info("==========================>startAbility=======================>");
});
```

95
## featureAbility.acquireDataAbilityHelper<sup>7+</sup>
X
xuchenghua09 已提交
96

Z
zengyawen 已提交
97
acquireDataAbilityHelper(uri: string): DataAbilityHelper
X
xuchenghua09 已提交
98

Z
zengyawen 已提交
99
获取dataAbilityHelper。
X
xuchenghua09 已提交
100

Y
yuyaozhi 已提交
101
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
ahjxliubao2's avatar
ahjxliubao2 已提交
102

Z
zengyawen 已提交
103
**参数:**
X
xuchenghua09 已提交
104

H
HelloCrease 已提交
105 106 107
| 名称   | 类型     | 必填   | 描述           |
| ---- | ------ | ---- | ------------ |
| uri  | string | 是    | 指示要打开的文件的路径。 |
X
xuchenghua09 已提交
108

Z
zengyawen 已提交
109
**返回值:**
X
xuchenghua09 已提交
110

H
HelloCrease 已提交
111 112
| 类型                | 说明                              |
| ----------------- | ------------------------------- |
Z
zengyawen 已提交
113
| DataAbilityHelper | 用来协助其他Ability访问DataAbility的工具类。 |
X
xuchenghua09 已提交
114

Z
zengyawen 已提交
115
**示例:**
X
xuchenghua09 已提交
116 117 118 119

```javascript
import featureAbility from '@ohos.ability.featureAbility'
featureAbility.acquireDataAbilityHelper(
Y
yuyaozhi 已提交
120
    "dataability:///com.example.DataAbility"
X
xuchenghua09 已提交
121 122 123
)
```

124
## featureAbility.startAbilityForResult<sup>7+</sup>
X
xuchenghua09 已提交
125

Z
zengyawen 已提交
126
startAbilityForResult(parameter: StartAbilityParameter, callback: AsyncCallback\<AbilityResult>): void
X
xuchenghua09 已提交
127

Z
zengyawen 已提交
128
启动一个ability,并在该ability被销毁时返回执行结果(callback形式)。
X
xuchenghua09 已提交
129

Y
yuyaozhi 已提交
130
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
ahjxliubao2's avatar
ahjxliubao2 已提交
131

Z
zengyawen 已提交
132
**参数:**
X
xuchenghua09 已提交
133

H
HelloCrease 已提交
134 135 136 137
| 名称        | 类型                                       | 必填   | 描述             |
| --------- | ---------------------------------------- | ---- | -------------- |
| parameter | [StartAbilityParameter](#startabilityparameter) | 是    | 表示被启动的Ability。 |
| callback  | AsyncCallback\<[AbilityResult](#abilityresult)> | 是    | 被指定的回调方法。      |
X
xuchenghua09 已提交
138

Z
zengyawen 已提交
139
**示例:**
X
xuchenghua09 已提交
140 141

```javascript
Y
yuyaozhi 已提交
142
import featureAbility from '@ohos.ability.featureAbility';
143
import wantConstant from '@ohos.ability.wantConstant'
X
xuchenghua09 已提交
144 145 146 147 148 149 150
featureAbility.startAbilityForResult(
   {
        want:
        {
            action: "action.system.home",
            entities: ["entity.system.home"],
            type: "MIMETYPE",
151
            flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION,
X
xuchenghua09 已提交
152
            deviceId: "",
G
guyuanzhang 已提交
153 154 155
            bundleName: "com.example.myapplication",
            /* FA模型中abilityName由package + Ability name组成 */
            abilityName: "com.example.entry.secondAbility",
X
xuchenghua09 已提交
156 157 158
            uri:""
        },
    },
159
    (err, data) => {
Y
yuyaozhi 已提交
160
        console.info("err: " + JSON.stringify(err) + "data: " + JSON.stringify(data))
161
    }
X
xuchenghua09 已提交
162 163 164
)
```

165
## featureAbility.startAbilityForResult<sup>7+</sup>
X
xuchenghua09 已提交
166

Z
zengyawen 已提交
167
startAbilityForResult(parameter: StartAbilityParameter): Promise\<AbilityResult>
X
xuchenghua09 已提交
168

Z
zengyawen 已提交
169
启动一个ability,并在该ability被销毁时返回执行结果(Promise形式)。
X
xuchenghua09 已提交
170

Y
yuyaozhi 已提交
171
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
ahjxliubao2's avatar
ahjxliubao2 已提交
172

Z
zengyawen 已提交
173
**参数:**
X
xuchenghua09 已提交
174

H
HelloCrease 已提交
175 176 177
| 名称        | 类型                                       | 必填   | 描述            |
| --------- | ---------------------------------------- | ---- | ------------- |
| parameter | [StartAbilityParameter](#startabilityparameter) | 是    | 表示被启动的Ability |
X
xuchenghua09 已提交
178

Z
zengyawen 已提交
179
**返回值:**
Y
yuyaozhi 已提交
180

H
HelloCrease 已提交
181 182
| 类型                                       | 说明      |
| ---------------------------------------- | ------- |
Z
zengyawen 已提交
183
| Promise\<[AbilityResult](#abilityresult)> | 返回执行结果。 |
X
xuchenghua09 已提交
184

Z
zengyawen 已提交
185
**示例:**
X
xuchenghua09 已提交
186 187

```javascript
Y
yuyaozhi 已提交
188
import featureAbility from '@ohos.ability.featureAbility';
189
import wantConstant from '@ohos.ability.wantConstant'
X
xuchenghua09 已提交
190 191 192 193 194 195 196
featureAbility.startAbilityForResult(
    {
        want:
        {
            action: "action.system.home",
            entities: ["entity.system.home"],
            type: "MIMETYPE",
197
            flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION,
X
xuchenghua09 已提交
198
            deviceId: "",
G
guyuanzhang 已提交
199 200 201
            bundleName: "com.example.myapplication",
            /* FA模型中abilityName由package + Ability name组成 */
            abilityName: "com.example.entry.secondAbility",
X
xuchenghua09 已提交
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
            uri:"",
            parameters:
            {
                mykey0: 1111,
                mykey1: [1, 2, 3],
                mykey2: "[1, 2, 3]",
                mykey3: "xxxxxxxxxxxxxxxxxxxxxx",
                mykey4: [1, 15],
                mykey5: [false, true, false],
                mykey6: ["aaaaaa", "bbbbb", "ccccccccccc"],
                mykey7: true,
            },
        },
        requestCode: 2,
    },
217
).then((data) => {
X
xuchenghua09 已提交
218 219 220 221
    console.info("==========================>startAbilityForResult=======================>");
});
```

222
## featureAbility.terminateSelfWithResult<sup>7+</sup>
X
xuchenghua09 已提交
223

Z
zengyawen 已提交
224
terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback\<void>): void
X
xuchenghua09 已提交
225

Z
zengyawen 已提交
226
设置此Page Ability将返回给调用者的结果代码和数据并破坏此Page Ability(callback形式)。
X
xuchenghua09 已提交
227

Y
yuyaozhi 已提交
228
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
ahjxliubao2's avatar
ahjxliubao2 已提交
229

Z
zengyawen 已提交
230
**参数:**
X
xuchenghua09 已提交
231

H
HelloCrease 已提交
232 233 234 235
| 名称        | 类型                              | 必填   | 描述             |
| --------- | ------------------------------- | ---- | -------------- |
| parameter | [AbilityResult](#abilityresult) | 是    | 表示被启动的Ability。 |
| callback  | AsyncCallback\<void>            | 是    | 被指定的回调方法。      |
X
xuchenghua09 已提交
236

Z
zengyawen 已提交
237
**示例:**
X
xuchenghua09 已提交
238 239 240

```javascript
import featureAbility from '@ohos.ability.featureAbility'
241
import wantConstant from '@ohos.ability.wantConstant'
X
xuchenghua09 已提交
242 243 244 245 246 247 248 249
featureAbility.terminateSelfWithResult(
    {
        resultCode: 1,
        want:
        {
            action: "action.system.home",
            entities: ["entity.system.home"],
            type: "MIMETYPE",
250
            flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION,
X
xuchenghua09 已提交
251
            deviceId: "",
G
guyuanzhang 已提交
252 253 254
            bundleName: "com.example.myapplication",
            /* FA模型中abilityName由package + Ability name组成 */
            abilityName: "com.example.entry.secondAbility",
X
xuchenghua09 已提交
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
            uri:"",
            parameters: {
                mykey0: 2222,
                mykey1: [1, 2, 3],
                mykey2: "[1, 2, 3]",
                mykey3: "ssssssssssssssssssssssssss",
                mykey4: [1, 15],
                mykey5: [false, true, false],
                mykey6: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"],
                mykey7: true,
            }
        },
    },
);
```

271
## featureAbility.terminateSelfWithResult<sup>7+</sup>
X
xuchenghua09 已提交
272

Z
zengyawen 已提交
273
terminateSelfWithResult(parameter: AbilityResult): Promise\<void>
X
xuchenghua09 已提交
274

Z
zengyawen 已提交
275
设置此Page Ability将返回给调用者的结果代码和数据并破坏此Page Ability(Promise形式)。
X
xuchenghua09 已提交
276

Y
yuyaozhi 已提交
277
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
ahjxliubao2's avatar
ahjxliubao2 已提交
278

Z
zengyawen 已提交
279
**参数:**
X
xuchenghua09 已提交
280

H
HelloCrease 已提交
281 282 283
| 名称        | 类型                              | 必填   | 描述            |
| --------- | ------------------------------- | ---- | ------------- |
| parameter | [AbilityResult](#abilityresult) | 是    | 表示被启动的Ability |
X
xuchenghua09 已提交
284

Z
zengyawen 已提交
285
**返回值:**
Y
yuyaozhi 已提交
286

H
HelloCrease 已提交
287 288
| 类型             | 说明              |
| -------------- | --------------- |
Z
zengyawen 已提交
289
| Promise\<void> | 以Promise形式返回结果。 |
X
xuchenghua09 已提交
290

Z
zengyawen 已提交
291
**示例:**
X
xuchenghua09 已提交
292 293

```javascript
Y
yuyaozhi 已提交
294
import featureAbility from '@ohos.ability.featureAbility';
295
import wantConstant from '@ohos.ability.wantConstant'
X
xuchenghua09 已提交
296 297 298 299 300 301 302 303
featureAbility.terminateSelfWithResult(
    {
        resultCode: 1,
        want:
        {
            action: "action.system.home",
            entities: ["entity.system.home"],
            type: "MIMETYPE",
304
            flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION,
X
xuchenghua09 已提交
305
            deviceId: "",
G
guyuanzhang 已提交
306 307 308
            bundleName: "com.example.myapplication",
            /* FA模型中abilityName由package + Ability name组成 */
            abilityName: "com.example.entry.secondAbility",
X
xuchenghua09 已提交
309 310 311 312 313 314 315 316 317 318 319 320 321
            uri:"",
            parameters: {
                mykey0: 2222,
                mykey1: [1, 2, 3],
                mykey2: "[1, 2, 3]",
                mykey3: "ssssssssssssssssssssssssss",
                mykey4: [1, 15],
                mykey5: [false, true, false],
                mykey6: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"],
                mykey7: true,
            }
        },
    }
322
).then((data) => {
X
xuchenghua09 已提交
323 324 325 326 327 328
    console.info("==========================>terminateSelfWithResult=======================>");
});
```



329
## featureAbility.hasWindowFocus<sup>7+<sup>
X
xuchenghua09 已提交
330

Z
zengyawen 已提交
331
hasWindowFocus(callback: AsyncCallback\<boolean>): void
X
xuchenghua09 已提交
332

Z
zengyawen 已提交
333
检查Ability的主窗口是否具有窗口焦点(callback形式)。
X
xuchenghua09 已提交
334

Y
yuyaozhi 已提交
335
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
ahjxliubao2's avatar
ahjxliubao2 已提交
336

Z
zengyawen 已提交
337
**参数:**
X
xuchenghua09 已提交
338

H
HelloCrease 已提交
339 340 341
| 名称       | 类型                      | 必填   | 描述                                       |
| -------- | ----------------------- | ---- | ---------------------------------------- |
| callback | AsyncCallback\<boolean> | 是    | 被指定的回调方法。<br>如果此Ability当前具有视窗焦点,则返回true;否则返回false。 |
X
xuchenghua09 已提交
342

Z
zengyawen 已提交
343
**示例:**
X
xuchenghua09 已提交
344 345

```javascript
Y
yuyaozhi 已提交
346
import featureAbility from '@ohos.ability.featureAbility';
X
xuchenghua09 已提交
347 348 349 350 351
featureAbility.hasWindowFocus()
```



352
## featureAbility.hasWindowFocus<sup>7+<sup>
X
xuchenghua09 已提交
353

Z
zengyawen 已提交
354
hasWindowFocus(): Promise\<boolean>
X
xuchenghua09 已提交
355

Z
zengyawen 已提交
356
检查Ability的主窗口是否具有窗口焦点(Promise形式)。
X
xuchenghua09 已提交
357

Y
yuyaozhi 已提交
358
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
ahjxliubao2's avatar
ahjxliubao2 已提交
359

Z
zengyawen 已提交
360
**返回值:**
X
xuchenghua09 已提交
361

H
HelloCrease 已提交
362 363
| 类型                | 说明                                    |
| ----------------- | ------------------------------------- |
Z
zengyawen 已提交
364
| Promise\<boolean> | 如果此Ability当前具有视窗焦点,则返回true;否则返回false。 |
X
xuchenghua09 已提交
365

Z
zengyawen 已提交
366
**示例:**
X
xuchenghua09 已提交
367 368 369

```javascript
import featureAbility from '@ohos.ability.featureability';
370
featureAbility.hasWindowFocus().then((data) => {
X
xuchenghua09 已提交
371 372 373 374 375 376
    console.info("==========================>hasWindowFocus=======================>");
});
```



Z
zengyawen 已提交
377
## featureAbility.getWant
X
xuchenghua09 已提交
378

Z
zengyawen 已提交
379
getWant(callback: AsyncCallback\<Want>): void
X
xuchenghua09 已提交
380

Z
zengyawen 已提交
381
获取从Ability发送的Want(callback形式)。
X
xuchenghua09 已提交
382

Y
yuyaozhi 已提交
383
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
ahjxliubao2's avatar
ahjxliubao2 已提交
384

Z
zengyawen 已提交
385
**参数:**
X
xuchenghua09 已提交
386

H
HelloCrease 已提交
387 388
| 名称       | 类型                            | 必填   | 描述        |
| -------- | ----------------------------- | ---- | --------- |
ahjxliubao2's avatar
ahjxliubao2 已提交
389
| callback | AsyncCallback\<[Want](js-apis-application-Want.md)> | 是    | 被指定的回调方法。 |
X
xuchenghua09 已提交
390

Z
zengyawen 已提交
391
**示例:**
X
xuchenghua09 已提交
392 393

```javascript
Y
yuyaozhi 已提交
394
import featureAbility from '@ohos.ability.featureAbility';
X
xuchenghua09 已提交
395 396 397 398 399
featureAbility.getWant()
```



Z
zengyawen 已提交
400
## featureAbility.getWant
X
xuchenghua09 已提交
401

Z
zengyawen 已提交
402
getWant(): Promise\<Want>
X
xuchenghua09 已提交
403

Z
zengyawen 已提交
404
获取从Ability发送的Want(Promise形式)。
X
xuchenghua09 已提交
405

Y
yuyaozhi 已提交
406
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
ahjxliubao2's avatar
ahjxliubao2 已提交
407

Z
zengyawen 已提交
408
**返回值:**
Y
yuyaozhi 已提交
409

H
HelloCrease 已提交
410 411
| 类型                      | 说明               |
| ----------------------- | ---------------- |
ahjxliubao2's avatar
ahjxliubao2 已提交
412
| Promise\<[Want](js-apis-application-Want.md)> | 以Promise的形式返回结果。 |
X
xuchenghua09 已提交
413

Z
zengyawen 已提交
414
**示例:**
X
xuchenghua09 已提交
415 416

```javascript
Y
yuyaozhi 已提交
417
import featureAbility from '@ohos.ability.featureAbility';
418
featureAbility.getWant().then((data) => {
419
	console.info("==========================>getWantCallBack=======================>");
X
xuchenghua09 已提交
420 421 422
});
```

Z
zengyawen 已提交
423
## featureAbility.getContext
X
xuchenghua09 已提交
424

Z
zengyawen 已提交
425
getContext(): Context
X
xuchenghua09 已提交
426

Z
zengyawen 已提交
427
获取应用上下文。
X
xuchenghua09 已提交
428

Y
yuyaozhi 已提交
429
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
ahjxliubao2's avatar
ahjxliubao2 已提交
430

Z
zengyawen 已提交
431
**返回值:**
Y
yuyaozhi 已提交
432

H
HelloCrease 已提交
433 434
| 类型      | 说明         |
| ------- | ---------- |
Z
zengyawen 已提交
435
| Context | 返回应用程序上下文。 |
X
xuchenghua09 已提交
436

Z
zengyawen 已提交
437
**示例:**
X
xuchenghua09 已提交
438 439

```javascript
Y
yuyaozhi 已提交
440
import featureAbility from '@ohos.ability.featureAbility';
X
xuchenghua09 已提交
441 442 443 444 445 446
var context = featureAbility.getContext()
context.getBundleName()
```



447
## featureAbility.terminateSelf<sup>7+</sup>
X
xuchenghua09 已提交
448

Z
zengyawen 已提交
449
terminateSelf(callback: AsyncCallback\<void>): void
X
xuchenghua09 已提交
450

Z
zengyawen 已提交
451
设置Page Ability返回给被调用方的结果代码和数据,并销毁此Page Ability(callback形式)。
X
xuchenghua09 已提交
452

Y
yuyaozhi 已提交
453
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
ahjxliubao2's avatar
ahjxliubao2 已提交
454

Z
zengyawen 已提交
455
**参数:**
X
xuchenghua09 已提交
456

H
HelloCrease 已提交
457 458 459
| 名称       | 类型                   | 必填   | 描述       |
| -------- | -------------------- | ---- | -------- |
| callback | AsyncCallback\<void> | 是    | 被指定的回调方法 |
X
xuchenghua09 已提交
460

Z
zengyawen 已提交
461
**示例:**
X
xuchenghua09 已提交
462 463

```javascript
Y
yuyaozhi 已提交
464
import featureAbility from '@ohos.ability.featureAbility';
X
xuchenghua09 已提交
465 466 467 468 469
featureAbility.terminateSelf()
```



470
## featureAbility.terminateSelf<sup>7+</sup>
X
xuchenghua09 已提交
471

Z
zengyawen 已提交
472
terminateSelf(): Promise\<void>
X
xuchenghua09 已提交
473

Z
zengyawen 已提交
474
设置Page Ability返回给被调用方的结果代码和数据,并销毁此Page Ability(Promise形式)。
X
xuchenghua09 已提交
475

Y
yuyaozhi 已提交
476
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
ahjxliubao2's avatar
ahjxliubao2 已提交
477

Z
zengyawen 已提交
478
**返回值:**
Y
yuyaozhi 已提交
479

H
HelloCrease 已提交
480 481
| 类型             | 说明               |
| -------------- | ---------------- |
Z
zengyawen 已提交
482
| Promise\<void> | 以Promise的形式返回结果。 |
X
xuchenghua09 已提交
483

Z
zengyawen 已提交
484
**示例:**
X
xuchenghua09 已提交
485 486

```javascript
Y
yuyaozhi 已提交
487
import featureAbility from '@ohos.ability.featureAbility';
488 489
featureAbility.terminateSelf().then((data) => {
    console.info("==========================>terminateSelfCallBack=======================>");
X
xuchenghua09 已提交
490 491 492
});
```

493
## featureAbility.connectAbility<sup>7+</sup>
X
xuchenghua09 已提交
494

Z
zengyawen 已提交
495
connectAbility(request: Want, options:ConnectOptions): number
X
xuchenghua09 已提交
496

Z
zengyawen 已提交
497
将当前ability连接到指定ServiceAbility(callback形式)。
X
xuchenghua09 已提交
498

Y
yuyaozhi 已提交
499
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
ahjxliubao2's avatar
ahjxliubao2 已提交
500

Z
zengyawen 已提交
501
**参数:**
X
xuchenghua09 已提交
502

H
HelloCrease 已提交
503 504
| 名称      | 类型             | 必填   | 描述                    |
| ------- | -------------- | ---- | --------------------- |
ahjxliubao2's avatar
ahjxliubao2 已提交
505
| request | [Want](js-apis-application-Want.md)  | 是    | 表示被连接的ServiceAbility。 |
H
HelloCrease 已提交
506
| options | ConnectOptions | 是    | 被指定的回调方法。             |
X
xuchenghua09 已提交
507

Z
zengyawen 已提交
508
**Want类型说明:**
509

ahjxliubao2's avatar
ahjxliubao2 已提交
510 511
**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase

H
HelloCrease 已提交
512 513 514 515 516
| 名称          | 读写属性 | 类型     | 必填   | 描述                                       |
| ----------- | ---- | ------ | ---- | ---------------------------------------- |
| deviceId    | 只读   | string | 否    | 表示被连接的ServiceAbility的设备id,缺省表示连接本地的ServiceAbility。 |
| bundleName  | 只读   | string | 是    | 表示被连接的ServiceAbility的包名。                 |
| abilityName | 只读   | string | 是    | 表示被连接的ServiceAbility的类名。                 |
517

Z
zengyawen 已提交
518
**ConnectOptions类型说明:**
X
xuchenghua09 已提交
519

ahjxliubao2's avatar
ahjxliubao2 已提交
520 521
**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core

H
HelloCrease 已提交
522 523 524 525 526
| 名称           | 读写属性 | 类型       | 必填   | 描述                        |
| ------------ | ---- | -------- | ---- | ------------------------- |
| onConnect    | 只读   | function | 是    | 连接成功时的回调函数。               |
| onDisconnect | 只读   | function | 是    | 连接失败时的回调函数。               |
| onFailed     | 只读   | function | 是    | ConnectAbility调用失败时的回调函数。 |
X
xuchenghua09 已提交
527

Z
zengyawen 已提交
528
**返回值:**
Y
yuyaozhi 已提交
529

H
HelloCrease 已提交
530 531
| 类型     | 说明                   |
| ------ | -------------------- |
Z
zengyawen 已提交
532
| number | 连接的ServiceAbilityID。 |
X
xuchenghua09 已提交
533

Z
zengyawen 已提交
534
**示例:**
X
xuchenghua09 已提交
535 536

```javascript
H
hanhaibin 已提交
537
import rpc from '@ohos.rpc'
X
xuchenghua09 已提交
538 539 540 541 542 543 544 545 546 547 548 549
import featureAbility from '@ohos.ability.featureAbility'
function onConnectCallback(element, remote){
    console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy));
}
function onDisconnectCallback(element){
    console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId)
}
function onFailedCallback(code){
    console.log('featureAbilityTest ConnectAbility onFailed errCode : ' + code)
}
var connId = featureAbility.connectAbility(
    {
550
        deviceId: "",
X
xuchenghua09 已提交
551 552 553 554 555 556 557 558 559 560 561
        bundleName: "com.ix.ServiceAbility",
        abilityName: "ServiceAbilityA",
    },
    {
        onConnect: onConnectCallback,
        onDisconnect: onDisconnectCallback,
        onFailed: onFailedCallback,
    },
);
```

562
## featureAbility.disconnectAbility<sup>7+</sup>
X
xuchenghua09 已提交
563

Z
zengyawen 已提交
564
disconnectAbility(connection: number, callback:AsyncCallback\<void>): void
X
xuchenghua09 已提交
565

Z
zengyawen 已提交
566
断开与指定ServiceAbility的连接(callback形式)。
X
xuchenghua09 已提交
567

Y
yuyaozhi 已提交
568
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
ahjxliubao2's avatar
ahjxliubao2 已提交
569

Z
zengyawen 已提交
570
**参数:**
X
xuchenghua09 已提交
571

H
HelloCrease 已提交
572 573 574 575
| 名称         | 类型                   | 必填   | 描述                      |
| ---------- | -------------------- | ---- | ----------------------- |
| connection | number               | 是    | 指定断开连接的ServiceAbilityID |
| callback   | AsyncCallback\<void> | 是    | 被指定的回调方法                |
X
xuchenghua09 已提交
576

Z
zengyawen 已提交
577
**示例:**
X
xuchenghua09 已提交
578 579

```javascript
H
hanhaibin 已提交
580
import rpc from '@ohos.rpc'
X
xuchenghua09 已提交
581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603
import featureAbility from '@ohos.ability.featureAbility'
function onConnectCallback(element, remote){
    console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy));
}
function onDisconnectCallback(element){
    console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId)
}
function onFailedCallback(code){
    console.log('featureAbilityTest ConnectAbility onFailed errCode : ' + code)
}
var connId = featureAbility.connectAbility(
    {
        bundleName: "com.ix.ServiceAbility",
        abilityName: "ServiceAbilityA",
    },
    {
        onConnect: onConnectCallback,
        onDisconnect: onDisconnectCallback,
        onFailed: onFailedCallback,
    },
);
var result = featureAbility.disconnectAbility(connId,
    (error,data) => {
604
        console.log('featureAbilityTest DisConnectJsSameBundleName result errCode : ' + error.code + " data: " + data)
X
xuchenghua09 已提交
605 606 607 608
    },
);
```

609
## featureAbility.disconnectAbility<sup>7+</sup>
X
xuchenghua09 已提交
610

Z
zengyawen 已提交
611
disconnectAbility(connection: number): Promise\<void>
X
xuchenghua09 已提交
612

Z
zengyawen 已提交
613
断开与指定ServiceAbility的连接(Promise形式)。
X
xuchenghua09 已提交
614

Y
yuyaozhi 已提交
615
**系统能力**:SystemCapability.Ability.AbilityRuntime.FAModel
ahjxliubao2's avatar
ahjxliubao2 已提交
616

Z
zengyawen 已提交
617
**参数:**
X
xuchenghua09 已提交
618

H
HelloCrease 已提交
619 620 621
| 名称         | 类型     | 必填   | 描述                      |
| ---------- | ------ | ---- | ----------------------- |
| connection | number | 是    | 指定断开连接的ServiceAbilityID |
X
xuchenghua09 已提交
622

Z
zengyawen 已提交
623
**返回值:**
Y
yuyaozhi 已提交
624

H
HelloCrease 已提交
625 626
| 类型             | 说明              |
| -------------- | --------------- |
Z
zengyawen 已提交
627
| Promise\<void> | 以Promise形式返回结果。 |
X
xuchenghua09 已提交
628

Z
zengyawen 已提交
629
**示例:**
X
xuchenghua09 已提交
630 631

```javascript
H
hanhaibin 已提交
632
import rpc from '@ohos.rpc'
X
xuchenghua09 已提交
633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653
import featureAbility from '@ohos.ability.featureAbility'
function onConnectCallback(element, remote){
    console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy));
}
function onDisconnectCallback(element){
    console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId)
}
function onFailedCallback(code){
    console.log('featureAbilityTest ConnectAbility onFailed errCode : ' + code)
}
var connId = featureAbility.connectAbility(
    {
        bundleName: "com.ix.ServiceAbility",
        abilityName: "ServiceAbilityA",
    },
    {
        onConnect: onConnectCallback,
        onDisconnect: onDisconnectCallback,
        onFailed: onFailedCallback,
    },
);
ahjxliubao2's avatar
ahjxliubao2 已提交
654

655
featureAbility.disconnectAbility(connId).then((error,data) => {
ahjxliubao2's avatar
ahjxliubao2 已提交
656 657
    console.log('featureAbilityTest result errCode : ' + error.code + " data: " + data);
});
X
xuchenghua09 已提交
658 659
```

660 661 662 663 664

## featureAbility.getWindow<sup>7+</sup>

getWindow(callback: AsyncCallback\<window.Window>): void

665
获取当前Ability对应的窗口(callback形式)。
666 667 668 669 670

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

**参数:**

671 672 673
| 名称     | 类型                          | 必填 | 描述                          |
| -------- | ----------------------------- | ---- | ----------------------------- |
| callback | AsyncCallback\<window.Window> | 是   | 返回与当前Ability对应的窗口。 |
674 675 676 677

**示例:**

```javascript
H
HelloCrease 已提交
678
featureAbility.getWindow()
679 680 681 682 683 684
```

## featureAbility.getWindow<sup>7+</sup>

getWindow(): Promise\<window.Window>;

685
获取当前Ability对应的窗口(Promise形式)。
686 687 688 689 690

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

**返回值:**

691 692 693
| 类型                    | 说明                          |
| ----------------------- | ----------------------------- |
| Promise\<window.Window> | 返回与当前Ability对应的窗口。 |
694 695 696 697

**示例:**

```javascript
H
HelloCrease 已提交
698
featureAbility.getWindow().then((data) => {
699
  console.info("=============getWindowPromise========== " +  JSON.stringify(data)); 
H
HelloCrease 已提交
700
});
701 702
```

703 704 705 706 707 708 709 710 711 712
## ConnectOptions.onConnect<sup>7+</sup>

onConnect(elementName: ElementName, remote: rpc.IRemoteObject): void;

连接成功时的回调函数。

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

**参数:**

H
HelloCrease 已提交
713 714 715 716
| 名称          | 类型                | 必填   | 描述       |
| ----------- | ----------------- | ---- | -------- |
| elementName | ElementName       | 是    | 元素名。     |
| remote      | rpc.IRemoteObject | 是    | rpc远程对象。 |
717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755

**示例:**

```javascript
import rpc from '@ohos.rpc'
import featureAbility from '@ohos.ability.featureAbility'
function onConnectCallback(element, remote){
    console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy));
}
function onDisconnectCallback(element){
    console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId)
}
function onFailedCallback(code){
    console.log('featureAbilityTest ConnectAbility onFailed errCode : ' + code)
}
var connId = featureAbility.connectAbility(
    {
        deviceId: "",
        bundleName: "com.ix.ServiceAbility",
        abilityName: "ServiceAbilityA",
    },
    {
        onConnect: onConnectCallback,
        onDisconnect: onDisconnectCallback,
        onFailed: onFailedCallback,
    },
);
```

## ConnectOptions.onDisconnect<sup>7+</sup>

onDisconnect(elementName: ElementName): void;

连接失败时的回调函数。

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

**参数:**

H
HelloCrease 已提交
756 757 758
| 名称          | 类型          | 必填   | 描述   |
| ----------- | ----------- | ---- | ---- |
| elementName | ElementName | 是    | 元素名。 |
759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797

**示例:**

```javascript
import rpc from '@ohos.rpc'
import featureAbility from '@ohos.ability.featureAbility'
function onConnectCallback(element, remote){
    console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy));
}
function onDisconnectCallback(element){
    console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId)
}
function onFailedCallback(code){
    console.log('featureAbilityTest ConnectAbility onFailed errCode : ' + code)
}
var connId = featureAbility.connectAbility(
    {
        deviceId: "",
        bundleName: "com.ix.ServiceAbility",
        abilityName: "ServiceAbilityA",
    },
    {
        onConnect: onConnectCallback,
        onDisconnect: onDisconnectCallback,
        onFailed: onFailedCallback,
    },
);
```

## ConnectOptions.onFailed<sup>7+</sup>

onFailed(code: number): void;

ConnectAbility调用失败时的回调函数。

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

**参数:**

H
HelloCrease 已提交
798 799 800
| 名称   | 类型     | 必填   | 描述        |
| ---- | ------ | ---- | --------- |
| code | number | 是    | number类型。 |
801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832

**示例:**

```javascript
import rpc from '@ohos.rpc'
import featureAbility from '@ohos.ability.featureAbility'
function onConnectCallback(element, remote){
    console.log('ConnectAbility onConnect remote is proxy:' + (remote instanceof rpc.RemoteProxy));
}
function onDisconnectCallback(element){
    console.log('ConnectAbility onDisconnect element.deviceId : ' + element.deviceId)
}
function onFailedCallback(code){
    console.log('featureAbilityTest ConnectAbility onFailed errCode : ' + code)
}
var connId = featureAbility.connectAbility(
    {
        deviceId: "",
        bundleName: "com.ix.ServiceAbility",
        abilityName: "ServiceAbilityA",
    },
    {
        onConnect: onConnectCallback,
        onDisconnect: onDisconnectCallback,
        onFailed: onFailedCallback,
    },
);
```




833 834 835 836 837 838 839 840

## AbilityWindowConfiguration

使用时通过featureAbility.AbilityWindowConfiguration获取。

**示例:**

```
841
featureAbility.AbilityWindowConfiguration.WINDOW_MODE_UNDEFINED
842 843
```

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

H
HelloCrease 已提交
846 847
| 名称                                       | 参数   | 描述                                       |
| ---------------------------------------- | ---- | ---------------------------------------- |
848 849 850 851 852
| WINDOW_MODE_UNDEFINED<sup>7+</sup>       | 0    | 未定义。 |
| WINDOW_MODE_FULLSCREEN<sup>7+</sup>      | 1    | 全屏。    |
| WINDOW_MODE_SPLIT_PRIMARY<sup>7+</sup>   | 100  | 分屏主屏。 |
| WINDOW_MODE_SPLIT_SECONDARY<sup>7+</sup> | 101  | 分屏次屏。 |
| WINDOW_MODE_FLOATING<sup>7+</sup>        | 102  | 悬浮窗。 |
853 854 855 856 857 858 859 860 861 862 863


## AbilityStartSetting

abilityStartSetting属性是一个定义为[key: string]: any的对象,key对应设定类型为:AbilityStartSetting枚举类型,value对应设定类型为:AbilityWindowConfiguration枚举类型。

使用时通过featureAbility.AbilityStartSetting获取。

**示例:**

```
864
featureAbility.AbilityStartSetting.BOUNDS_KEY
865 866
```

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

H
HelloCrease 已提交
869 870
| 名称                           | 参数              | 描述                                       |
| ---------------------------- | --------------- | ---------------------------------------- |
871 872 873
| BOUNDS_KEY<sup>7+</sup>      | "abilityBounds" | 窗口显示大小属性的名称。 |
| WINDOW_MODE_KEY<sup>7+</sup> | "windowMode"    | 窗口显示模式属性的名称。|
| DISPLAY_ID_KEY<sup>7+</sup>  | "displayId"     | 窗口显示设备ID属性的名称。 |
874 875 876 877 878

## ErrorCode

获取错误代码。

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

H
HelloCrease 已提交
881 882
| 变量                             | 值    | 说明                                       |
| ------------------------------ | ---- | ---------------------------------------- |
883 884 885 886
| NO_ERROR<sup>7+</sup>          | 0    | 没有错误。 |
| INVALID_PARAMETER<sup>7+</sup> | -1   | 无效的参数。 |
| ABILITY_NOT_FOUND<sup>7+</sup> | -2   | 找不到能力。 |
| PERMISSION_DENY<sup>7+</sup>   | -3   | 拒绝许可。 |
887 888 889 890 891 892


## DataAbilityOperationType

指示数据的操作类型。

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

H
HelloCrease 已提交
895 896
| 变量                       | 值    | 说明                                       |
| ------------------------ | ---- | ---------------------------------------- |
897 898 899 900
| TYPE_INSERT<sup>7+</sup> | 1    | 插入类型。 |
| TYPE_UPDATE<sup>7+</sup> | 2    | 修改类型。 |
| TYPE_DELETE<sup>7+</sup> | 3    | 删除类型。 |
| TYPE_ASSERT<sup>7+</sup> | 4    | 声明类型。 |
901 902 903



Z
zengyawen 已提交
904
## AbilityResult
X
xuchenghua09 已提交
905

ahjxliubao2's avatar
ahjxliubao2 已提交
906 907
**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase

H
HelloCrease 已提交
908 909 910
| 名称                      | 读写属性 | 类型            | 必填   | 描述                                    |
| ----------------------- | ---- | ------------- | ---- | ------------------------------------- |
| resultCode<sup>7+</sup> | 只读   | number        | 是    | 指示销毁该能力后返回的结果代码。您可以定义结果代码来识别错误(暂不支持)。 |
ahjxliubao2's avatar
ahjxliubao2 已提交
911
| want<sup>7+</sup>       | 只读   | [Want](js-apis-application-Want.md) | 否    | 指示销毁该能力后返回的数据。您可以定义返回的数据。此参数可以为null。  |
X
xuchenghua09 已提交
912

Z
zengyawen 已提交
913
## StartAbilityParameter
X
xuchenghua09 已提交
914

ahjxliubao2's avatar
ahjxliubao2 已提交
915 916
**系统能力**:以下各项对应的系统能力均为SystemCapability.AbilityRuntime.FAModel 

H
HelloCrease 已提交
917 918
| 名称                  | 读写属性 | 类型                   | 必填   | 描述                                     |
| ------------------- | ---- | -------------------- | ---- | -------------------------------------- |
ahjxliubao2's avatar
ahjxliubao2 已提交
919
| want                | 只读   | [Want](js-apis-application-Want.md)        | 是    | 表示需要包含有关目标启动能力的信息。                     |
H
HelloCrease 已提交
920
| abilityStartSetting | 只读   | {[key: string]: any} | 否    | 表示能力的特殊属性,当开发者启动能力时,该属性可以作为调用中的输入参数传递。 |
X
xuchenghua09 已提交
921 922 923

## flags说明

ahjxliubao2's avatar
ahjxliubao2 已提交
924 925
**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase

H
HelloCrease 已提交
926 927 928 929 930 931 932 933 934 935 936 937 938 939 940
| 名称                                   | 参数         | 描述                                       |
| ------------------------------------ | ---------- | ---------------------------------------- |
| FLAG_AUTH_READ_URI_PERMISSION        | 0x00000001 | 指示对URI执行读取操作的授权。                         |
| FLAG_AUTH_WRITE_URI_PERMISSION       | 0x00000002 | 指示对URI执行写入操作的授权。                         |
| FLAG_ABILITY_FORWARD_RESULT          | 0x00000004 | 将结果返回给元能力。                               |
| FLAG_ABILITY_CONTINUATION            | 0x00000008 | 确定是否可以将本地设备上的功能迁移到远程设备。                  |
| FLAG_NOT_OHOS_COMPONENT              | 0x00000010 | 指定组件是否属于OHOS。                            |
| FLAG_ABILITY_FORM_ENABLED            | 0x00000020 | 指定是否启动某个能力。                              |
| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权。                          |
| FLAG_AUTH_PREFIX_URI_PERMISSION      | 0x00000080 | 按照前缀匹配的方式验证URI权限。                        |
| FLAG_ABILITYSLICE_MULTI_DEVICE       | 0x00000100 | 支持分布式调度系统中的多设备启动。                        |
| FLAG_START_FOREGROUND_ABILITY        | 0x00000200 | 指示无论主机应用程序是否已启动,都将启动使用服务模板的功能。           |
| FLAG_ABILITY_CONTINUATION_REVERSIBLE | 0x00000400 | 表示迁移是可拉回的。                               |
| FLAG_INSTALL_ON_DEMAND               | 0x00000800 | 如果未安装指定的功能,请安装该功能。                       |
| FLAG_INSTALL_WITH_BACKGROUND_MODE    | 0x80000000 | 如果未安装,使用后台模式安装该功能。                       |
941
| FLAG_ABILITY_CLEAR_MISSION           | 0x00008000 | 指示清除其他任务的操作。可以为传递给 **[ohos.app.Context](js-apis-ability-context.md)****startAbility**方法的**Want**设置此标志,并且必须与**flag_ABILITY_NEW_MISSION**一起使用。 |
H
HelloCrease 已提交
942
| FLAG_ABILITY_NEW_MISSION             | 0x10000000 | 指示在历史任务堆栈上创建任务的操作。                       |
ahjxliubao2's avatar
ahjxliubao2 已提交
943
| FLAG_ABILITY_MISSION_TOP             | 0x20000000 | 指示如果启动能力的现有实例已位于任务堆栈的顶部,则将重用该实例。否则,将创建一个新的能力实例。 |
X
xuchenghua09 已提交
944