js-apis-inner-app-context.md 42.2 KB
Newer Older
Z
zengyawen 已提交
1
# Context
X
xuchenghua09 已提交
2

3
Context模块提供了ability或application的上下文的能力,包括允许访问特定于应用程序的资源、请求和验证权限等。
Y
yuyaozhi 已提交
4

Y
yuyaozhi 已提交
5
> **说明:**
6
>
Z
zengyawen 已提交
7
> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
C
chenyuyan 已提交
8
> 本模块接口**仅可在FA模型**下使用。
X
xuzhihao 已提交
9

10 11
## 使用说明

Z
zhongjianfei 已提交
12
Context对象是在featureAbility中创建实例,并通过featureAbility的[getContext](js-apis-ability-featureAbility.md#featureabilitygetcontext)接口返回,因此在使用Context时,必须导入@ohos.ability.featureAbility库。示例如下:
X
xuchenghua09 已提交
13

M
m00512953 已提交
14
```ts
D
dy_study 已提交
15
import featureAbility from '@ohos.ability.featureAbility';
X
xuchenghua09 已提交
16
var context = featureAbility.getContext();
D
dy_study 已提交
17 18 19
context.getOrCreateLocalDir().then((data) => {
    console.info("getOrCreateLocalDir data: " + JSON.stringify(data));
});
X
xuchenghua09 已提交
20 21
```

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

D
merge  
donglin 已提交
34
| 参数名       | 类型                     | 必填   | 说明            |
35 36
| -------- | ---------------------- | ---- | ------------- |
| callback | AsyncCallback\<string> | 是    | 返回应用程序的本地根目录。 |
X
xuchenghua09 已提交
37

Z
zengyawen 已提交
38
**示例:**
X
xuchenghua09 已提交
39

M
m00512953 已提交
40
```ts
D
dy_study 已提交
41
import featureAbility from '@ohos.ability.featureAbility';
X
xuchenghua09 已提交
42 43
var context = featureAbility.getContext();
context.getOrCreateLocalDir((err, data)=>{
D
dy_study 已提交
44 45
    console.info("getOrCreateLocalDir err: " + JSON.stringify(err) + "data: " + JSON.stringify(data));
});
X
xuchenghua09 已提交
46 47 48 49
```



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

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

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

M
m00512953 已提交
68
```ts
D
dy_study 已提交
69
import featureAbility from '@ohos.ability.featureAbility';
X
xuchenghua09 已提交
70
var context = featureAbility.getContext();
71
context.getOrCreateLocalDir().then((data) => {
D
dy_study 已提交
72
    console.info("getOrCreateLocalDir data: " + JSON.stringify(data));
X
xuchenghua09 已提交
73 74 75
});
```

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

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

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

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

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

D
merge  
donglin 已提交
86
| 参数名         | 类型                                      | 必填   | 说明                   |
87 88
| ---------- | --------------------------------------- | ---- | -------------------- |
| permission | string                                  | 是    | 指定权限的名称。             |
C
chenyuyan 已提交
89
| options    | [PermissionOptions](#permissionoptions7) | 是    | 权限选项。                |
90
| callback   | AsyncCallback\<number>                  | 是    | 返回权限验证结果,0有权限,-1无权限。 |
X
xuchenghua09 已提交
91

Z
zengyawen 已提交
92
**示例:**
X
xuchenghua09 已提交
93

M
m00512953 已提交
94
```ts
D
dy_study 已提交
95
import featureAbility from '@ohos.ability.featureAbility';
C
chenyuyan 已提交
96
import bundle from '@ohos.bundle.bundleManager';
X
xuchenghua09 已提交
97
var context = featureAbility.getContext();
D
dy_study 已提交
98 99 100 101
bundle.getBundleInfo('com.context.test', 1, (err, datainfo) =>{
    context.verifyPermission("com.example.permission", {uid:datainfo.uid}, (err, data) =>{
        console.info("verifyPermission err: " + JSON.stringify(err) + "data: " + JSON.stringify(data));
    });
ahjxliubao2's avatar
ahjxliubao2 已提交
102
});
X
xuchenghua09 已提交
103
```
C
chenyuyan 已提交
104
示例代码中出现的getBundleInfo相关描述可参考对应[文档](js-apis-bundleManager.md)
X
xuchenghua09 已提交
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

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

Z
zengyawen 已提交
123
**示例:**
X
xuchenghua09 已提交
124

M
m00512953 已提交
125
```ts
D
dy_study 已提交
126
import featureAbility from '@ohos.ability.featureAbility';
X
xuchenghua09 已提交
127
var context = featureAbility.getContext();
D
dy_study 已提交
128 129 130
context.verifyPermission("com.example.permission", (err, data) =>{
    console.info("verifyPermission err: " + JSON.stringify(err) + "data: " + JSON.stringify(data));
});
X
xuchenghua09 已提交
131 132
```

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

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

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

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

Z
zengyawen 已提交
141
**参数:**
X
xuchenghua09 已提交
142

D
merge  
donglin 已提交
143
| 参数名         | 类型                                      | 必填   | 说明       |
144 145 146
| ---------- | --------------------------------------- | ---- | -------- |
| permission | string                                  | 是    | 指定权限的名称。 |
| options    | [PermissionOptions](#permissionoptions) | 否    | 权限选项。    |
X
xuchenghua09 已提交
147

Z
zengyawen 已提交
148
**返回值:**
X
xuchenghua09 已提交
149

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

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

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



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

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

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

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

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

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

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

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


202 203 204 205 206 207 208 209 210 211
## Context.requestPermissionsFromUser<sup>7+</sup>

requestPermissionsFromUser(permissions: Array\<string>, requestCode: number): Promise\<[PermissionRequestResult](#permissionrequestresult7)>

从系统请求某些权限(promise形式)。

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

**参数:**

D
merge  
donglin 已提交
212
| 参数名           | 类型                 | 必填  | 说明                                          |
213 214 215 216 217 218 219 220 221 222 223 224
| -------------- | ------------------- | ----- | -------------------------------------------- |
| permissions    | Array\<string>      | 是    | 指示要请求的权限列表。此参数不能为null。         |
| requestCode    | number              | 是    | 指示要传递给PermissionRequestResult的请求代码。 |

**返回值:**

| 类型                                                           | 说明             |
| ------------------------------------------------------------- | ---------------- |
| Promise\<[PermissionRequestResult](#permissionrequestresult7)> | 返回授权结果信息。 |

**示例:**

M
m00512953 已提交
225
```ts
D
dy_study 已提交
226
import featureAbility from '@ohos.ability.featureAbility';
227 228 229 230 231 232 233 234
var context = featureAbility.getContext();
context.requestPermissionsFromUser(
    ["com.example.permission1",
     "com.example.permission2",
     "com.example.permission3",
     "com.example.permission4",
     "com.example.permission5"],
    1).then((data)=>{
D
dy_study 已提交
235 236 237
        console.info("requestPermissionsFromUser data: " + JSON.stringify(data));
    }
);
238 239 240
```


X
xuchenghua09 已提交
241

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

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

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

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

Z
zengyawen 已提交
250
**参数:**
X
xuchenghua09 已提交
251

D
merge  
donglin 已提交
252
| 参数名       | 类型                              | 必填   | 说明           |
253
| -------- | ------------------------------- | ---- | ------------ |
C
chenyuyan 已提交
254
| callback | AsyncCallback\<[ApplicationInfo](js-apis-bundleManager-applicationInfo.md)> | 是    | 返回当前应用程序的信息。 |
X
xuchenghua09 已提交
255

Z
zengyawen 已提交
256
**示例:**
X
xuchenghua09 已提交
257

M
m00512953 已提交
258
```ts
D
dy_study 已提交
259
import featureAbility from '@ohos.ability.featureAbility';
X
xuchenghua09 已提交
260
var context = featureAbility.getContext();
D
dy_study 已提交
261 262 263
context.getApplicationInfo((err, data) => {
    console.info("getApplicationInfo err: " + JSON.stringify(err) + "data: " + JSON.stringify(data));
});
X
xuchenghua09 已提交
264 265 266 267
```



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

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

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

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

Z
zengyawen 已提交
276
**返回值:**
X
xuchenghua09 已提交
277

278 279
| 类型                        | 说明        |
| ------------------------- | --------- |
M
m00512953 已提交
280
| Promise\<[ApplicationInfo](js-apis-bundle-ApplicationInfo.md)> | 当前应用程序的信息 |
X
xuchenghua09 已提交
281

Z
zengyawen 已提交
282
**示例:**
X
xuchenghua09 已提交
283

M
m00512953 已提交
284
```ts
D
dy_study 已提交
285
import featureAbility from '@ohos.ability.featureAbility';
X
xuchenghua09 已提交
286
var context = featureAbility.getContext();
287
context.getApplicationInfo().then((data) => {
D
dy_study 已提交
288
    console.info("getApplicationInfo data: " + JSON.stringify(data));
X
xuchenghua09 已提交
289 290 291 292 293
});
```



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

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

C
chenyuyan 已提交
298
获取当前ability的Bundle名称(callback形式)。
X
xuchenghua09 已提交
299

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

Z
zengyawen 已提交
302
**参数:**
X
xuchenghua09 已提交
303

D
merge  
donglin 已提交
304
| 参数名       | 类型                     | 必填   | 说明                 |
305
| -------- | ---------------------- | ---- | ------------------ |
C
chenyuyan 已提交
306
| callback | AsyncCallback\<string> | 是    | 返回当前ability的Bundle名称。 |
X
xuchenghua09 已提交
307

Z
zengyawen 已提交
308
**示例:**
X
xuchenghua09 已提交
309

M
m00512953 已提交
310
```ts
D
dy_study 已提交
311
import featureAbility from '@ohos.ability.featureAbility';
X
xuchenghua09 已提交
312
var context = featureAbility.getContext();
D
dy_study 已提交
313 314 315
context.getBundleName((err, data) => {
    console.info("getBundleName err: " + JSON.stringify(err) + "data: " + JSON.stringify(data));
});
X
xuchenghua09 已提交
316 317 318 319
```



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

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

C
chenyuyan 已提交
324
获取当前ability的Bundle名称(Promise形式)。
X
xuchenghua09 已提交
325

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

Z
zengyawen 已提交
328
**返回值:**
X
xuchenghua09 已提交
329

330 331
| 类型               | 说明               |
| ---------------- | ---------------- |
C
chenyuyan 已提交
332
| Promise\<string> | 当前ability的Bundle名称。 |
X
xuchenghua09 已提交
333

Z
zengyawen 已提交
334
**示例:**
X
xuchenghua09 已提交
335

M
m00512953 已提交
336
```ts
D
dy_study 已提交
337
import featureAbility from '@ohos.ability.featureAbility';
X
xuchenghua09 已提交
338
var context = featureAbility.getContext();
339
context.getBundleName().then((data) => {
D
dy_study 已提交
340
    console.info("getBundleName data: " + JSON.stringify(data));
X
xuchenghua09 已提交
341 342 343
});
```

344 345 346 347
## Context.getDisplayOrientation<sup>7+</sup>

getDisplayOrientation(callback: AsyncCallback\<bundle.DisplayOrientation>): void

C
chenyuyan 已提交
348
获取当前ability的显示方向(callback形式)。
349 350 351 352 353

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

**参数:**

D
merge  
donglin 已提交
354
| 参数名     | 类型                                                         | 必填 | 说明               |
R
RayShih 已提交
355
| -------- | ------------------------------------------------------------ | ---- | ------------------ |
C
chenyuyan 已提交
356
| callback | AsyncCallback\<[bundle.DisplayOrientation](js-apis-bundleManager.md#displayorientation)> | 是   | 表示屏幕显示方向。 |
357 358 359

**示例:**

M
m00512953 已提交
360
```ts
D
dy_study 已提交
361
import featureAbility from '@ohos.ability.featureAbility';
362
var context = featureAbility.getContext();
D
dy_study 已提交
363 364 365
context.getDisplayOrientation((err, data) => {
    console.info("getDisplayOrientation err: " + JSON.stringify(err) + "data: " + JSON.stringify(data));
});
366 367 368 369 370 371 372 373 374 375 376 377
```

## Context.getDisplayOrientation<sup>7+</sup>

getDisplayOrientation(): Promise\<bundle.DisplayOrientation>;

获取此能力的当前显示方向(Promise形式)。

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

**返回值:**

378 379
| 类型                                       | 说明        |
| ---------------------------------------- | --------- |
C
chenyuyan 已提交
380
| Promise\<[bundle.DisplayOrientation](js-apis-bundleManager.md#displayorientation)> | 表示屏幕显示方向。 |
381 382 383

**示例:**

M
m00512953 已提交
384
```ts
D
dy_study 已提交
385
import featureAbility from '@ohos.ability.featureAbility';
386 387
var context = featureAbility.getContext();
context.getDisplayOrientation().then((data) => {
D
dy_study 已提交
388
    console.info("getDisplayOrientation data: " + JSON.stringify(data));
389 390 391
});
```

Y
yuyaozhi 已提交
392 393 394 395 396 397 398 399 400 401
## Context.getExternalCacheDir

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

获取应用程序的外部缓存目录(callback形式)。

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

**参数:**

D
merge  
donglin 已提交
402
| 参数名       | 类型                     | 必填   | 说明                 |
Y
yuyaozhi 已提交
403 404 405 406 407
| -------- | ---------------------- | ---- | ------------------ |
| callback | AsyncCallback\<string> | 是    | 返回应用程序的缓存目录的绝对路径。 |

**示例:**

M
m00512953 已提交
408
```ts
D
dy_study 已提交
409
import featureAbility from '@ohos.ability.featureAbility';
Y
yuyaozhi 已提交
410
var context = featureAbility.getContext();
D
dy_study 已提交
411 412 413
context.getExternalCacheDir((err, data) => {
    console.info("getExternalCacheDir err: " + JSON.stringify(err) + "data: " + JSON.stringify(data));
});
Y
yuyaozhi 已提交
414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431
```

## Context.getExternalCacheDir

getExternalCacheDir(): Promise\<string>;

获取应用程序的外部缓存目录(Promise形式)。

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

**返回值:**

| 类型               | 说明               |
| ---------------- | ---------------- |
| Promise\<string> | 返回应用程序的缓存目录的绝对路径。 |

**示例:**

M
m00512953 已提交
432
```ts
D
dy_study 已提交
433
import featureAbility from '@ohos.ability.featureAbility';
Y
yuyaozhi 已提交
434 435
var context = featureAbility.getContext();
context.getExternalCacheDir().then((data) => {
D
dy_study 已提交
436
    console.info("getExternalCacheDir data: " + JSON.stringify(data));
Y
yuyaozhi 已提交
437 438 439
});
```

440 441 442 443 444 445 446 447 448 449
## Context.setDisplayOrientation<sup>7+</sup>

setDisplayOrientation(orientation: bundle.DisplayOrientation, callback: AsyncCallback\<void>): void

设置当前能力的显示方向(callback形式)。

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

**参数:**

D
merge  
donglin 已提交
450
| 参数名          | 类型                                       | 必填   | 说明           |
451
| ----------- | ---------------------------------------- | ---- | ------------ |
C
chenyuyan 已提交
452
| orientation | [bundle.DisplayOrientation](js-apis-bundleManager.md#displayorientation) | 是    | 指示当前能力的新方向。 |
C
chenyuyan 已提交
453
| callback    | AsyncCallback\<void> | 是    | 表示屏幕显示方向。    |
454 455 456

**示例:**

M
m00512953 已提交
457
```ts
D
dy_study 已提交
458 459
import featureAbility from '@ohos.ability.featureAbility';
import bundle from '@ohos.bundle';
460
var context = featureAbility.getContext();
C
chenyuyan 已提交
461
var orientation = bundle.DisplayOrientation.UNSPECIFIED;
C
chenyuyan 已提交
462
context.setDisplayOrientation(orientation, (err) => {
D
dy_study 已提交
463
    console.info("setDisplayOrientation err: " + JSON.stringify(err));
464 465 466 467 468 469 470 471 472 473 474 475 476
});
```

## Context.setDisplayOrientation<sup>7+</sup>

setDisplayOrientation(orientation: bundle.DisplayOrientation): Promise\<void>;

设置当前能力的显示方向(Promise形式)。

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

**返回值:**

477 478
| 类型                                       | 说明                                       |
| ---------------------------------------- | ---------------------------------------- |
C
chenyuyan 已提交
479
| orientation                              | [bundle.DisplayOrientation](js-apis-bundleManager.md#displayorientation) |
C
chenyuyan 已提交
480
| Promise\<void> | 表示屏幕显示方向。                                |
481 482 483

**示例:**

M
m00512953 已提交
484
```ts
D
dy_study 已提交
485 486
import featureAbility from '@ohos.ability.featureAbility';
import bundle from '@ohos.bundle';
487
var context = featureAbility.getContext();
C
chenyuyan 已提交
488
var orientation = bundle.DisplayOrientation.UNSPECIFIED;
489
context.setDisplayOrientation(orientation).then((data) => {
D
dy_study 已提交
490
    console.info("setDisplayOrientation data: " + JSON.stringify(data));
491 492 493 494 495 496 497 498 499 500 501 502 503
});
```

## Context.setShowOnLockScreen<sup>7+</sup>

setShowOnLockScreen(show: boolean, callback: AsyncCallback\<void>): void

设置每当显示锁屏时是否在锁屏顶部显示此功能,使该功能保持激活状态(callback形式)。

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

**参数:**

D
merge  
donglin 已提交
504
| 参数名       | 类型                   | 必填   | 说明                                       |
505 506 507
| -------- | -------------------- | ---- | ---------------------------------------- |
| show     | boolean              | 是    | 指定是否在锁屏顶部显示此功能。值true表示在锁屏上显示,值false表示不显示。 |
| callback | AsyncCallback\<void> | 是    | 返回回调结果。                                  |
508 509 510

**示例:**

M
m00512953 已提交
511
```ts
D
dy_study 已提交
512
import featureAbility from '@ohos.ability.featureAbility';
513
var context = featureAbility.getContext();
C
chenyuyan 已提交
514
var show = true;
C
chenyuyan 已提交
515
context.setShowOnLockScreen(show, (err) => {
D
dy_study 已提交
516
    console.info("setShowOnLockScreen err: " + JSON.stringify(err));
517 518 519 520 521 522 523 524 525 526 527 528 529
});
```

## Context.setShowOnLockScreen<sup>7+</sup>

setShowOnLockScreen(show: boolean): Promise\<void>;

设置每当显示锁屏时是否在锁屏顶部显示此功能,使该功能保持激活状态(Promise形式)。

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

**参数:**

D
merge  
donglin 已提交
530
| 参数名   | 类型      | 必填   | 说明                                       |
531 532
| ---- | ------- | ---- | ---------------------------------------- |
| show | boolean | 是    | 指定是否在锁屏顶部显示此功能。值true表示在锁屏上显示,值false表示不显示。 |
533 534 535

**返回值:**

536 537 538
| 类型             | 说明              |
| -------------- | --------------- |
| Promise\<void> | 使用Promise形式返回结果 |
539 540 541

**示例:**

M
m00512953 已提交
542
```ts
D
dy_study 已提交
543
import featureAbility from '@ohos.ability.featureAbility';
544
var context = featureAbility.getContext();
C
chenyuyan 已提交
545
var show = true;
546
context.setShowOnLockScreen(show).then((data) => {
D
dy_study 已提交
547
    console.info("setShowOnLockScreen data: " + JSON.stringify(data));
548 549 550 551 552 553 554
});
```

## Context.setWakeUpScreen<sup>7+</sup>

setWakeUpScreen(wakeUp: boolean, callback: AsyncCallback\<void>): void

C
chenyuyan 已提交
555
设置恢复此功能时是否唤醒屏幕(callback形式)。
556 557 558 559 560

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

**参数:**

D
merge  
donglin 已提交
561
| 参数名       | 类型                   | 必填   | 说明                                |
562 563 564
| -------- | -------------------- | ---- | --------------------------------- |
| wakeUp   | boolean              | 是    | 指定是否唤醒屏幕。值true表示唤醒它,值false表示不唤醒它。 |
| callback | AsyncCallback\<void> | 是    | 返回回调结果。                           |
565 566 567

**示例:**

M
m00512953 已提交
568
```ts
D
dy_study 已提交
569
import featureAbility from '@ohos.ability.featureAbility';
570
var context = featureAbility.getContext();
C
chenyuyan 已提交
571
var wakeUp = true;
C
chenyuyan 已提交
572
context.setWakeUpScreen(wakeUp, (err) => {
D
dy_study 已提交
573
    console.info("setWakeUpScreen err: " + JSON.stringify(err));
574 575 576 577 578 579 580
});
```

## Context.setWakeUpScreen<sup>7+</sup>

setWakeUpScreen(wakeUp: boolean): Promise\<void>; 

C
chenyuyan 已提交
581
设置恢复此功能时是否唤醒屏幕(Promise形式)。
582 583 584 585 586

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

**参数:**

D
merge  
donglin 已提交
587
| 参数名     | 类型      | 必填   | 说明                                |
588 589
| ------ | ------- | ---- | --------------------------------- |
| wakeUp | boolean | 是    | 指定是否唤醒屏幕。值true表示唤醒它,值false表示不唤醒它。 |
590 591 592

**返回值:**

593 594 595
| 类型             | 说明              |
| -------------- | --------------- |
| Promise\<void> | 使用Promise形式返回结果 |
596 597 598

**示例:**

M
m00512953 已提交
599
```ts
D
dy_study 已提交
600
import featureAbility from '@ohos.ability.featureAbility';
601
var context = featureAbility.getContext();
C
chenyuyan 已提交
602
var wakeUp = true;
603
context.setWakeUpScreen(wakeUp).then((data) => {
D
dy_study 已提交
604
    console.info("setWakeUpScreen data: " + JSON.stringify(data));
605 606 607 608
});
```


X
xuchenghua09 已提交
609 610


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

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

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

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

Z
zengyawen 已提交
619
**参数:**
X
xuchenghua09 已提交
620

D
merge  
donglin 已提交
621
| 参数名       | 类型                          | 必填   | 说明         |
622
| -------- | --------------------------- | ---- | ---------- |
M
m00512953 已提交
623
| callback | AsyncCallback\<[ProcessInfo](js-apis-inner-app-processInfo.md)> | 是    | 返回当前进程的信息。 |
X
xuchenghua09 已提交
624

Z
zengyawen 已提交
625
**示例:**
X
xuchenghua09 已提交
626

M
m00512953 已提交
627
```ts
D
dy_study 已提交
628
import featureAbility from '@ohos.ability.featureAbility';
X
xuchenghua09 已提交
629
var context = featureAbility.getContext();
D
dy_study 已提交
630 631 632
context.getProcessInfo((err, data) => {
    console.info("getProcessInfo err: " + JSON.stringify(err) + "data: " + JSON.stringify(data));
});
X
xuchenghua09 已提交
633 634 635 636
```



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

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

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

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

Z
zengyawen 已提交
645
**返回值:**
X
xuchenghua09 已提交
646

647 648
| 类型                    | 说明      |
| --------------------- | ------- |
M
m00512953 已提交
649
| Promise\<[ProcessInfo](js-apis-inner-app-processInfo.md)> | 当前进程的信息 |
X
xuchenghua09 已提交
650

Z
zengyawen 已提交
651
**示例:**
X
xuchenghua09 已提交
652

M
m00512953 已提交
653
```ts
D
dy_study 已提交
654
import featureAbility from '@ohos.ability.featureAbility';
X
xuchenghua09 已提交
655
var context = featureAbility.getContext();
656
context.getProcessInfo().then((data) => {
D
dy_study 已提交
657
    console.info("getProcessInfo data: " + JSON.stringify(data));
X
xuchenghua09 已提交
658 659 660 661 662
});
```



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

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

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

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

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

Z
zengyawen 已提交
673
**参数:**
X
xuchenghua09 已提交
674

D
merge  
donglin 已提交
675
| 参数名       | 类型                          | 必填   | 说明                                     |
676
| -------- | --------------------------- | ---- | -------------------------------------- |
C
chenyuyan 已提交
677
| callback | AsyncCallback\<[ElementName](js-apis-bundleManager-elementName.md)> | 是    | 返回当前ability的ohos.bundle.ElementName对象。 |
X
xuchenghua09 已提交
678

Z
zengyawen 已提交
679
**示例:**
X
xuchenghua09 已提交
680

M
m00512953 已提交
681
```ts
D
dy_study 已提交
682
import featureAbility from '@ohos.ability.featureAbility';
X
xuchenghua09 已提交
683
var context = featureAbility.getContext();
D
dy_study 已提交
684 685 686
context.getElementName((err, data) => {
    console.info("getElementName err: " + JSON.stringify(err) + "data: " + JSON.stringify(data));
});
X
xuchenghua09 已提交
687 688 689 690
```



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

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

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

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

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

Z
zengyawen 已提交
701
**返回值:**
X
xuchenghua09 已提交
702

703 704
| 类型                    | 说明                                   |
| --------------------- | ------------------------------------ |
C
chenyuyan 已提交
705
| Promise\<[ElementName](js-apis-bundleManager-elementName.md)> | 当前ability的ohos.bundle.ElementName对象。 |
X
xuchenghua09 已提交
706

Z
zengyawen 已提交
707
**示例:**
X
xuchenghua09 已提交
708

M
m00512953 已提交
709
```ts
D
dy_study 已提交
710
import featureAbility from '@ohos.ability.featureAbility';
X
xuchenghua09 已提交
711
var context = featureAbility.getContext();
712
context.getElementName().then((data) => {
D
dy_study 已提交
713
    console.info("getElementName data: " + JSON.stringify(data));
X
xuchenghua09 已提交
714 715 716
});
```

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

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

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

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

Y
yuyaozhi 已提交
725
**参数:**
ahjxliubao2's avatar
ahjxliubao2 已提交
726

D
merge  
donglin 已提交
727
| 参数名       | 类型                     | 必填   | 说明         |
728 729
| -------- | ---------------------- | ---- | ---------- |
| callback | AsyncCallback\<string> | 是    | 返回当前进程的名称。 |
X
xuchenghua09 已提交
730

Z
zengyawen 已提交
731
**示例:**
X
xuchenghua09 已提交
732

M
m00512953 已提交
733
```ts
D
dy_study 已提交
734
import featureAbility from '@ohos.ability.featureAbility';
X
xuchenghua09 已提交
735
var context = featureAbility.getContext();
D
dy_study 已提交
736 737 738
context.getProcessName((err, data) => {
    console.info("getProcessName err: " + JSON.stringify(err) + "data: " + JSON.stringify(data));
});
X
xuchenghua09 已提交
739 740 741 742
```



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

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

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

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

Z
zengyawen 已提交
751
**返回值:**
X
xuchenghua09 已提交
752

753 754
| 类型               | 说明         |
| ---------------- | ---------- |
Z
zengyawen 已提交
755
| Promise\<string> | 返回当前进程的名称。 |
X
xuchenghua09 已提交
756

Z
zengyawen 已提交
757
**示例:**
X
xuchenghua09 已提交
758

M
m00512953 已提交
759
```ts
D
dy_study 已提交
760
import featureAbility from '@ohos.ability.featureAbility';
X
xuchenghua09 已提交
761
var context = featureAbility.getContext();
762
context.getProcessName().then((data) => {
D
dy_study 已提交
763
    console.info("getProcessName data: " + JSON.stringify(data));
X
xuchenghua09 已提交
764 765 766 767 768
});
```



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

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

C
chenyuyan 已提交
773
获取ability调用方的Bundle名称(callback形式)。
X
xuchenghua09 已提交
774

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

Z
zengyawen 已提交
777
**参数:**
X
xuchenghua09 已提交
778

D
merge  
donglin 已提交
779
| 参数名       | 类型                     | 必填   | 说明               |
780
| -------- | ---------------------- | ---- | ---------------- |
C
chenyuyan 已提交
781
| callback | AsyncCallback\<string> | 是    | 返回ability调用方的Bundle名称。 |
X
xuchenghua09 已提交
782

Z
zengyawen 已提交
783
**示例:**
X
xuchenghua09 已提交
784

M
m00512953 已提交
785
```ts
D
dy_study 已提交
786
import featureAbility from '@ohos.ability.featureAbility';
X
xuchenghua09 已提交
787
var context = featureAbility.getContext();
D
dy_study 已提交
788 789 790
context.getCallingBundle((err, data) => {
    console.info("getCallingBundle err: " + JSON.stringify(err) + "data: " + JSON.stringify(data));
});
X
xuchenghua09 已提交
791 792 793 794
```



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

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

C
chenyuyan 已提交
799
获取ability调用方的Bundle名称(Promise形式)。
X
xuchenghua09 已提交
800

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

Z
zengyawen 已提交
803
**返回值:**
X
xuchenghua09 已提交
804

805 806
| 类型               | 说明             |
| ---------------- | -------------- |
C
chenyuyan 已提交
807
| Promise\<string> | 返回ability调用方的Bundle名称。 |
X
xuchenghua09 已提交
808

Z
zengyawen 已提交
809
**示例:**
X
xuchenghua09 已提交
810

M
m00512953 已提交
811
```ts
D
dy_study 已提交
812
import featureAbility from '@ohos.ability.featureAbility';
X
xuchenghua09 已提交
813
var context = featureAbility.getContext();
814
context.getCallingBundle().then((data) => {
D
dy_study 已提交
815
    console.info("getCallingBundle data: " + JSON.stringify(data));
X
xuchenghua09 已提交
816 817 818
});
```

X
xuzhihao 已提交
819
## Context.getCacheDir
D
dy 已提交
820 821 822 823 824 825 826 827 828

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

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

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

**参数:**

D
merge  
donglin 已提交
829
| 参数名       | 类型                     | 必填   | 说明              |
830 831
| -------- | ---------------------- | ---- | --------------- |
| callback | AsyncCallback\<string> | 是    | 返回该应用程序的内部存储目录。 |
D
dy 已提交
832 833 834

**示例:**

M
m00512953 已提交
835
```ts
D
dy_study 已提交
836
import featureAbility from '@ohos.ability.featureAbility';
Z
zhongjianfei 已提交
837
var context = featureAbility.getContext();
D
dy 已提交
838
context.getCacheDir((err, data) => {
D
dy_study 已提交
839
    console.info("getCacheDir err: " + JSON.stringify(err) + "data: " + JSON.stringify(data));
D
dy 已提交
840 841 842
});
```

X
xuzhihao 已提交
843
## Context.getCacheDir
D
dy 已提交
844 845 846 847 848 849 850 851 852

getCacheDir(): Promise\<string>

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

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

**返回值:**

853 854
| 类型               | 说明              |
| ---------------- | --------------- |
C
chenyuyan 已提交
855
| Promise\<string> | 返回该应用程序的内部存储目录。 |
D
dy 已提交
856 857 858

**示例:**

M
m00512953 已提交
859
```ts
D
dy_study 已提交
860
import featureAbility from '@ohos.ability.featureAbility';
D
dy 已提交
861 862
var context = featureAbility.getContext();
context.getCacheDir().then((data) => {
D
dy_study 已提交
863
    console.info("getCacheDir data: " + JSON.stringify(data));
D
dy 已提交
864 865 866
});
```

X
xuzhihao 已提交
867
## Context.getFilesDir
D
dy 已提交
868 869 870 871 872 873 874 875 876

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

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

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

**参数:**

D
merge  
donglin 已提交
877
| 参数名       | 类型                     | 必填   | 说明                  |
878 879
| -------- | ---------------------- | ---- | ------------------- |
| callback | AsyncCallback\<string> | 是    | 返回内部存储器上此应用程序的文件目录。 |
D
dy 已提交
880 881 882

**示例:**

M
m00512953 已提交
883
```ts
D
dy_study 已提交
884
import featureAbility from '@ohos.ability.featureAbility';
Z
zhongjianfei 已提交
885
var context = featureAbility.getContext();
D
dy 已提交
886
context.getFilesDir((err, data) => {
D
dy_study 已提交
887
    console.info("getFilesDir err: " + JSON.stringify(err) + "data: " + JSON.stringify(data));
D
dy 已提交
888 889 890
});
```

X
xuzhihao 已提交
891
## Context.getFilesDir
D
dy 已提交
892 893 894 895 896 897 898 899 900

getFilesDir(): Promise\<string>

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

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

**返回值:**

901 902
| 类型               | 说明                  |
| ---------------- | ------------------- |
D
dy 已提交
903 904 905 906
| Promise\<string> | 返回内部存储器上此应用程序的文件目录。 |

**示例:**

M
m00512953 已提交
907
```ts
D
dy_study 已提交
908
import featureAbility from '@ohos.ability.featureAbility';
D
dy 已提交
909 910
var context = featureAbility.getContext();
context.getFilesDir().then((data) => {
D
dy_study 已提交
911
    console.info("getFilesDir data: " + JSON.stringify(data));
D
dy 已提交
912 913 914
});
```

X
xuzhihao 已提交
915
## Context.getOrCreateDistributedDir<sup>7+</sup>
D
dy 已提交
916 917 918 919 920 921 922 923 924 925 926

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

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

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

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

**参数:**

D
merge  
donglin 已提交
927
| 参数名       | 类型                     | 必填   | 说明                                       |
928
| -------- | ---------------------- | ---- | ---------------------------------------- |
C
chenyuyan 已提交
929
| callback | AsyncCallback\<string> | 是    | 返回Ability或应用的分布式文件路径。<br>若路径不存在,系统将创建一个路径并返回创建的路径。 |
D
dy 已提交
930 931 932

**示例:**

M
m00512953 已提交
933
```ts
D
dy_study 已提交
934
import featureAbility from '@ohos.ability.featureAbility';
D
dy 已提交
935 936
var context = featureAbility.getContext();
context.getOrCreateDistributedDir((err, data) => {
D
dy_study 已提交
937
    console.info("getOrCreateDistributedDir err: " + JSON.stringify(err) + "data: " + JSON.stringify(data));
D
dy 已提交
938 939 940
});
```

X
xuzhihao 已提交
941
## Context.getOrCreateDistributedDir<sup>7+</sup>
D
dy 已提交
942 943 944 945 946 947 948 949 950 951 952

getOrCreateDistributedDir(): Promise\<string>

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

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

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

**返回值:**

953 954
| 类型               | 说明                                  |
| ---------------- | ----------------------------------- |
C
chenyuyan 已提交
955
| Promise\<string> | 返回Ability或应用的分布式文件路径。若为首次调用,则将创建目录。 |
D
dy 已提交
956 957 958

**示例:**

M
m00512953 已提交
959
```ts
D
dy_study 已提交
960
import featureAbility from '@ohos.ability.featureAbility';
D
dy 已提交
961 962
var context = featureAbility.getContext();
context.getOrCreateDistributedDir().then((data) => {
D
dy_study 已提交
963
    console.info("getOrCreateDistributedDir data: " + JSON.stringify(data));
D
dy 已提交
964 965 966
});
```

X
xuzhihao 已提交
967
## Context.getAppType<sup>7+</sup>
D
dy 已提交
968 969 970 971 972 973 974 975 976

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

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

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

**参数:**

D
merge  
donglin 已提交
977
| 参数名       | 类型                     | 必填   | 说明                               |
978
| -------- | ---------------------- | ---- | -------------------------------- |
C
chenyuyan 已提交
979
| callback | AsyncCallback\<string> | 是    | 返回此应用程序的类型。 |
D
dy 已提交
980 981 982

**示例:**

M
m00512953 已提交
983
```ts
D
dy_study 已提交
984
import featureAbility from '@ohos.ability.featureAbility';
D
dy 已提交
985 986
var context = featureAbility.getContext();
context.getAppType((err, data) => {
D
dy_study 已提交
987
    console.info("getAppType err: " + JSON.stringify(err) + "data: " + JSON.stringify(data));
D
dy 已提交
988 989 990
});
```

X
xuzhihao 已提交
991
## Context.getAppType<sup>7+</sup>
D
dy 已提交
992 993 994 995 996 997 998 999 1000

getAppType(): Promise\<string>

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

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

**返回值:**

1001 1002
| 类型               | 说明                 |
| ---------------- | ------------------ |
C
chenyuyan 已提交
1003
| Promise\<string> | 返回此应用的类型。 |
D
dy 已提交
1004 1005 1006

**示例:**

M
m00512953 已提交
1007
```ts
D
dy_study 已提交
1008
import featureAbility from '@ohos.ability.featureAbility';
D
dy 已提交
1009 1010
var context = featureAbility.getContext();
context.getAppType().then((data) => {
D
dy_study 已提交
1011
    console.info("getAppType data: " + JSON.stringify(data));
D
dy 已提交
1012 1013 1014
});
```

X
xuzhihao 已提交
1015
## Context.getHapModuleInfo<sup>7+</sup>
D
dy 已提交
1016 1017 1018 1019 1020 1021 1022 1023 1024

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

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

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

**参数:**

D
merge  
donglin 已提交
1025
| 参数名       | 类型                                       | 必填   | 说明                                      |
1026
| -------- | ---------------------------------------- | ---- | --------------------------------------- |
C
chenyuyan 已提交
1027
| callback | AsyncCallback\<[HapModuleInfo](js-apis-bundleManager-hapModuleInfo.md)> | 是    | 返回应用的ModuleInfo对象。 |
D
dy 已提交
1028 1029 1030

**示例:**

M
m00512953 已提交
1031
```ts
D
dy_study 已提交
1032
import featureAbility from '@ohos.ability.featureAbility';
D
dy 已提交
1033 1034
var context = featureAbility.getContext();
context.getHapModuleInfo((err, data) => {
D
dy_study 已提交
1035
    console.info("getHapModuleInfo err: " + JSON.stringify(err) + "data: " + JSON.stringify(data));
D
dy 已提交
1036 1037 1038
});
```

X
xuzhihao 已提交
1039
## Context.getHapModuleInfo<sup>7+</sup>
D
dy 已提交
1040 1041 1042 1043 1044 1045 1046 1047 1048

getHapModuleInfo(): Promise\<HapModuleInfo>

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

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

**返回值:**

1049 1050
| 类型                                       | 说明                 |
| ---------------------------------------- | ------------------ |
C
chenyuyan 已提交
1051
| Promise\<[HapModuleInfo](js-apis-bundleManager-hapModuleInfo.md)> | 返回应用的ModuleInfo对象。 |
D
dy 已提交
1052 1053 1054

**示例:**

M
m00512953 已提交
1055
```ts
D
dy_study 已提交
1056
import featureAbility from '@ohos.ability.featureAbility';
D
dy 已提交
1057 1058
var context = featureAbility.getContext();
context.getHapModuleInfo().then((data) => {
D
dy_study 已提交
1059
    console.info("getHapModuleInfo data: " + JSON.stringify(data));
D
dy 已提交
1060 1061 1062
});
```

X
xuzhihao 已提交
1063
## Context.getAppVersionInfo<sup>7+</sup>
D
dy 已提交
1064

1065
getAppVersionInfo(callback: AsyncCallback\<AppVersionInfo>): void
D
dy 已提交
1066 1067 1068 1069 1070 1071 1072

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

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

**参数:**

D
merge  
donglin 已提交
1073
| 参数名       | 类型                                       | 必填   | 说明                             |
1074
| -------- | ---------------------------------------- | ---- | ------------------------------ |
C
chenyuyan 已提交
1075
| callback | AsyncCallback\<[AppVersionInfo](js-apis-inner-app-appVersionInfo.md)> | 是    | 返回应用版本信息。 |
D
dy 已提交
1076 1077 1078

**示例:**

M
m00512953 已提交
1079
```ts
D
dy_study 已提交
1080
import featureAbility from '@ohos.ability.featureAbility';
D
dy 已提交
1081 1082
var context = featureAbility.getContext();
context.getAppVersionInfo((err, data) => {
D
dy_study 已提交
1083
    console.info("getAppVersionInfo err: " + JSON.stringify(err) + "data: " + JSON.stringify(data));
D
dy 已提交
1084 1085 1086
});
```

X
xuzhihao 已提交
1087
## Context.getAppVersionInfo<sup>7+</sup>
D
dy 已提交
1088 1089 1090 1091 1092 1093 1094 1095 1096

getAppVersionInfo(): Promise\<AppVersionInfo>

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

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

**返回值:**

1097 1098
| 类型                                       | 说明        |
| ---------------------------------------- | --------- |
M
m00512953 已提交
1099
| Promise\<[AppVersionInfo](js-apis-inner-app-appVersionInfo.md)> | 返回应用版本信息。 |
D
dy 已提交
1100 1101 1102

**示例:**

M
m00512953 已提交
1103
```ts
D
dy_study 已提交
1104
import featureAbility from '@ohos.ability.featureAbility';
D
dy 已提交
1105 1106
var context = featureAbility.getContext();
context.getAppVersionInfo().then((data) => {
D
dy_study 已提交
1107
    console.info("getAppVersionInfo data: " + JSON.stringify(data));
D
dy 已提交
1108 1109 1110
});
```

X
xuzhihao 已提交
1111
## Context.getAbilityInfo<sup>7+</sup>
D
dy 已提交
1112 1113 1114 1115 1116 1117 1118 1119 1120

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

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

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

**参数:**

D
merge  
donglin 已提交
1121
| 参数名       | 类型                                       | 必填   | 说明                                      |
1122
| -------- | ---------------------------------------- | ---- | --------------------------------------- |
C
chenyuyan 已提交
1123
| callback | AsyncCallback\<[AbilityInfo](js-apis-bundleManager-abilityInfo.md)> | 是    | 返回当前归属Ability详细信息。 |
D
dy 已提交
1124 1125 1126

**示例:**

M
m00512953 已提交
1127
```ts
D
dy_study 已提交
1128
import featureAbility from '@ohos.ability.featureAbility';
D
dy 已提交
1129 1130
var context = featureAbility.getContext();
context.getAbilityInfo((err, data) => {
D
dy_study 已提交
1131
    console.info("getAbilityInfo err: " + JSON.stringify(err) + "data: " + JSON.stringify(data));
D
dy 已提交
1132 1133 1134
});
```

X
xuzhihao 已提交
1135
## Context.getAbilityInfo<sup>7+</sup>
D
dy 已提交
1136 1137 1138 1139 1140 1141 1142 1143 1144

getAbilityInfo(): Promise\<AbilityInfo>

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

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

**返回值:**

1145 1146
| 类型                                       | 说明                 |
| ---------------------------------------- | ------------------ |
C
chenyuyan 已提交
1147
| Promise\<[AbilityInfo](js-apis-bundleManager-abilityInfo.md)> | 返回当前归属Ability详细信息。 |
D
dy 已提交
1148 1149 1150

**示例:**

M
m00512953 已提交
1151
```ts
D
dy_study 已提交
1152
import featureAbility from '@ohos.ability.featureAbility';
D
dy 已提交
1153 1154
var context = featureAbility.getContext();
context.getAbilityInfo().then((data) => {
D
dy_study 已提交
1155
    console.info("getAbilityInfo data: " + JSON.stringify(data));
D
dy 已提交
1156 1157 1158
});
```

X
xuzhihao 已提交
1159
## Context.getApplicationContext<sup>7+</sup>
D
dy 已提交
1160 1161 1162 1163 1164 1165 1166 1167 1168

getApplicationContext(): Context

获取应用上下文信息。

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

**返回值:**

1169 1170 1171
| 类型      | 说明         |
| ------- | ---------- |
| Context | 返回应用上下文信息。 |
D
dy 已提交
1172 1173 1174

**示例:**

M
m00512953 已提交
1175
```ts
D
dy_study 已提交
1176
import featureAbility from '@ohos.ability.featureAbility';
D
dy 已提交
1177 1178 1179
var context = featureAbility.getContext().getApplicationContext();
```

1180 1181 1182 1183 1184 1185 1186 1187 1188 1189
## Context.isUpdatingConfigurations<sup>7+</sup>

isUpdatingConfigurations(callback: AsyncCallback\<boolean>): void;

检查此能力的配置是否正在更改(callback形式)。

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

**参数:**

D
merge  
donglin 已提交
1190
| 参数名       | 类型                      | 必填   | 说明                            |
1191 1192
| -------- | ----------------------- | ---- | ----------------------------- |
| callback | AsyncCallback\<boolean> | 是    | 如果该能力的配置正在更改,则为true,否则为false。 |
1193 1194 1195

**示例:**

M
m00512953 已提交
1196
```ts
D
dy_study 已提交
1197
import featureAbility from '@ohos.ability.featureAbility';
1198 1199
var context = featureAbility.getContext();
context.isUpdatingConfigurations((err, data) => {
D
dy_study 已提交
1200
    console.info("isUpdatingConfigurations err: " + JSON.stringify(err) + "data: " + JSON.stringify(data));
1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213
});
```

## Context.isUpdatingConfigurations<sup>7+</sup>

isUpdatingConfigurations(): Promise\<boolean>;

检查此能力的配置是否正在更改(Promise形式)。

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

**返回值:**

1214 1215 1216
| 类型                | 说明                            |
| ----------------- | ----------------------------- |
| Promise\<boolean> | 如果该能力的配置正在更改,则为true,否则为false。 |
1217 1218 1219

**示例:**

M
m00512953 已提交
1220
```ts
D
dy_study 已提交
1221
import featureAbility from '@ohos.ability.featureAbility';
1222 1223
var context = featureAbility.getContext();
context.isUpdatingConfigurations().then((data) => {
D
dy_study 已提交
1224
    console.info("isUpdatingConfigurations data: " + JSON.stringify(data));
1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237
});
```

## Context.printDrawnCompleted<sup>7+</sup>

printDrawnCompleted(callback: AsyncCallback\<void>): void;

通知系统绘制此页面功能所需的时间(callback形式)。

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

**参数:**

D
merge  
donglin 已提交
1238
| 参数名       | 类型                   | 必填   | 说明          |
1239 1240
| -------- | -------------------- | ---- | ----------- |
| callback | AsyncCallback\<void> | 是    | 表示被指定的回调方法。 |
1241 1242 1243

**示例:**

M
m00512953 已提交
1244
```ts
D
dy_study 已提交
1245
import featureAbility from '@ohos.ability.featureAbility';
1246
var context = featureAbility.getContext();
C
chenyuyan 已提交
1247
context.printDrawnCompleted((err) => {
D
dy_study 已提交
1248
    console.error('printDrawnCompleted err: ' + JSON.stringify(err));
1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261
});
```

## Context.printDrawnCompleted<sup>7+</sup>

printDrawnCompleted(): Promise\<void>;

通知系统绘制此页面功能所需的时间(Promise形式)。

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

**返回值:**

1262 1263 1264
| 类型             | 说明              |
| -------------- | --------------- |
| Promise\<void> | 以Promise形式返回结果。 |
1265 1266 1267

**示例:**

M
m00512953 已提交
1268
```ts
D
dy_study 已提交
1269
import featureAbility from '@ohos.ability.featureAbility';
1270 1271
var context = featureAbility.getContext();
context.printDrawnCompleted().then((data) => {
D
dy_study 已提交
1272
    console.info("printDrawnCompleted data: " + JSON.stringify(data));
1273 1274 1275 1276
});
```


X
xuzhihao 已提交
1277
## PermissionOptions<sup>7+</sup>
Z
zengyawen 已提交
1278

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

D
merge  
donglin 已提交
1281
| 名称   | 读写属性 | 类型     | 必填   | 说明    |
M
m00512953 已提交
1282 1283 1284
| ---- | ---- | ------ | ---- | ----- |
| pid  | 只读   | number | 否    | 进程id。 |
| uid  | 只读   | number | 否    | 用户id。 |
Z
zengyawen 已提交
1285

X
xuzhihao 已提交
1286
## PermissionRequestResult<sup>7+</sup>
Z
zengyawen 已提交
1287

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

D
merge  
donglin 已提交
1290
| 名称          | 读写属性 | 类型             | 必填   | 说明         |
M
m00512953 已提交
1291 1292 1293 1294
| ----------- | ---- | -------------- | ---- | ---------- |
| requestCode | 只读   | number         | 是    | 用户传入的请求代码。 |
| permissions | 只读   | Array\<string> | 是    | 用户传入的权限。   |
| authResults | 只读   | Array\<number> | 是    | 请求权限的结果。   |
D
dy 已提交
1295

X
xuzhihao 已提交
1296
## AppVersionInfo<sup>7+</sup>
D
dy 已提交
1297

1298 1299
**系统能力**:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core

1300 1301 1302 1303
| 名称          | 类型     | 可读   | 可写   | 说明      |
| ----------- | ------ | ---- | ---- | ------- |
| appName     | string | 是    | 否    | 模块名称。   |
| versionCode | number | 是    | 否    | 模块描述信息。 |
M
m00512953 已提交
1304
| versionName | string | 是    | 否    | 描述信息ID。 |