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
## 导入模块

```js
9
import Context from "@ohos.app.context";
X
xuchenghua09 已提交
10 11
```

12 13
## 使用说明

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

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

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

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

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

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

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

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

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

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

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



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

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

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

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

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

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

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

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

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



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

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

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

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

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

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

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

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



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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



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

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

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

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

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

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

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

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



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

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

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

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

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

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

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

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



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

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

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

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

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

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

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

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



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

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

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

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

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

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

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

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



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

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

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

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

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

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

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

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



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

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

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

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

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

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

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

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



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

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

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

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

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

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

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

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



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

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

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

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

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

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

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

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

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



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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



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

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

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

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

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

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

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

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



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

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

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

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

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

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

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

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



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

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

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

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

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

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

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

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

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

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

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

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

**参数:**

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

**示例:**

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

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

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

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

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

**参数:**

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

**示例:**

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

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

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

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

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

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

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

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 已提交
773
## Context.getAppVersionInfo<sup>7+</sup>
D
dy 已提交
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 800

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

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 已提交
825
## Context.getAbilityInfo<sup>7+</sup>
D
dy 已提交
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 852

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

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

getApplicationContext(): Context

获取应用上下文信息。

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

**返回值:**

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

**示例:**

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

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

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

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

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

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

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

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

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 已提交
940
## AppVersionInfo<sup>7+</sup>
D
dy 已提交
941 942 943 944 945 946

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