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

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

X
xuchenghua09 已提交
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
## 导入模块

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

Context对象是在featureAbility中创建实例,并通过featureAbility的getContext()接口返回,因此在使用Context时,必须导入@ohos.ability.featureAbility库。示例如下:

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

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

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

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

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

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

Z
zengyawen 已提交
31
**参数:**
X
xuchenghua09 已提交
32

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

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

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



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

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

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

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

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

Z
zengyawen 已提交
59
**返回值:**
X
xuchenghua09 已提交
60

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

Z
zengyawen 已提交
65
**示例:**
X
xuchenghua09 已提交
66 67 68 69

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



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

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

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

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

Z
zengyawen 已提交
85
**参数:**
X
xuchenghua09 已提交
86

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

Z
zengyawen 已提交
93
**示例:**
X
xuchenghua09 已提交
94 95 96 97 98

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



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

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

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

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

Y
yuyaozhi 已提交
114
**参数:**
X
xuchenghua09 已提交
115

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

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

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

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

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

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

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

Z
zengyawen 已提交
137
**参数:**
X
xuchenghua09 已提交
138

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

Z
zengyawen 已提交
144
**返回值:**
X
xuchenghua09 已提交
145

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

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

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



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

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

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

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

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

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

Z
zengyawen 已提交
180
**示例:**
X
xuchenghua09 已提交
181 182 183 184

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



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

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

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

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

Z
zengyawen 已提交
208
**参数:**
X
xuchenghua09 已提交
209

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

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

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



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

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

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

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

Z
zengyawen 已提交
232
**返回值:**
X
xuchenghua09 已提交
233

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

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

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



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

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

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

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

Z
zengyawen 已提交
259
**参数:**
X
xuchenghua09 已提交
260

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

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

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



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

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

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

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

Z
zengyawen 已提交
283
**返回值:**
X
xuchenghua09 已提交
284

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

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

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



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

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

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

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

Z
zengyawen 已提交
310
**参数:**
X
xuchenghua09 已提交
311

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

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

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



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

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

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

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

Z
zengyawen 已提交
334
**返回值:**
X
xuchenghua09 已提交
335

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

Z
zengyawen 已提交
340
**示例:**
X
xuchenghua09 已提交
341 342 343 344

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



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

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

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

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

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

Z
zengyawen 已提交
363
**参数:**
X
xuchenghua09 已提交
364

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

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

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



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

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

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

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

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

Z
zengyawen 已提交
389
**返回值:**
X
xuchenghua09 已提交
390

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

Z
zengyawen 已提交
395
**示例:**
X
xuchenghua09 已提交
396 397 398 399

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

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

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

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

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

Y
yuyaozhi 已提交
414
**参数:**
ahjxliubao2's avatar
ahjxliubao2 已提交
415

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

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

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



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

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

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

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

Z
zengyawen 已提交
438
**返回值:**
X
xuchenghua09 已提交
439

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

Z
zengyawen 已提交
444
**示例:**
X
xuchenghua09 已提交
445 446 447 448

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



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

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

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

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

Z
zengyawen 已提交
465
**参数:**
X
xuchenghua09 已提交
466

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

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

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



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

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

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

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

Z
zengyawen 已提交
489
**返回值:**
X
xuchenghua09 已提交
490

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

Z
zengyawen 已提交
495
**示例:**
X
xuchenghua09 已提交
496 497 498 499

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

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

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

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

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

**参数:**

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

**示例:**

```js
import featureAbility from '@ohos.ability.featureAbility'
Z
zhongjianfei 已提交
524
var context = featureAbility.getContext();
D
dy 已提交
525 526 527 528 529 530 531 532 533
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 已提交
534
## Context.getCacheDir
D
dy 已提交
535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558

getCacheDir(): Promise\<string>

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

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

**返回值:**

| 类型            | 说明                      |
| --------------- | ------------------------- |
| Promise\<string> | 获取该应用程序的内部存储目录 |

**示例:**

```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 已提交
559
## Context.getFilesDir
D
dy 已提交
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576

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

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

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

**参数:**

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

**示例:**

```js
import featureAbility from '@ohos.ability.featureAbility'
Z
zhongjianfei 已提交
577
var context = featureAbility.getContext();
D
dy 已提交
578 579 580 581 582 583 584 585 586
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 已提交
587
## Context.getFilesDir
D
dy 已提交
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611

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 已提交
612
## Context.getOrCreateDistributedDir<sup>7+</sup>
D
dy 已提交
613 614 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

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 已提交
642
## Context.getOrCreateDistributedDir<sup>7+</sup>
D
dy 已提交
643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667

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 已提交
668
## Context.getAppType<sup>7+</sup>
D
dy 已提交
669 670 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

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 已提交
696
## Context.getAppType<sup>7+</sup>
D
dy 已提交
697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719

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

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 已提交
748
## Context.getHapModuleInfo<sup>7+</sup>
D
dy 已提交
749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771

getHapModuleInfo(): Promise\<HapModuleInfo>

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

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

**返回值:**

| 类型            | 说明                      |
| --------------- | ------------------------- |
| Promise\<[HapModuleInfo](#hapmoduleinfo)> | Promise形式返回应用的ModuleInfo对象。 |

**示例:**

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

X
xuzhihao 已提交
772
## Context.getAppVersionInfo<sup>7+</sup>
D
dy 已提交
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 798 799

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 已提交
800
## Context.getAppVersionInfo<sup>7+</sup>
D
dy 已提交
801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823

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 已提交
824
## Context.getAbilityInfo<sup>7+</sup>
D
dy 已提交
825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851

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

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

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

**参数:**

| 名称     | 类型                   | 必填 | 描述                      |
| -------- | ---------------------- | ---- | ------------------------- |
| callback | AsyncCallback\<[AbilityInfo](#abilityInfo)> | 是   |回调函数,可以在回调函数中处理接口返回值,返回当前归属Ability详细信息。|

**示例:**

```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 已提交
852
## Context.getAbilityInfo<sup>7+</sup>
D
dy 已提交
853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875

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 已提交
876
## Context.getApplicationContext<sup>7+</sup>
D
dy 已提交
877 878 879 880 881 882 883 884 885

getApplicationContext(): Context

获取应用上下文信息。

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

**返回值:**

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

**示例:**

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

X
xuzhihao 已提交
897
## PermissionOptions<sup>7+</sup>
Z
zengyawen 已提交
898

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

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

X
xuzhihao 已提交
906
## PermissionRequestResult<sup>7+</sup>
Z
zengyawen 已提交
907

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

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

X
xuzhihao 已提交
916
## HapModuleInfo<sup>7+</sup>
D
dy 已提交
917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938

Hap模块信息

| 名称               | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ------ | ------ | ------ |
| 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信息 |

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

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