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

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

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

10 11
## 使用说明

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

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 96
import featureAbility from '@ohos.ability.featureAbility';
import bundle from '@ohos.bundle';
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 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

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

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

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

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

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

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

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

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

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

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

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

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

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



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

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

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

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

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

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

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

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


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

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

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

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

**参数:**

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

**返回值:**

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

**示例:**

M
m00512953 已提交
224
```ts
D
dy_study 已提交
225
import featureAbility from '@ohos.ability.featureAbility';
226 227 228 229 230 231 232 233
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 已提交
234 235 236
        console.info("requestPermissionsFromUser data: " + JSON.stringify(data));
    }
);
237 238 239
```


X
xuchenghua09 已提交
240

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

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

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

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

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

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

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

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



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

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

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

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

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

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

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

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



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

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

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

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

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

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

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

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



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

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

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

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

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

329 330
| 类型               | 说明               |
| ---------------- | ---------------- |
Z
zengyawen 已提交
331
| Promise\<string> | 当前ability的捆绑包名称。 |
X
xuchenghua09 已提交
332

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

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

343 344 345 346 347 348 349 350 351 352
## Context.getDisplayOrientation<sup>7+</sup>

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

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

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

**参数:**

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

**示例:**

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

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

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

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

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

**返回值:**

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

**示例:**

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

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

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

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

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

**参数:**

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

**示例:**

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

## Context.getExternalCacheDir

getExternalCacheDir(): Promise\<string>;

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

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

**返回值:**

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

**示例:**

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

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

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

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

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

**参数:**

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

**示例:**

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

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

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

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

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

**返回值:**

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

**示例:**

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

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

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

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

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

**参数:**

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

**示例:**

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

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

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

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

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

**参数:**

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

**返回值:**

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

**示例:**

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

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

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

设置恢复此功能时是否唤醒屏幕。(callback形式)。

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

**参数:**

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

**示例:**

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

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

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

设置恢复此功能时是否唤醒屏幕。(Promise形式)。

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

**参数:**

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

**返回值:**

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

**示例:**

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


X
xuchenghua09 已提交
608 609


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

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

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

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

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

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

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

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



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

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

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

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

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

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

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

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



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

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

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

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

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

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

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

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

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



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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



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

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

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

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

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

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

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

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



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

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

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

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

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

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

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

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



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

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

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

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

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

804 805
| 类型               | 说明             |
| ---------------- | -------------- |
806
| Promise\<string> | 调用ability的包名称。 |
X
xuchenghua09 已提交
807

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

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

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

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

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

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

**参数:**

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

**示例:**

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

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

getCacheDir(): Promise\<string>

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

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

**返回值:**

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

**示例:**

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

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

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

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

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

**参数:**

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

**示例:**

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

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

getFilesDir(): Promise\<string>

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

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

**返回值:**

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

**示例:**

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

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

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

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

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

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

**参数:**

D
merge  
donglin 已提交
926
| 参数名       | 类型                     | 必填   | 说明                                       |
927 928
| -------- | ---------------------- | ---- | ---------------------------------------- |
| callback | AsyncCallback\<string> | 是    | 回调函数,可以在回调函数中处理接口返回值,返回Ability或应用的分布式文件路径。如果分布式文件路径不存在,系统将创建一个路径并返回创建的路径。 |
D
dy 已提交
929 930 931

**示例:**

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

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

getOrCreateDistributedDir(): Promise\<string>

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

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

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

**返回值:**

952 953
| 类型               | 说明                                  |
| ---------------- | ----------------------------------- |
D
dy 已提交
954 955 956 957
| Promise\<string> | Ability或应用的分布式文件路径。如果是第一次调用,则将创建目录。 |

**示例:**

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

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

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

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

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

**参数:**

D
merge  
donglin 已提交
976
| 参数名       | 类型                     | 必填   | 说明                               |
977 978
| -------- | ---------------------- | ---- | -------------------------------- |
| callback | AsyncCallback\<string> | 是    | 回调函数,可以在回调函数中处理接口返回值,返回此应用程序的类型。 |
D
dy 已提交
979 980 981

**示例:**

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

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

getAppType(): Promise\<string>

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

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

**返回值:**

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

**示例:**

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

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

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

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

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

**参数:**

D
merge  
donglin 已提交
1024
| 参数名       | 类型                                       | 必填   | 说明                                      |
1025 1026
| -------- | ---------------------------------------- | ---- | --------------------------------------- |
| callback | AsyncCallback\<[HapModuleInfo](js-apis-bundle-HapModuleInfo.md)> | 是    | 回调函数,可以在回调函数中处理接口返回值,返回应用的ModuleInfo对象。 |
D
dy 已提交
1027 1028 1029

**示例:**

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

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

getHapModuleInfo(): Promise\<HapModuleInfo>

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

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

**返回值:**

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

**示例:**

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

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

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

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

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

**参数:**

D
merge  
donglin 已提交
1072
| 参数名       | 类型                                       | 必填   | 说明                             |
1073
| -------- | ---------------------------------------- | ---- | ------------------------------ |
M
m00512953 已提交
1074
| callback | AsyncCallback\<[AppVersionInfo](js-apis-inner-app-appVersionInfo.md)> | 是    | 回调函数,可以在回调函数中处理接口返回值,返回应用版本信息。 |
D
dy 已提交
1075 1076 1077

**示例:**

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

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

getAppVersionInfo(): Promise\<AppVersionInfo>

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

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

**返回值:**

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

**示例:**

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

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

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

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

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

**参数:**

D
merge  
donglin 已提交
1120
| 参数名       | 类型                                       | 必填   | 说明                                      |
1121 1122
| -------- | ---------------------------------------- | ---- | --------------------------------------- |
| callback | AsyncCallback\<[AbilityInfo](js-apis-bundle-AbilityInfo.md)> | 是    | 回调函数,可以在回调函数中处理接口返回值,返回当前归属Ability详细信息。 |
D
dy 已提交
1123 1124 1125

**示例:**

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

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

getAbilityInfo(): Promise\<AbilityInfo>

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

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

**返回值:**

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

**示例:**

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

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

getApplicationContext(): Context

获取应用上下文信息。

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

**返回值:**

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

**示例:**

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

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

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

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

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

**参数:**

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

**示例:**

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

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

isUpdatingConfigurations(): Promise\<boolean>;

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

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

**返回值:**

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

**示例:**

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

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

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

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

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

**参数:**

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

**示例:**

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

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

printDrawnCompleted(): Promise\<void>;

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

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

**返回值:**

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

**示例:**

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


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

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

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

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

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

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

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

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

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