js-apis-inner-application-context.md 7.2 KB
Newer Older
H
HuangXW 已提交
1
# Context
M
m00512953 已提交
2

Z
zhongjianfei 已提交
3
Context模块提供了ability或application的上下文的能力,包括访问特定应用程序的资源等。
M
m00512953 已提交
4 5 6

> **说明:**
>
H
HuangXW 已提交
7 8
>  - 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>  - 本模块接口仅可在Stage模型下使用。
M
m00512953 已提交
9

10 11 12 13 14 15
## 导入模块

```ts
import common from '@ohos.app.ability.common';
```

M
m00512953 已提交
16 17 18 19 20 21
## 属性

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

| 名称          | 类型     | 可读   | 可写   | 说明      |
| ----------- | ------ | ---- | ---- | ------- |
Z
zhongjianfei 已提交
22 23
| resourceManager     | resmgr.[ResourceManager](js-apis-resource-manager.md) | 是    | 否    | 资源管理对象。   |
| applicationInfo | [ApplicationInfo](js-apis-bundle-ApplicationInfo.md) | 是    | 否    | 当前应用程序的信息。 |
M
m00512953 已提交
24 25 26 27 28
| cacheDir | string | 是    | 否    | 缓存目录。 |
| tempDir | string | 是    | 否    | 临时目录。 |
| filesDir | string | 是    | 否    | 文件目录。 |
| databaseDir | string | 是    | 否    | 数据库目录。 |
| preferencesDir | string | 是    | 否    | preferences目录。 |
S
SoftSquirrel 已提交
29
| bundleCodeDir | string | 是    | 否    | 安装包目录。不能拼接路径访问资源文件,请使用[资源管理接口](js-apis-resource-manager.md)访问资源。 |
M
m00512953 已提交
30
| distributedFilesDir | string | 是    | 否    | 分布式文件目录。 |
H
HuangXW 已提交
31
| eventHub | [EventHub](js-apis-inner-application-eventHub.md) | 是    | 否    | 事件中心,提供订阅、取消订阅、触发事件对象。 |
Y
yangzk 已提交
32
| area | contextConstant.[AreaMode](js-apis-app-ability-contextConstant.md) | 是    | 否    | 文件分区信息。 |
M
m00512953 已提交
33 34 35 36 37

## Context.createBundleContext

createBundleContext(bundleName: string): Context;

38
根据Bundle名称创建安装包的上下文。
H
HuangXW 已提交
39 40

**需要权限**: ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
M
m00512953 已提交
41 42 43

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

44 45
**系统API**:该接口为系统接口,三方应用不支持调用。

M
m00512953 已提交
46 47
**参数:**

Y
yuyaozhi 已提交
48
| 参数名       | 类型                     | 必填   | 说明            |
M
m00512953 已提交
49
| -------- | ---------------------- | ---- | ------------- |
50
| bundleName | string | 是    | Bundle名称。 |
M
m00512953 已提交
51 52 53 54 55

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
H
HuangXW 已提交
56 57
| Context | 安装包的上下文。 |

M
m00512953 已提交
58 59 60
**示例:**

```ts
61
let bundleContext: common.Context;
H
HuangXW 已提交
62
try {
M
mingxihua 已提交
63
    bundleContext = this.context.createBundleContext('com.example.test');
H
HuangXW 已提交
64
} catch (error) {
Z
zhoujun62 已提交
65
    console.error('createBundleContext failed, error.code: ${error.code}, error.message: ${error.message}');
H
HuangXW 已提交
66
}
M
m00512953 已提交
67 68 69 70 71 72
```

## Context.createModuleContext

createModuleContext(moduleName: string): Context;

H
HuangXW 已提交
73
根据模块名创建上下文。
M
m00512953 已提交
74 75 76 77 78

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

**参数:**

Y
yuyaozhi 已提交
79
| 参数名       | 类型                     | 必填   | 说明            |
M
m00512953 已提交
80 81 82 83 84 85 86
| -------- | ---------------------- | ---- | ------------- |
| moduleName | string | 是    | 模块名。 |

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
H
HuangXW 已提交
87 88
| Context | 模块的上下文。 |

M
m00512953 已提交
89 90 91
**示例:**

```ts
92
let moduleContext: common.Context;
H
HuangXW 已提交
93
try {
M
mingxihua 已提交
94
    moduleContext = this.context.createModuleContext('entry');
H
HuangXW 已提交
95
} catch (error) {
Z
zhoujun62 已提交
96
    console.error('createModuleContext failed, error.code: ${error.code}, error.message: ${error.message}');
H
HuangXW 已提交
97
}
M
m00512953 已提交
98 99
```

M
mingxihua 已提交
100 101
## Context.createModuleContext

M
m00512953 已提交
102 103
createModuleContext(bundleName: string, moduleName: string): Context;

104
根据Bundle名称和模块名称创建上下文。
M
m00512953 已提交
105 106 107

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

108 109
**系统API**:该接口为系统接口,三方应用不支持调用。

M
m00512953 已提交
110 111
**参数:**

Y
yuyaozhi 已提交
112
| 参数名       | 类型                     | 必填   | 说明            |
M
m00512953 已提交
113
| -------- | ---------------------- | ---- | ------------- |
114
| bundleName | string | 是    | Bundle名称。 |
M
m00512953 已提交
115 116 117 118 119 120
| moduleName | string | 是    | 模块名。 |

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
H
HuangXW 已提交
121 122
| Context | 模块的上下文。 |

M
m00512953 已提交
123 124 125
**示例:**

```ts
126
let moduleContext: common.Context;
H
HuangXW 已提交
127
try {
M
mingxihua 已提交
128
    moduleContext = this.context.createModuleContext('com.example.test', 'entry');
H
HuangXW 已提交
129
} catch (error) {
Z
zhoujun62 已提交
130
    console.error('createModuleContext failed, error.code: ${error.code}, error.message: ${error.message}');
H
HuangXW 已提交
131
}
M
m00512953 已提交
132 133 134 135 136 137
```

## Context.getApplicationContext

getApplicationContext(): ApplicationContext;

H
HuangXW 已提交
138
获取本应用的应用上下文。
M
m00512953 已提交
139 140 141 142 143 144 145

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

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
H
HuangXW 已提交
146
| [ApplicationContext](js-apis-inner-application-applicationContext.md) | 应用上下文Context。 |
M
m00512953 已提交
147 148 149 150

**示例:**

```ts
151
let applicationContext: common.Context;
H
HuangXW 已提交
152 153 154
try {
    applicationContext = this.context.getApplicationContext();
} catch (error) {
Z
zhoujun62 已提交
155
    console.error('getApplicationContext failed, error.code: ${error.code}, error.message: ${error.message}');
H
HuangXW 已提交
156
}
M
m00512953 已提交
157 158
```

W
context  
wangkailong 已提交
159 160
## Context.getGroupDir<sup>10+</sup>

Y
yuyaozhi 已提交
161
getGroupDir(dataGroupID: string): Promise\<string>;
W
context  
wangkailong 已提交
162 163 164 165 166 167 168

通过使用元服务应用中的Group ID获取对应的共享目录,使用Promise异步回调。

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

**参数:**

Y
yuyaozhi 已提交
169
| 参数名       | 类型                     | 必填   | 说明            |
W
context  
wangkailong 已提交
170
| -------- | ---------------------- | ---- | ------------- |
Y
yuyaozhi 已提交
171
| dataGroupID | string | 是    | 元服务应用项目创建时,系统会指定分配唯一Group ID。 |
W
context  
wangkailong 已提交
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
| Promise\<string> | 以Promise方式返回对应的共享目录。如果不存在则返回为空,仅支持应用el2加密级别。|

**错误码**

以下错误码详细介绍请参考[errcode-ability](../errorcodes/errorcode-ability.md)

| 错误码ID | 错误信息 |
| ------- | -------- |
| 16000011 | The context does not exist. |

**示例:**

```ts
let groupId = "1";
Y
yuyaozhi 已提交
191 192 193
let getGroupDirContext: common.Context;
try {
  getGroupDirContext.getGroupDir(groupId).then(data => {
W
context  
wangkailong 已提交
194
    console.log("getGroupDir result:" + data);
Y
yuyaozhi 已提交
195 196 197 198
  })
} catch (error) {
  console.error('getGroupDirContext failed, error.code: ${error.code}, error.message: ${error.message}');
}
W
context  
wangkailong 已提交
199 200 201 202
```

## Context.getGroupDir<sup>10+</sup>

Y
yuyaozhi 已提交
203
getGroupDir(dataGroupID: string, callback: AsyncCallback\<string>);
W
context  
wangkailong 已提交
204 205 206 207 208 209 210

通过使用元服务应用中的Group ID获取对应的共享目录,使用callback异步回调。

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

**参数:**

Y
yuyaozhi 已提交
211
| 参数名       | 类型                     | 必填   | 说明            |
W
context  
wangkailong 已提交
212
| -------- | ---------------------- | ---- | ------------- |
Y
yuyaozhi 已提交
213
| dataGroupID | string | 是    | 元服务应用项目创建时,系统会指定分配唯一Group ID。 |
W
context  
wangkailong 已提交
214 215 216 217 218 219 220 221 222 223 224 225 226
| callback | AsyncCallback\<string> | 是    | 以callback方式返回对应的共享目录。如果不存在则返回为空,仅支持应用el2加密级别。|

**错误码**

以下错误码详细介绍请参考[errcode-ability](../errorcodes/errorcode-ability.md)

| 错误码ID | 错误信息 |
| ------- | -------- |
| 16000011 | The context does not exist. |

**示例:**

```ts
Y
yuyaozhi 已提交
227 228 229 230 231 232 233 234
let getGroupDirContext: common.Context;

getGroupDirContext.getGroupDir("1", (err, data) => {
  if (err) {
    console.error('getGroupDir faile, err: ${JSON.stringify(err)}');
  } else {
    console.log('getGroupDir result is: ${JSON.stringify(data)}');
  }
W
context  
wangkailong 已提交
235 236 237
});
```