js-apis-inner-application-context.md 5.3 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

## 属性

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

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

## Context.createBundleContext

createBundleContext(bundleName: string): Context;

32
根据Bundle名称创建安装包的上下文。
H
HuangXW 已提交
33 34

**需要权限**: ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
M
m00512953 已提交
35 36 37 38 39

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

**参数:**

D
merge  
donglin 已提交
40
| 名称       | 类型                     | 必填   | 说明            |
M
m00512953 已提交
41
| -------- | ---------------------- | ---- | ------------- |
42
| bundleName | string | 是    | Bundle名称。 |
M
m00512953 已提交
43 44 45 46 47

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
H
HuangXW 已提交
48 49 50 51 52 53 54
| Context | 安装包的上下文。 |

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 401 | If the input parameter is not valid parameter. |
D
donglin 已提交
55 56

以上错误码详细介绍请参考[errcode-ability](../errorcodes/errorcode-ability.md)
M
m00512953 已提交
57 58 59 60

**示例:**

```ts
H
HuangXW 已提交
61 62 63 64 65 66 67
let bundleContext;
try {
    bundleContext = this.context.createBundleContext("com.example.test");
} catch (error) {
    console.log('createBundleContext failed, error.code: ' + JSON.stringify(error.code) +
        ' error.message: ' + JSON.stringify(error.message));
}
M
m00512953 已提交
68 69 70 71 72 73
```

## Context.createModuleContext

createModuleContext(moduleName: string): Context;

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

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

**参数:**

D
merge  
donglin 已提交
80
| 名称       | 类型                     | 必填   | 说明            |
M
m00512953 已提交
81 82 83 84 85 86 87
| -------- | ---------------------- | ---- | ------------- |
| moduleName | string | 是    | 模块名。 |

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
H
HuangXW 已提交
88 89 90 91 92 93 94
| Context | 模块的上下文。 |

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 401 | If the input parameter is not valid parameter. |
D
donglin 已提交
95 96

以上错误码详细介绍请参考[errcode-ability](../errorcodes/errorcode-ability.md)
M
m00512953 已提交
97 98 99 100

**示例:**

```ts
H
HuangXW 已提交
101 102 103 104 105 106 107
let moduleContext;
try {
    moduleContext = this.context.createModuleContext("entry");
} catch (error) {
    console.log('createModuleContext failed, error.code: ' + JSON.stringify(error.code) +
        ' error.message: ' + JSON.stringify(error.message));
}
M
m00512953 已提交
108 109 110 111
```

createModuleContext(bundleName: string, moduleName: string): Context;

112
根据Bundle名称和模块名称创建上下文。
M
m00512953 已提交
113 114 115 116 117

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

**参数:**

D
merge  
donglin 已提交
118
| 名称       | 类型                     | 必填   | 说明            |
M
m00512953 已提交
119
| -------- | ---------------------- | ---- | ------------- |
120
| bundleName | string | 是    | Bundle名称。 |
M
m00512953 已提交
121 122 123 124 125 126
| moduleName | string | 是    | 模块名。 |

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
H
HuangXW 已提交
127 128 129 130 131 132 133
| Context | 模块的上下文。 |

**错误码:**

| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 401 | If the input parameter is not valid parameter. |
D
donglin 已提交
134 135

以上错误码详细介绍请参考[errcode-ability](../errorcodes/errorcode-ability.md)
M
m00512953 已提交
136 137 138 139

**示例:**

```ts
H
HuangXW 已提交
140 141 142 143 144 145 146
let moduleContext;
try {
    moduleContext = this.context.createModuleContext("com.example.test", "entry");
} catch (error) {
    console.log('createModuleContext failed, error.code: ' + JSON.stringify(error.code) +
        ' error.message: ' + JSON.stringify(error.message));
}
M
m00512953 已提交
147 148 149 150 151 152
```

## Context.getApplicationContext

getApplicationContext(): ApplicationContext;

H
HuangXW 已提交
153
获取本应用的应用上下文。
M
m00512953 已提交
154 155 156 157 158 159 160

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

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
H
HuangXW 已提交
161
| [ApplicationContext](js-apis-inner-application-applicationContext.md) | 应用上下文Context。 |
M
m00512953 已提交
162 163 164 165

**示例:**

```ts
H
HuangXW 已提交
166 167 168 169 170 171 172
let applicationContext;
try {
    applicationContext = this.context.getApplicationContext();
} catch (error) {
    console.log('getApplicationContext failed, error.code: ' + JSON.stringify(error.code) +
        ' error.message: ' + JSON.stringify(error.message));
}
M
m00512953 已提交
173 174
```