js-apis-Context.md 29.9 KB
Newer Older
X
xuchenghua09 已提交
1 2
# Context模块

X
xuzhihao 已提交
3
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
Y
yuyaozhi 已提交
4 5
> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。   
> 本模块接口仅可在FA模型下使用。
X
xuzhihao 已提交
6

X
xuchenghua09 已提交
7 8 9
## 导入模块

```js
Y
yuyaozhi 已提交
10
import featureAbility from '@ohos.ability.featureAbility'
X
xuchenghua09 已提交
11 12
```

13 14
## 使用说明

X
xuchenghua09 已提交
15 16 17 18 19 20 21 22
Context对象是在featureAbility中创建实例,并通过featureAbility的getContext()接口返回,因此在使用Context时,必须导入@ohos.ability.featureAbility库。示例如下:

```js
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext();
context.getOrCreateLocalDir()
```

X
xuzhihao 已提交
23
## Context.getOrCreateLocalDir<sup>7+</sup>
X
xuchenghua09 已提交
24

Z
zengyawen 已提交
25
getOrCreateLocalDir(callback: AsyncCallback\<string>): void
X
xuchenghua09 已提交
26

Z
zengyawen 已提交
27
获取应用程序的本地根目录(callback形式)。
X
xuchenghua09 已提交
28

Z
zengyawen 已提交
29
如果是第一次调用,将创建目录。
X
xuchenghua09 已提交
30

Y
yuyaozhi 已提交
31
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
ahjxliubao2's avatar
ahjxliubao2 已提交
32

Z
zengyawen 已提交
33
**参数:**
X
xuchenghua09 已提交
34

Z
zengyawen 已提交
35 36 37
| 名称     | 类型                   | 必填 | 描述                       |
| -------- | ---------------------- | ---- | -------------------------- |
| callback | AsyncCallback\<string> | 是   | 返回应用程序的本地根目录。 |
X
xuchenghua09 已提交
38

Z
zengyawen 已提交
39
**示例:**
X
xuchenghua09 已提交
40 41 42 43 44 45 46 47 48 49 50

```js
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext();
context.getOrCreateLocalDir((err, data)=>{
    console.info("data=" + data);
})
```



X
xuzhihao 已提交
51
## Context.getOrCreateLocalDir<sup>7+</sup>
Z
zengyawen 已提交
52 53

getOrCreateLocalDir(): Promise\<string>
X
xuchenghua09 已提交
54

Z
zengyawen 已提交
55
获取应用程序的本地根目录(Promise形式)。
X
xuchenghua09 已提交
56

Z
zengyawen 已提交
57
如果是第一次调用,将创建目录。
X
xuchenghua09 已提交
58

Y
yuyaozhi 已提交
59
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
ahjxliubao2's avatar
ahjxliubao2 已提交
60

Z
zengyawen 已提交
61
**返回值:**
X
xuchenghua09 已提交
62

Z
zengyawen 已提交
63 64 65
| 类型             | 说明                   |
| ---------------- | ---------------------- |
| Promise\<string> | 应用程序的本地根目录。 |
X
xuchenghua09 已提交
66

Z
zengyawen 已提交
67
**示例:**
X
xuchenghua09 已提交
68 69 70 71

```js
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext();
72 73
context.getOrCreateLocalDir().then((data) => {
    console.info("data=" + data);
X
xuchenghua09 已提交
74 75 76 77 78
});
```



X
xuzhihao 已提交
79
## Context.verifyPermission<sup>7+</sup>
X
xuchenghua09 已提交
80

Z
zengyawen 已提交
81
verifyPermission(permission: string, options: PermissionOptions, callback: AsyncCallback\<number>): void
X
xuchenghua09 已提交
82

Z
zengyawen 已提交
83
验证系统中运行的特定pid和uid是否允许指定的权限(callback形式)。
X
xuchenghua09 已提交
84

Y
yuyaozhi 已提交
85
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
ahjxliubao2's avatar
ahjxliubao2 已提交
86

Z
zengyawen 已提交
87
**参数:**
X
xuchenghua09 已提交
88

Z
zengyawen 已提交
89 90 91 92 93
| 名称       | 类型                                    | 必填 | 描述                                  |
| ---------- | --------------------------------------- | ---- | ------------------------------------- |
| permission | string                                  | 是   | 指定权限的名称。                      |
| options    | [PermissionOptions](#permissionoptions) | 是   | 权限选项。                            |
| callback   | AsyncCallback\<number>                  | 是   | 返回权限验证结果,0有权限,-1无权限。 |
X
xuchenghua09 已提交
94

Z
zengyawen 已提交
95
**示例:**
X
xuchenghua09 已提交
96 97 98 99 100

```js
import featureAbility from '@ohos.ability.featureAbility'
import bundle from '@ohos.bundle'
var context = featureAbility.getContext();
Y
yuyaozhi 已提交
101 102
bundle.getBundleInfo('com.context.test', 1, (err,datainfo) =>{
	context.verifyPermission("com.example.permission", {uid:datainfo.uid});
ahjxliubao2's avatar
ahjxliubao2 已提交
103
});
X
xuchenghua09 已提交
104 105 106 107
```



X
xuzhihao 已提交
108
## Context.verifyPermission<sup>7+</sup>
X
xuchenghua09 已提交
109

Z
zengyawen 已提交
110
verifyPermission(permission: string, callback: AsyncCallback\<number>): void
X
xuchenghua09 已提交
111

Z
zengyawen 已提交
112
验证系统中运行的当前pid和uid是否具有指定的权限(callback形式)。
X
xuchenghua09 已提交
113

Y
yuyaozhi 已提交
114
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
X
xuchenghua09 已提交
115

Y
yuyaozhi 已提交
116
**参数:**
X
xuchenghua09 已提交
117

Z
zengyawen 已提交
118 119 120 121
| 名称       | 类型                   | 必填 | 描述                                  |
| ---------- | ---------------------- | ---- | ------------------------------------- |
| permission | string                 | 是   | 指定权限的名称。                      |
| callback   | AsyncCallback\<number> | 是   | 返回权限验证结果,0有权限,-1无权限。 |
X
xuchenghua09 已提交
122

Z
zengyawen 已提交
123
**示例:**
X
xuchenghua09 已提交
124 125 126 127 128 129 130

```js
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext();
context.verifyPermission("com.example.permission")
```

X
xuzhihao 已提交
131
## Context.verifyPermission<sup>7+</sup>
X
xuchenghua09 已提交
132

Z
zengyawen 已提交
133
verifyPermission(permission: string, options?: PermissionOptions): Promise\<number>
X
xuchenghua09 已提交
134

Z
zengyawen 已提交
135
验证系统中运行的特定pid和uid是否具有指定的权限(Promise形式)。
X
xuchenghua09 已提交
136

Y
yuyaozhi 已提交
137
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
ahjxliubao2's avatar
ahjxliubao2 已提交
138

Z
zengyawen 已提交
139
**参数:**
X
xuchenghua09 已提交
140

Z
zengyawen 已提交
141 142 143 144
| 名称       | 类型                                    | 必填 | 描述             |
| ---------- | --------------------------------------- | ---- | ---------------- |
| permission | string                                  | 是   | 指定权限的名称。 |
| options    | [PermissionOptions](#permissionoptions) | 否   | 权限选项。       |
X
xuchenghua09 已提交
145

Z
zengyawen 已提交
146
**返回值:**
X
xuchenghua09 已提交
147

Z
zengyawen 已提交
148 149 150
| 类型             | 说明                                                        |
| ---------------- | ----------------------------------------------------------- |
| Promise\<number> | 如果pid和uid具有权限,则使用0进行异步回调;否则使用-1回调。 |
X
xuchenghua09 已提交
151

Z
zengyawen 已提交
152
**示例:**
X
xuchenghua09 已提交
153 154 155 156

```js
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext();
Y
yuyaozhi 已提交
157
var Permission = {pid:1};
158 159 160
context.verifyPermission('com.context.permission',Permission).then((data) => {
    console.info("======================>verifyPermissionCallback====================>");
    console.info("====>data====>" + JSON.stringify(data));
X
xuchenghua09 已提交
161 162 163 164 165
});
```



X
xuzhihao 已提交
166
## Context.requestPermissionsFromUser<sup>7+</sup>
X
xuchenghua09 已提交
167

Y
yuyaozhi 已提交
168
requestPermissionsFromUser(permissions: Array\<string>, requestCode: number, resultCallback: AsyncCallback<[PermissionRequestResult](#permissionrequestresult)>): void
X
xuchenghua09 已提交
169

Z
zengyawen 已提交
170
从系统请求某些权限(callback形式)。
X
xuchenghua09 已提交
171

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

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

Z
zengyawen 已提交
176 177 178 179 180
| 名称           | 类型                                                         | 必填 | 描述                                            |
| -------------- | ------------------------------------------------------------ | ---- | ----------------------------------------------- |
| permissions    | Array\<string>                                               | 是   | 指示要请求的权限列表。此参数不能为null。        |
| requestCode    | number                                                       | 是   | 指示要传递给PermissionRequestResult的请求代码。 |
| resultCallback | AsyncCallback<[PermissionRequestResult](#permissionrequestresult)> | 是   | 返回授权结果信息。                              |
Y
yuyaozhi 已提交
181

Z
zengyawen 已提交
182
**示例:**
X
xuchenghua09 已提交
183 184 185 186

```js
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext();
187
context.requestPermissionsFromUser(
X
xuchenghua09 已提交
188 189 190 191 192
    ["com.example.permission1",
     "com.example.permission2",
     "com.example.permission3",
     "com.example.permission4",
     "com.example.permission5"],
193 194 195 196
    1,(err, data)=>{
        console.info("====>requestdata====>" + JSON.stringify(data));
        console.info("====>requesterrcode====>" + JSON.stringify(err.code));
    }
X
xuchenghua09 已提交
197 198 199 200 201
)
```



X
xuzhihao 已提交
202
## Context.getApplicationInfo<sup>7+</sup>
X
xuchenghua09 已提交
203

Y
yuyaozhi 已提交
204
getApplicationInfo(callback: AsyncCallback\<ApplicationInfo>): void
X
xuchenghua09 已提交
205

Z
zengyawen 已提交
206
获取有关当前应用程序的信息(callback形式)。
X
xuchenghua09 已提交
207

Y
yuyaozhi 已提交
208
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
ahjxliubao2's avatar
ahjxliubao2 已提交
209

Z
zengyawen 已提交
210
**参数:**
X
xuchenghua09 已提交
211

Z
zengyawen 已提交
212 213 214
| 名称     | 类型                            | 必填 | 描述                     |
| -------- | ------------------------------- | ---- | ------------------------ |
| callback | AsyncCallback\<ApplicationInfo> | 是   | 返回当前应用程序的信息。 |
X
xuchenghua09 已提交
215

Z
zengyawen 已提交
216
**示例:**
X
xuchenghua09 已提交
217 218 219 220 221 222 223 224 225

```js
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext();
context.getApplicationInfo()
```



X
xuzhihao 已提交
226
## Context.getApplicationInfo<sup>7+</sup>
X
xuchenghua09 已提交
227

Z
zengyawen 已提交
228
getApplicationInfo(): Promise\<ApplicationInfo>
X
xuchenghua09 已提交
229

Z
zengyawen 已提交
230
获取有关当前应用程序的信息(Promise形式)。
X
xuchenghua09 已提交
231

Y
yuyaozhi 已提交
232
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
ahjxliubao2's avatar
ahjxliubao2 已提交
233

Z
zengyawen 已提交
234
**返回值:**
X
xuchenghua09 已提交
235

Z
zengyawen 已提交
236 237 238
| 类型                      | 说明               |
| ------------------------- | ------------------ |
| Promise\<ApplicationInfo> | 当前应用程序的信息 |
X
xuchenghua09 已提交
239

Z
zengyawen 已提交
240
**示例:**
X
xuchenghua09 已提交
241 242 243 244

```js
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext();
245 246 247
context.getApplicationInfo().then((data) => {
    console.info("=====================>getApplicationInfoCallback===================>");
    console.info("====>data====>" + JSON.stringify(data));
X
xuchenghua09 已提交
248 249 250 251 252
});
```



X
xuzhihao 已提交
253
## Context.getBundleName<sup>7+</sup>
X
xuchenghua09 已提交
254

Z
zengyawen 已提交
255
getBundleName(callback: AsyncCallback\<string>): void
X
xuchenghua09 已提交
256

Z
zengyawen 已提交
257
获取当前ability的捆绑包名称(callback形式)。
X
xuchenghua09 已提交
258

Y
yuyaozhi 已提交
259
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
ahjxliubao2's avatar
ahjxliubao2 已提交
260

Z
zengyawen 已提交
261
**参数:**
X
xuchenghua09 已提交
262

Z
zengyawen 已提交
263 264 265
| 名称     | 类型                   | 必填 | 描述                          |
| -------- | ---------------------- | ---- | ----------------------------- |
| callback | AsyncCallback\<string> | 是   | 返回当前ability的捆绑包名称。 |
X
xuchenghua09 已提交
266

Z
zengyawen 已提交
267
**示例:**
X
xuchenghua09 已提交
268 269 270 271 272 273 274 275 276

```js
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext();
context.getBundleName()
```



X
xuzhihao 已提交
277
## Context.getBundleName<sup>7+</sup>
X
xuchenghua09 已提交
278

Z
zengyawen 已提交
279
getBundleName(): Promise\<string>
X
xuchenghua09 已提交
280

Z
zengyawen 已提交
281
获取当前ability的捆绑包名称(Promise形式)。
X
xuchenghua09 已提交
282

Y
yuyaozhi 已提交
283
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
ahjxliubao2's avatar
ahjxliubao2 已提交
284

Z
zengyawen 已提交
285
**返回值:**
X
xuchenghua09 已提交
286

Z
zengyawen 已提交
287 288 289
| 类型             | 说明                      |
| ---------------- | ------------------------- |
| Promise\<string> | 当前ability的捆绑包名称。 |
X
xuchenghua09 已提交
290

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

```js
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext();
296 297 298
context.getBundleName().then((data) => {
    console.info("=======================>getBundleNameCallback====================>");
    console.info("====>data====>" + JSON.stringify(data));
X
xuchenghua09 已提交
299 300 301 302 303
});
```



X
xuzhihao 已提交
304
## Context.getProcessInfo<sup>7+</sup>
X
xuchenghua09 已提交
305

Y
yuyaozhi 已提交
306
getProcessInfo(callback: AsyncCallback\<ProcessInfo>): void
X
xuchenghua09 已提交
307

Z
zengyawen 已提交
308
获取有关当前进程的信息,包括进程ID和名称(callback形式)。
X
xuchenghua09 已提交
309

Y
yuyaozhi 已提交
310
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
ahjxliubao2's avatar
ahjxliubao2 已提交
311

Z
zengyawen 已提交
312
**参数:**
X
xuchenghua09 已提交
313

Z
zengyawen 已提交
314 315 316
| 名称     | 类型                        | 必填 | 描述                 |
| -------- | --------------------------- | ---- | -------------------- |
| callback | AsyncCallback\<ProcessInfo> | 是   | 返回当前进程的信息。 |
X
xuchenghua09 已提交
317

Z
zengyawen 已提交
318
**示例:**
X
xuchenghua09 已提交
319 320 321 322 323 324 325 326 327

```js
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext();
context.getProcessInfo()
```



X
xuzhihao 已提交
328
## Context.getProcessInfo<sup>7+</sup>
X
xuchenghua09 已提交
329

Z
zengyawen 已提交
330
getProcessInfo(): Promise\<ProcessInfo>
X
xuchenghua09 已提交
331

Z
zengyawen 已提交
332
获取有关当前进程的信息,包括进程id和名称(Promise形式)。
X
xuchenghua09 已提交
333

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

Z
zengyawen 已提交
336
**返回值:**
X
xuchenghua09 已提交
337

Z
zengyawen 已提交
338 339 340
| 类型                  | 说明           |
| --------------------- | -------------- |
| Promise\<ProcessInfo> | 当前进程的信息 |
X
xuchenghua09 已提交
341

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

```js
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext();
347 348 349
context.getProcessInfo().then((data) => {
    console.info("=======================>getProcessInfoCallback====================>");
    console.info("====>data====>" + JSON.stringify(data));
X
xuchenghua09 已提交
350 351 352 353 354
});
```



X
xuzhihao 已提交
355
## Context.getElementName<sup>7+</sup>
X
xuchenghua09 已提交
356

Z
zengyawen 已提交
357
getElementName(callback: AsyncCallback\<ElementName>): void
X
xuchenghua09 已提交
358

Z
zengyawen 已提交
359
获取当前ability的ohos.bundle.ElementName对象(callback形式)。
X
xuchenghua09 已提交
360

Z
zengyawen 已提交
361
此方法仅适用于页面功能。
X
xuchenghua09 已提交
362

Y
yuyaozhi 已提交
363
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
ahjxliubao2's avatar
ahjxliubao2 已提交
364

Z
zengyawen 已提交
365
**参数:**
X
xuchenghua09 已提交
366

Z
zengyawen 已提交
367 368 369
| 名称     | 类型                        | 必填 | 描述                                           |
| -------- | --------------------------- | ---- | ---------------------------------------------- |
| callback | AsyncCallback\<ElementName> | 是   | 返回当前ability的ohos.bundle.ElementName对象。 |
X
xuchenghua09 已提交
370

Z
zengyawen 已提交
371
**示例:**
X
xuchenghua09 已提交
372 373 374 375 376 377 378 379 380

```js
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext();
context.getElementName()
```



X
xuzhihao 已提交
381
## Context.getElementName<sup>7+</sup>
X
xuchenghua09 已提交
382

Z
zengyawen 已提交
383
getElementName(): Promise\<ElementName>
X
xuchenghua09 已提交
384

Z
zengyawen 已提交
385
获取当前能力的ohos.bundle.ElementName对象(Promise形式)。
X
xuchenghua09 已提交
386

Z
zengyawen 已提交
387
此方法仅适用于页面功能。
X
xuchenghua09 已提交
388

Y
yuyaozhi 已提交
389
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
ahjxliubao2's avatar
ahjxliubao2 已提交
390

Z
zengyawen 已提交
391
**返回值:**
X
xuchenghua09 已提交
392

Z
zengyawen 已提交
393 394 395
| 类型                  | 说明                                       |
| --------------------- | ------------------------------------------ |
| Promise\<ElementName> | 当前ability的ohos.bundle.ElementName对象。 |
X
xuchenghua09 已提交
396

Z
zengyawen 已提交
397
**示例:**
X
xuchenghua09 已提交
398 399 400 401

```js
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext();
402 403 404
context.getElementName().then((data) => {
    console.info("=======================>getElementNameCallback====================>");
    console.info("====>data====>" + JSON.stringify(data));
X
xuchenghua09 已提交
405 406 407
});
```

X
xuzhihao 已提交
408
## Context.getProcessName<sup>7+</sup>
X
xuchenghua09 已提交
409

Z
zengyawen 已提交
410
getProcessName(callback: AsyncCallback\<string>): void
X
xuchenghua09 已提交
411

Z
zengyawen 已提交
412
获取当前进程的名称(callback形式)。
X
xuchenghua09 已提交
413

Y
yuyaozhi 已提交
414
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
ahjxliubao2's avatar
ahjxliubao2 已提交
415

Y
yuyaozhi 已提交
416
**参数:**
ahjxliubao2's avatar
ahjxliubao2 已提交
417

Z
zengyawen 已提交
418 419 420
| 名称     | 类型                   | 必填 | 描述                 |
| -------- | ---------------------- | ---- | -------------------- |
| callback | AsyncCallback\<string> | 是   | 返回当前进程的名称。 |
X
xuchenghua09 已提交
421

Z
zengyawen 已提交
422
**示例:**
X
xuchenghua09 已提交
423 424 425 426 427 428 429 430 431

```js
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext();
context.getProcessName()
```



X
xuzhihao 已提交
432
## Context.getProcessName<sup>7+</sup>
X
xuchenghua09 已提交
433

Z
zengyawen 已提交
434
getProcessName(): Promise\<string>
X
xuchenghua09 已提交
435

Z
zengyawen 已提交
436
获取当前进程的名称(Promise形式)。
X
xuchenghua09 已提交
437

Y
yuyaozhi 已提交
438
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
ahjxliubao2's avatar
ahjxliubao2 已提交
439

Z
zengyawen 已提交
440
**返回值:**
X
xuchenghua09 已提交
441

Z
zengyawen 已提交
442 443 444
| 类型             | 说明                 |
| ---------------- | -------------------- |
| Promise\<string> | 返回当前进程的名称。 |
X
xuchenghua09 已提交
445

Z
zengyawen 已提交
446
**示例:**
X
xuchenghua09 已提交
447 448 449 450

```js
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext();
451 452 453
context.getProcessName().then((data) => {
    console.info("=======================>getProcessNameCallback====================>");
    console.info("====>data====>" + JSON.stringify(data));
X
xuchenghua09 已提交
454 455 456 457 458
});
```



X
xuzhihao 已提交
459
## Context.getCallingBundle<sup>7+</sup>
X
xuchenghua09 已提交
460

Z
zengyawen 已提交
461
getCallingBundle(callback: AsyncCallback\<string>): void
X
xuchenghua09 已提交
462

Z
zengyawen 已提交
463
获取调用ability的包名称(callback形式)。
X
xuchenghua09 已提交
464

Y
yuyaozhi 已提交
465
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
ahjxliubao2's avatar
ahjxliubao2 已提交
466

Z
zengyawen 已提交
467
**参数:**
X
xuchenghua09 已提交
468

Z
zengyawen 已提交
469 470 471
| 名称     | 类型                   | 必填 | 描述                      |
| -------- | ---------------------- | ---- | ------------------------- |
| callback | AsyncCallback\<string> | 是   | 返回调用ability的包名称。 |
X
xuchenghua09 已提交
472

Z
zengyawen 已提交
473
**示例:**
X
xuchenghua09 已提交
474 475 476 477 478 479 480 481 482

```js
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext();
context.getCallingBundle()
```



X
xuzhihao 已提交
483
## Context.getCallingBundle<sup>7+</sup>
X
xuchenghua09 已提交
484

Z
zengyawen 已提交
485
getCallingBundle(): Promise\<string>
X
xuchenghua09 已提交
486

Z
zengyawen 已提交
487
获取调用ability的包名称(Promise形式)。
X
xuchenghua09 已提交
488

Y
yuyaozhi 已提交
489
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
ahjxliubao2's avatar
ahjxliubao2 已提交
490

Z
zengyawen 已提交
491
**返回值:**
X
xuchenghua09 已提交
492

Z
zengyawen 已提交
493 494
| 类型            | 说明                      |
| --------------- | ------------------------- |
495
| Promise\<string> | 调用ability的包名称。 |
X
xuchenghua09 已提交
496

Z
zengyawen 已提交
497
**示例:**
X
xuchenghua09 已提交
498 499 500 501

```js
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext();
502 503 504
context.getCallingBundle().then((data) => {
    console.info("======================>getCallingBundleCallback====================>");
    console.info("====>data====>" + JSON.stringify(data));
X
xuchenghua09 已提交
505 506 507
});
```

X
xuzhihao 已提交
508
## Context.getCacheDir
D
dy 已提交
509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525

getCacheDir(callback: AsyncCallback\<string>): void

获取该应用程序的内部存储目录(callback形式)。

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

**参数:**

| 名称     | 类型                   | 必填 | 描述                      |
| -------- | ---------------------- | ---- | ------------------------- |
| callback | AsyncCallback\<string> | 是   | 返回该应用程序的内部存储目录。|

**示例:**

```js
import featureAbility from '@ohos.ability.featureAbility'
Z
zhongjianfei 已提交
526
var context = featureAbility.getContext();
D
dy 已提交
527 528 529 530 531 532 533 534 535
context.getCacheDir((err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
});
```

X
xuzhihao 已提交
536
## Context.getCacheDir
D
dy 已提交
537 538 539 540 541 542 543 544 545 546 547

getCacheDir(): Promise\<string>

获取该应用程序的内部存储目录(Promise形式)。

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

**返回值:**

| 类型            | 说明                      |
| --------------- | ------------------------- |
548
| Promise\<string> | 获取该应用程序的内部存储目录。 |
D
dy 已提交
549 550 551 552 553 554 555 556 557 558 559 560

**示例:**

```js
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext();
context.getCacheDir().then((data) => {
    console.info("======================>getCacheDirPromsie====================>");
    console.info("====>data====>" + JSON.stringify(data));
});
```

X
xuzhihao 已提交
561
## Context.getFilesDir
D
dy 已提交
562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578

getFilesDir(callback: AsyncCallback\<string>): void

获取内部存储器上此应用程序的文件目录(callback形式)。

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

**参数:**

| 名称     | 类型                   | 必填 | 描述                      |
| -------- | ---------------------- | ---- | ------------------------- |
| callback | AsyncCallback\<string> | 是   | 返回内部存储器上此应用程序的文件目录。|

**示例:**

```js
import featureAbility from '@ohos.ability.featureAbility'
Z
zhongjianfei 已提交
579
var context = featureAbility.getContext();
D
dy 已提交
580 581 582 583 584 585 586 587 588
context.getFilesDir((err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
});
```

X
xuzhihao 已提交
589
## Context.getFilesDir
D
dy 已提交
590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613

getFilesDir(): Promise\<string>

获取内部存储器上此应用程序的文件目录(Promise形式)。

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

**返回值:**

| 类型            | 说明                      |
| --------------- | ------------------------- |
| Promise\<string> | 返回内部存储器上此应用程序的文件目录。 |

**示例:**

```js
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext();
context.getFilesDir().then((data) => {
    console.info("======================>getFilesDirPromsie====================>");
    console.info("====>data====>" + JSON.stringify(data));
});
```

X
xuzhihao 已提交
614
## Context.getOrCreateDistributedDir<sup>7+</sup>
D
dy 已提交
615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643

getOrCreateDistributedDir(callback: AsyncCallback\<string>): void

获取Ability或应用的分布式文件路径。

如果分布式文件路径不存在,系统将创建一个路径并返回创建的路径(callback形式)。

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

**参数:**

| 名称     | 类型                   | 必填 | 描述                      |
| -------- | ---------------------- | ---- | ------------------------- |
| callback | AsyncCallback\<string> | 是   | 回调函数,可以在回调函数中处理接口返回值,返回Ability或应用的分布式文件路径。如果分布式文件路径不存在,系统将创建一个路径并返回创建的路径。|

**示例:**

```js
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext();
context.getOrCreateDistributedDir((err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
});
```

X
xuzhihao 已提交
644
## Context.getOrCreateDistributedDir<sup>7+</sup>
D
dy 已提交
645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669

getOrCreateDistributedDir(): Promise\<string>

获取Ability或应用的分布式文件路径。

如果分布式文件路径不存在,系统将创建一个路径并返回创建的路径(Promise形式)。

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

**返回值:**

| 类型            | 说明                      |
| --------------- | ------------------------- |
| Promise\<string> | Ability或应用的分布式文件路径。如果是第一次调用,则将创建目录。 |

**示例:**

```js
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext();
context.getOrCreateDistributedDir().then((data) => {
    console.info("====>data====>" + JSON.stringify(data));
});
```

X
xuzhihao 已提交
670
## Context.getAppType<sup>7+</sup>
D
dy 已提交
671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697

getAppType(callback: AsyncCallback\<string>): void

获取此应用的类型(callback形式)。

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

**参数:**

| 名称     | 类型                   | 必填 | 描述                      |
| -------- | ---------------------- | ---- | ------------------------- |
| callback | AsyncCallback\<string> | 是   | 回调函数,可以在回调函数中处理接口返回值,返回此应用程序的类型。|

**示例:**

```js
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext();
context.getAppType((err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
});
```

X
xuzhihao 已提交
698
## Context.getAppType<sup>7+</sup>
D
dy 已提交
699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721

getAppType(): Promise\<string>

获取此应用的类型(Promise形式)。

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

**返回值:**

| 类型            | 说明                      |
| --------------- | ------------------------- |
| Promise\<string> | Promise形式返回此应用的类型。 |

**示例:**

```js
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext();
context.getAppType().then((data) => {
    console.info("====>data====>" + JSON.stringify(data));
});
```

X
xuzhihao 已提交
722
## Context.getHapModuleInfo<sup>7+</sup>
D
dy 已提交
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

getHapModuleInfo(callback: AsyncCallback\<HapModuleInfo>): void

获取应用的ModuleInfo对象(callback形式)。

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

**参数:**

| 名称     | 类型                   | 必填 | 描述                      |
| -------- | ---------------------- | ---- | ------------------------- |
| callback | AsyncCallback\<[HapModuleInfo](#hapmoduleinfo)> | 是   | 回调函数,可以在回调函数中处理接口返回值,返回应用的ModuleInfo对象。|

**示例:**

```js
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext();
context.getHapModuleInfo((err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
});
```

X
xuzhihao 已提交
750
## Context.getHapModuleInfo<sup>7+</sup>
D
dy 已提交
751 752 753 754 755 756 757 758 759 760 761

getHapModuleInfo(): Promise\<HapModuleInfo>

获取应用的ModuleInfo对象(Promise形式)。

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

**返回值:**

| 类型            | 说明                      |
| --------------- | ------------------------- |
762
| Promise\<[HapModuleInfo](#hapmoduleinfo)> | 返回应用的ModuleInfo对象。 |
D
dy 已提交
763 764 765 766 767 768 769 770 771 772 773

**示例:**

```js
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext();
context.getHapModuleInfo().then((data) => {
    console.info("====>data====>" + JSON.stringify(data));
});
```

X
xuzhihao 已提交
774
## Context.getAppVersionInfo<sup>7+</sup>
D
dy 已提交
775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801

getAppVersionInfo(callback: AsyncCallback\<HapModuleInfo>): void

获取应用的版本信息(callback形式)。

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

**参数:**

| 名称     | 类型                   | 必填 | 描述                      |
| -------- | ---------------------- | ---- | ------------------------- |
| callback | AsyncCallback\<[AppVersionInfo](#appversioninfo)> | 是   | 回调函数,可以在回调函数中处理接口返回值,返回应用版本信息。|

**示例:**

```js
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext();
context.getAppVersionInfo((err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
});
```

X
xuzhihao 已提交
802
## Context.getAppVersionInfo<sup>7+</sup>
D
dy 已提交
803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825

getAppVersionInfo(): Promise\<AppVersionInfo>

获取应用的版本信息(Promise形式)。

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

**返回值:**

| 类型            | 说明                      |
| --------------- | ------------------------- |
| Promise\<[AppVersionInfo](#appversioninfo)> | 返回应用版本信息。 |

**示例:**

```js
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext();
context.getAppVersionInfo().then((data) => {
    console.info("====>data====>" + JSON.stringify(data));
});
```

X
xuzhihao 已提交
826
## Context.getAbilityInfo<sup>7+</sup>
D
dy 已提交
827 828 829 830 831 832 833 834 835 836 837

getAbilityInfo(callback: AsyncCallback\<AbilityInfo>): void

查询当前归属Ability详细信息(callback形式)。

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

**参数:**

| 名称     | 类型                   | 必填 | 描述                      |
| -------- | ---------------------- | ---- | ------------------------- |
838
| callback | AsyncCallback\<[AbilityInfo](#abilityInfo)> | 是   | 回调函数,可以在回调函数中处理接口返回值,返回当前归属Ability详细信息。|
D
dy 已提交
839 840 841 842 843 844 845 846 847 848 849 850 851 852 853

**示例:**

```js
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext();
context.getAbilityInfo((err, data) => {
    if (err) {
        console.error('Operation failed. Cause: ' + JSON.stringify(err));
        return;
    }
    console.info('Operation successful. Data:' + JSON.stringify(data));
});
```

X
xuzhihao 已提交
854
## Context.getAbilityInfo<sup>7+</sup>
D
dy 已提交
855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877

getAbilityInfo(): Promise\<AbilityInfo>

查询当前归属Ability详细信息(Promise形式)。

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

**返回值:**

| 类型            | 说明                      |
| --------------- | ------------------------- |
| Promise\<[AbilityInfo](#abilityInfo)> | 返回当前归属Ability详细信息。 |

**示例:**

```js
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext();
context.getAbilityInfo().then((data) => {
    console.info("====>data====>" + JSON.stringify(data));
});
```

X
xuzhihao 已提交
878
## Context.getApplicationContext<sup>7+</sup>
D
dy 已提交
879 880 881 882 883 884 885 886 887

getApplicationContext(): Context

获取应用上下文信息。

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

**返回值:**

888 889
| 类型      | 说明   |
| --------- |------ |
890
|  Context | 返回应用上下文信息。 |
D
dy 已提交
891 892 893 894 895 896 897 898

**示例:**

```js
import featureAbility from '@ohos.ability.featureAbility'
var context = featureAbility.getContext().getApplicationContext();
```

X
xuzhihao 已提交
899
## PermissionOptions<sup>7+</sup>
Z
zengyawen 已提交
900

ahjxliubao2's avatar
ahjxliubao2 已提交
901 902
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

Z
zengyawen 已提交
903 904
| 名称 | 读写属性 | 类型   | 必填 | 描述   |
| ---- | -------- | ------ | ---- | ------ |
ahjxliubao2's avatar
ahjxliubao2 已提交
905 906
| pid  | 只读     | number | 否   | 进程id。 |
| uid  | 只读     | number | 否   | 用户id。 |
Z
zengyawen 已提交
907

X
xuzhihao 已提交
908
## PermissionRequestResult<sup>7+</sup>
Z
zengyawen 已提交
909

ahjxliubao2's avatar
ahjxliubao2 已提交
910 911
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core

Z
zengyawen 已提交
912 913
| 名称        | 读写属性 | 类型           | 必填 | 描述               |
| ----------- | -------- | -------------- | ---- | ------------------ |
ahjxliubao2's avatar
ahjxliubao2 已提交
914 915
| requestCode | 只读     | number         | 是   | 用户传入的请求代码。 |
| permissions | 只读     | Array\<string> | 是   | 用户传入的权限。     |
916
| authResults | 只读     | Array\<number> | 是   | 请求权限的结果。    |
D
dy 已提交
917

X
xuzhihao 已提交
918
## HapModuleInfo<sup>7+</sup>
D
dy 已提交
919 920 921 922 923

Hap模块信息

| 名称               | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ------ | ------ | ------ |
924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939
| name             | string        | 是   | 否   | 模块名称。           |
| description      | string        | 是   | 否   | 模块描述信息。       |
| descriptionId    | number        | 是   | 否   | 描述信息ID。         |
| icon             | string        | 是   | 否   | 模块图标。           |
| label            | string        | 是   | 否   | 模块标签。           |
| labelId          | number        | 是   | 否   | 模块标签ID。         |
| iconId           | number        | 是   | 否   | 模块图标ID。         |
| backgroundImg    | string        | 是   | 否   | 模块背景图片。       |
| supportedModes   | number        | 是   | 否   | 模块支持的模式。     |
| reqCapabilities  | Array<string> | 是   | 否   | 模块运行需要的能力。 |
| deviceTypes      | Array<string> | 是   | 否   | 支持运行的设备类型。 |
| abilityInfo      | Array<AbilityInfo> | 是   | 否   | Ability信息。  |
| moduleName       | string        | 是   | 否   | 模块名。             |
| mainAbilityName  | string        | 是   | 否   | 入口Ability名称。    |
| installationFree | boolean       | 是   | 否   | 是否支持免安装。     |
| mainElementName | string | 是 | 否 | 入口ability信息。 |
D
dy 已提交
940

X
xuzhihao 已提交
941
## AppVersionInfo<sup>7+</sup>
D
dy 已提交
942 943 944

| 名称             | 类型 | 可读    | 可写   | 说明 |
| ------          | ------ | ------| ------ | ------    |
945 946 947
| appName         | string | 是    | 否     | 模块名称。      |
| versionCode     | number | 是    | 否     | 模块描述信息。   |
| versionName     | string | 是    | 否     | 描述信息ID。     |