• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Context模块(JS端SDK接口)
2
3#### 支持设备
4
5| API                                                          | 手机 | 平板 | 智慧屏 | 智能穿戴 | 轻量级智能穿戴 | 智慧视觉设备 |
6| ------------------------------------------------------------ | ---- | ---- | ------ | -------- | -------------- | ------------ |
7| Context.getOrCreateLocalDir(callback: AsyncCallback\<string>) | 支持 | 支持 | 支持   | 支持     | 不支持         | 不支持       |
8| Context.getOrCreateLocalDir()                                | 支持 | 支持 | 支持   | 支持     | 不支持         | 不支持       |
9| Context.verifyPermission(permission: string, options: PermissionOptions, callback: AsyncCallback\<number>) | 支持 | 支持 | 支持   | 支持     | 不支持         | 不支持       |
10| Context.verifyPermission(permission: string, callback: AsyncCallback\<number>) | 支持 | 支持 | 支持   | 支持     | 不支持         | 不支持       |
11| Context.verifyPermission(permission: string, options?: PermissionOptions) | 支持 | 支持 | 支持   | 支持     | 不支持         | 不支持       |
12| Context.requestPermissionsFromUser(permissions: Array\<string>, requestCode: number, resultCallback: AsyncCallback\<PermissionRequestResult>) | 支持 | 支持 | 支持   | 支持     | 不支持         | 不支持       |
13| Context.getApplicationInfo(callback: AsyncCallback\<ApplicationInfo>) | 支持 | 支持 | 支持   | 支持     | 不支持         | 不支持       |
14| Context.getApplicationInfo()                                 | 支持 | 支持 | 支持   | 支持     | 不支持         | 不支持       |
15| Context.getBundleName(callback: AsyncCallback\<string>)      | 支持 | 支持 | 支持   | 支持     | 不支持         | 不支持       |
16| Context.getBundleName()                                      | 支持 | 支持 | 支持   | 支持     | 不支持         | 不支持       |
17| Context.getProcessInfo(callback: AsyncCallback\<ProcessInfo>) | 支持 | 支持 | 支持   | 支持     | 不支持         | 不支持       |
18| Context.getProcessInfo()                                     | 支持 | 支持 | 支持   | 支持     | 不支持         | 不支持       |
19| Context.getElementName(callback: AsyncCallback\<ElementName>) | 支持 | 支持 | 支持   | 支持     | 不支持         | 不支持       |
20| Context.getElementName()                                     | 支持 | 支持 | 支持   | 支持     | 不支持         | 不支持       |
21| Context.getProcessName(callback: AsyncCallback\<string>)     | 支持 | 支持 | 支持   | 支持     | 不支持         | 不支持       |
22| Context.getProcessName()                                     | 支持 | 支持 | 支持   | 支持     | 不支持         | 不支持       |
23| Context.getCallingBundle(callback: AsyncCallback\<string>)   | 支持 | 支持 | 支持   | 支持     | 不支持         | 不支持       |
24| Context.getCallingBundle()                                   | 支持 | 支持 | 支持   | 支持     | 不支持         | 不支持       |
25
26#### 权限列表
27
28**ohos.permission.RUNNING_LOCK permission**
29
30#### 导入模块
31
32```
33import featureAbility from '@ohos.ability.featureAbility'
34import bundle from '@ohos.bundle'
35```
36
37#### Context.getOrCreateLocalDir(callback: AsyncCallback\<string>)
38
39- 接口说明
40
41  获取应用程序的本地根目录。如果是第一次调用,将创建目录(callback形式)
42
43- getOrCreateLocalDir参数描述
44
45
46| 名称     | 读写属性 | 类型                    | 必填 | 描述             |
47| -------- | -------- | ----------------------- | ---- | ---------------- |
48| callback | 只读     | AsyncCallback\<string>) | 是   | 被指定的回调方法 |
49
50- 返回值
51
52  根目录
53
54- 示例
55
56```js
57import featureAbility from '@ohos.ability.featureAbility'
58var context = featureAbility.getContext();
59context.getOrCreateLocalDir()
60```
61
62
63
64#### Context.getOrCreateLocalDir()
65
66- 接口说明
67
68  获取应用程序的本地根目录。如果是第一次调用,将创建目录(Promise形式)
69
70- 返回值
71
72  根目录
73
74- 示例
75
76```js
77import featureAbility from '@ohos.ability.featureAbility'
78var context = featureAbility.getContext();
79context.getOrCreateLocalDir().then((void) => {
80	console.info("==========================>getOrCreateLocalDirCallback=======================>");
81});
82```
83
84
85
86#### Context.verifyPermission(permission: string, options: PermissionOptions, callback: AsyncCallback\<number>)
87
88- 接口说明
89
90  验证系统中运行的特定pid和uid是否允许指定的权限(callback形式)
91
92- verifyPermission参数描述
93
94
95| 名称       | 读写属性 | 类型                   | 必填 | 描述             |
96| ---------- | -------- | ---------------------- | ---- | ---------------- |
97| permission | 只读     | string                 | 是   | 指定权限的名称   |
98| options    | 只读     | PermissionOptions      | 是   | 进程id           |
99| callback   | 只读     | AsyncCallback\<number> | 是   | 被指定的回调方法 |
100
101- PermissionOptions类型说明
102
103| 名称 | 读写属性 | 类型   | 必填 | 描述   |
104| ---- | -------- | ------ | ---- | ------ |
105| pid  | 只读     | number | 否   | 进程id |
106| uid  | 只读     | number | 否   | 用户id |
107
108- 返回值
109
110  如果PID和UID具有权限,则使用{@code 0}进行异步回调;否则使用{@code-1}回调。
111
112- 示例
113
114```js
115import featureAbility from '@ohos.ability.featureAbility'
116import bundle from '@ohos.bundle'
117var context = featureAbility.getContext();
118var datainfo = await bundle.getBundleInfo('com.context.test',1);
119context.verifyPermission("com.example.permission",datainfo.uid,)
120
121```
122
123
124
125#### Context.verifyPermission(permission: string, callback: AsyncCallback\<number>)
126
127- 接口说明
128
129  验证系统中运行的特定pid和uid是否允许指定的权限(callback形式)
130
131- 参数描述
132
133
134| 名称       | 读写属性 | 类型                    | 必填 | 描述             |
135| ---------- | -------- | ----------------------- | ---- | ---------------- |
136| permission | 只读     | string                  | 是   | 指定权限的名称   |
137| callback   | 只读     | AsyncCallback\<number>) | 是   | 被指定的回调方法 |
138
139- 返回值
140
141  如果PID和UID具有权限,则使用{@code 0}进行异步回调;否则使用{@code-1}回调。
142
143- 示例
144
145```js
146import featureAbility from '@ohos.ability.featureAbility'
147var context = featureAbility.getContext();
148context.verifyPermission("com.example.permission")
149```
150
151
152
153#### Context.verifyPermission(permission: string, options?: PermissionOptions)
154
155- 接口说明
156
157  验证系统中运行的特定pid和uid是否允许指定的权限(Promise形式)
158- verifyPermission参数描述
159
160
161| 名称       | 读写属性 | 类型              | 必填 | 描述           |
162| ---------- | -------- | ----------------- | ---- | -------------- |
163| permission | 只读     | string            | 是   | 指定权限的名称 |
164| options    | 只读     | PermissionOptions | 否   | 进程id         |
165
166- PermissionOptions类型说明
167
168| 名称 | 读写属性 | 类型   | 必填 | 描述   |
169| ---- | -------- | ------ | ---- | ------ |
170| pid  | 只读     | number | 否   | 进程id |
171| uid  | 只读     | number | 否   | 用户id |
172
173- 返回值
174
175  如果PID和UID具有权限,则使用{@code 0}进行异步回调;否则使用{@code-1}回调。
176
177- 示例
178
179```js
180import featureAbility from '@ohos.ability.featureAbility'
181var context = featureAbility.getContext();
182var Permission = context.PermissionOptions(1,1);
183context.getOrCreateLocalDir('com.context.permission',Permission).then((void) => {
184	console.info("==========================>verifyPermissionCallback=======================>");
185});
186```
187
188
189
190#### Context.requestPermissionsFromUser(permissions: Array\<string>, requestCode: number, resultCallback: AsyncCallback\<PermissionRequestResult>)
191
192- 接口说明
193
194  从系统请求某些权限(callback形式)
195
196- requestPermissionsFromUser参数描述
197
198
199| 名称           | 读写属性 | 类型                                     | 必填 | 描述                                          |
200| -------------- | -------- | ---------------------------------------- | ---- | --------------------------------------------- |
201| permissions    | 只读     | Array\<string>                           | 是   | 指示要请求的权限列表。此参数不能为null        |
202| requestCode    | 只读     | number                                   | 是   | 指示要传递给PermissionRequestResult的请求代码 |
203| resultCallback | 只读     | AsyncCallback\<PermissionRequestResult>) | 是   | 被指定的回调方法                              |
204- PermissionRequestResult类型说明
205
206| 名称        | 读写属性 | 类型           | 必填 | 描述               |
207| ----------- | -------- | -------------- | ---- | ------------------ |
208| requestCode | 只读     | number         | 是   | 用户传入的请求代码 |
209| permissions | 只读     | Array\<string> | 是   | 用户传入的权限     |
210| authResults | 只读     | Array\<number> | 是   | 求权限的结果       |
211
212- 返回值
213
214  void
215
216- 示例
217
218```js
219import featureAbility from '@ohos.ability.featureAbility'
220var context = featureAbility.getContext();
221context.getOrCreateLocalDir(
222    ["com.example.permission1",
223     "com.example.permission2",
224     "com.example.permission3",
225     "com.example.permission4",
226     "com.example.permission5"],
227    1,
228)
229```
230
231
232
233#### Context.getApplicationInfo(callback: AsyncCallback\<ApplicationInfo>)
234
235- 接口说明
236
237  获取有关当前应用程序的信息(callback形式)
238
239- 参数描述
240
241  | 名称     | 读写属性 | 类型                            | 必填 | 描述                 |
242  | -------- | -------- | ------------------------------- | ---- | -------------------- |
243  | callback | 只读     | AsyncCallback\<ApplicationInfo> | 是   | 表示被指定的回调方法 |
244
245- 返回值
246
247  void
248
249- 示例
250
251```js
252import featureAbility from '@ohos.ability.featureAbility'
253var context = featureAbility.getContext();
254context.getApplicationInfo()
255```
256
257
258
259#### Context.getApplicationInfo()
260
261- 接口说明
262
263  获取有关当前应用程序的信息(Promise形式)
264
265- 参数描述
266
267  Null
268
269- 返回值
270
271  void
272
273- 示例
274
275```js
276import featureAbility from '@ohos.ability.featureAbility'
277var context = featureAbility.getContext();
278context.getApplicationInfo().then((void) => {
279	console.info("==========================>getApplicationInfoCallback=======================>");
280});
281```
282
283
284
285####  Context.getBundleName(callback: AsyncCallback\<string>)
286
287- 接口说明
288
289  获取当前ability的捆绑包名称(callback形式)
290
291- 参数描述
292
293  | 名称     | 读写属性 | 类型                   | 必填 | 描述                 |
294  | -------- | -------- | ---------------------- | ---- | -------------------- |
295  | callback | 只读     | AsyncCallback\<string> | 是   | 表示被指定的回调方法 |
296
297- 返回值
298
299  void
300
301- 示例
302
303```js
304import featureAbility from '@ohos.ability.featureAbility'
305var context = featureAbility.getContext();
306context.getBundleName()
307```
308
309
310
311#### Context.getBundleName()
312
313- 接口说明
314
315  获取当前ability的捆绑包名称(Promise形式)
316
317- 参数描述
318
319  Null
320
321- 返回值
322
323  void
324
325- 示例
326
327```js
328import featureAbility from '@ohos.ability.featureAbility'
329var context = featureAbility.getContext();
330context.getBundleName().then((void) => {
331	console.info("==========================>getBundleNameCallback=======================>");
332});
333```
334
335
336
337####  Context.getProcessInfo(callback: AsyncCallback\<ProcessInfo>)
338
339- 接口说明
340
341  获取有关当前进程的信息,包括进程ID和名称(callback形式)
342
343- 参数描述
344
345  | 名称     | 读写属性 | 类型                        | 必填 | 描述                 |
346  | -------- | -------- | --------------------------- | ---- | -------------------- |
347  | callback | 只读     | AsyncCallback\<ProcessInfo> | 是   | 表示被指定的回调方法 |
348
349- 返回值
350
351  void
352
353- 示例
354
355```js
356import featureAbility from '@ohos.ability.featureAbility'
357var context = featureAbility.getContext();
358context.getProcessInfo()
359```
360
361
362
363#### Context.getProcessInfo()
364
365- 接口说明
366
367  获取有关当前进程的信息,包括进程ID和名称(Promise形式)
368
369- 参数描述
370
371  Null
372
373- 返回值
374
375  void
376
377- 示例
378
379```js
380import featureAbility from '@ohos.ability.featureAbility'
381var context = featureAbility.getContext();
382context.getProcessInfo().then((void) => {
383	console.info("==========================>getProcessInfoCallback=======================>");
384});
385```
386
387
388
389####  Context.getElementName(callback: AsyncCallback\<ElementName>)
390
391- 接口说明
392
393  获取当前能力的ohos.bundle.ElementName对象。此方法仅适用于页面功能(callback形式)
394
395- 参数描述
396
397  | 名称     | 读写属性 | 类型                        | 必填 | 描述                 |
398  | -------- | -------- | --------------------------- | ---- | -------------------- |
399  | callback | 只读     | AsyncCallback\<ElementName> | 是   | 表示被指定的回调方法 |
400
401- 返回值
402
403  void
404
405- 示例
406
407```js
408import featureAbility from '@ohos.ability.featureAbility'
409var context = featureAbility.getContext();
410context.getElementName()
411```
412
413
414
415#### Context.getElementName()
416
417- 接口说明
418
419  获取当前能力的ohos.bundle.ElementName对象。此方法仅适用于页面功能(Promise形式)
420
421- 参数描述
422
423  Null
424
425- 返回值
426
427  void
428
429- 示例
430
431```js
432import featureAbility from '@ohos.ability.featureAbility'
433var context = featureAbility.getContext();
434context.getElementName().then((void) => {
435	console.info("==========================>getElementNameCallback=======================>");
436});
437```
438
439####
440
441#### Context.getProcessName(callback: AsyncCallback\<string>)
442
443- 接口说明
444
445  获取当前进程的名称(callback形式)
446
447- 参数描述
448
449  | 名称     | 读写属性 | 类型                   | 必填 | 描述                 |
450  | -------- | -------- | ---------------------- | ---- | -------------------- |
451  | callback | 只读     | AsyncCallback\<string> | 是   | 表示被指定的回调方法 |
452
453- 返回值
454
455  void
456
457- 示例
458
459```js
460import featureAbility from '@ohos.ability.featureAbility'
461var context = featureAbility.getContext();
462context.getProcessName()
463```
464
465
466
467#### Context.getProcessName()
468
469- 接口说明
470
471  获取当前进程的名称(Promise形式)
472
473- 参数描述
474
475  Null
476
477- 返回值
478
479  void
480
481- 示例
482
483```js
484import featureAbility from '@ohos.ability.featureAbility'
485var context = featureAbility.getContext();
486context.getProcessName().then((void) => {
487	console.info("==========================>getProcessNameCallback=======================>");
488});
489```
490
491
492
493#### Context.getCallingBundle(callback: AsyncCallback\<string>)
494
495- 接口说明
496
497  获取调用当前能力的能力的捆绑包名称(callback形式)
498
499- 参数描述
500
501  | 名称     | 读写属性 | 类型                   | 必填 | 描述                 |
502  | -------- | -------- | ---------------------- | ---- | -------------------- |
503  | callback | 只读     | AsyncCallback\<string> | 是   | 表示被指定的回调方法 |
504
505- 返回值
506
507  void
508
509- 示例
510
511```js
512import featureAbility from '@ohos.ability.featureAbility'
513var context = featureAbility.getContext();
514context.getCallingBundle()
515```
516
517
518
519#### Context.getCallingBundle()
520
521- 接口说明
522
523  获取调用当前能力的能力的捆绑包名称(Promise形式)
524
525- 参数描述
526
527  Null
528
529- 返回值
530
531  void
532
533- 示例
534
535```js
536import featureAbility from '@ohos.ability.featureAbility'
537var context = featureAbility.getContext();
538context.getCallingBundle().then((void) => {
539	console.info("==========================>getCallingBundleCallback=======================>");
540});
541```
542
543