js-apis-resource-manager.md 90.8 KB
Newer Older
1
# 资源管理
Z
zengyawen 已提交
2

F
fangyunzhong 已提交
3
资源管理模块,根据当前configuration:语言、区域、横竖屏、Mcc(移动国家码)和Mnc(移动网络码)、Device capability(设备类型)、Density(分辨率)提供获取应用资源信息读取接口。
4

5 6
> **说明:**
>
W
wplan1 已提交
7
> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
Z
zengyawen 已提交
8

Z
zengyawen 已提交
9 10

## 导入模块
Z
zengyawen 已提交
11

H
HelloCrease 已提交
12
```js
Z
zengyawen 已提交
13 14 15
import resourceManager from '@ohos.resourceManager';
```

H
huangjie 已提交
16 17
## 使用说明

H
huangjie 已提交
18
从API Version9开始,Stage模型通过context获取resourceManager对象的方式后,可直接调用其内部获取资源的接口,无需再导入包。此方式FA模型不适用,FA模型还需要先导入包,再调用[getResourceManager](#resourcemanagergetresourcemanager)接口获取资源对象。
19
Stage模型下Context的引用方法请参考[Stage模型的Context详细介绍](../../ability-deprecated/context-userguide.md)
H
huangjie 已提交
20

H
HelloCrease 已提交
21
```ts
F
fangyunzhong 已提交
22 23 24 25 26 27 28
import Ability from '@ohos.application.Ability';
class MainAbility extends Ability {
    onWindowStageCreate(windowStage) {
        let context = this.context;
        let resourceManager = context.resourceManager;
    }
}
H
huangjie 已提交
29 30
```

Z
zengyawen 已提交
31 32 33
## resourceManager.getResourceManager

getResourceManager(callback: AsyncCallback<ResourceManager>): void
Z
zengyawen 已提交
34 35 36

获取当前应用的资源管理对象,使用callback形式返回ResourceManager对象。

H
huangjie 已提交
37
**模型约束**:此接口仅可在FA模型下使用。
H
huangjie 已提交
38

V
VictoriaGuo 已提交
39 40
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
41
**参数:** 
H
huangjie 已提交
42

H
HelloCrease 已提交
43 44 45
| 参数名      | 类型                                       | 必填   | 说明                            |
| -------- | ---------------------------------------- | ---- | ----------------------------- |
| callback | AsyncCallback<[ResourceManager](#resourcemanager)> | 是    | callback方式返回ResourceManager对象 |
Z
zengyawen 已提交
46

H
HelloCrease 已提交
47
**示例:** 
H
HelloCrease 已提交
48
  ```js
Z
zengyawen 已提交
49 50
  resourceManager.getResourceManager((error, mgr) => {
      if (error != null) {
W
wplan1 已提交
51
          console.log("error is " + error);
Z
zengyawen 已提交
52 53 54 55
          return; 
      }
      mgr.getString(0x1000000, (error, value) => {
          if (error != null) {
W
wplan1 已提交
56
              console.log("error is " + error);
Z
zengyawen 已提交
57
          } else {
W
wplan1 已提交
58
              let str = value;
Z
zengyawen 已提交
59 60 61 62 63 64 65 66 67
          }
      });
  });
  ```


## resourceManager.getResourceManager

getResourceManager(bundleName: string, callback: AsyncCallback<ResourceManager>): void
Z
zengyawen 已提交
68 69 70

获取指定应用的资源管理对象,使用callback形式返回ResourceManager对象。

H
huangjie 已提交
71
**模型约束**:此接口仅可在FA模型下使用。
H
huangjie 已提交
72

V
VictoriaGuo 已提交
73 74
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
75
**参数:** 
H
huangjie 已提交
76

H
HelloCrease 已提交
77 78 79 80
| 参数名        | 类型                                       | 必填   | 说明                            |
| ---------- | ---------------------------------------- | ---- | ----------------------------- |
| bundleName | string                                   | 是    | 指定应用的Bundle名称                 |
| callback   | AsyncCallback<[ResourceManager](#resourcemanager)> | 是    | callback方式返回ResourceManager对象 |
Z
zengyawen 已提交
81

H
HelloCrease 已提交
82
**示例:** 
H
HelloCrease 已提交
83
  ```js
Z
zengyawen 已提交
84 85 86 87 88 89 90 91
  resourceManager.getResourceManager("com.example.myapplication", (error, mgr) => {
  });
  ```


## resourceManager.getResourceManager

getResourceManager(): Promise<ResourceManager>
Z
zengyawen 已提交
92 93 94

获取当前应用的资源管理对象,使用Promise形式返回ResourceManager对象。

H
huangjie 已提交
95
**模型约束**:此接口仅可在FA模型下使用。
H
huangjie 已提交
96

V
VictoriaGuo 已提交
97 98
**系统能力**:SystemCapability.Global.ResourceManager

H
huangjie 已提交
99 100
**返回值:**

H
HelloCrease 已提交
101 102 103
| 类型                                       | 说明                |
| ---------------------------------------- | ----------------- |
| Promise<[ResourceManager](#resourcemanager)> | Promise方式返回资源管理对象 |
Z
zengyawen 已提交
104

H
HelloCrease 已提交
105
**示例:** 
H
HelloCrease 已提交
106
  ```js
Z
zengyawen 已提交
107 108 109
  resourceManager.getResourceManager().then(mgr => {
      mgr.getString(0x1000000, (error, value) => {
          if (error != null) {
W
wplan1 已提交
110
              console.log("error is " + error);
Z
zengyawen 已提交
111
          } else {
W
wplan1 已提交
112
              let str = value;
Z
zengyawen 已提交
113 114 115
          }
      });
  }).catch(error => {
W
wplan1 已提交
116
      console.log("error is " + error);
Z
zengyawen 已提交
117 118 119 120 121 122 123
  });
  ```


## resourceManager.getResourceManager

getResourceManager(bundleName: string): Promise<ResourceManager>
Z
zengyawen 已提交
124 125 126

获取指定应用的资源管理对象,使用Promise形式返回ResourceManager对象。

H
huangjie 已提交
127
**模型约束**:此接口仅可在FA模型下使用。
H
huangjie 已提交
128

V
VictoriaGuo 已提交
129 130
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
131
**参数:** 
H
huangjie 已提交
132

H
HelloCrease 已提交
133 134 135
| 参数名        | 类型     | 必填   | 说明            |
| ---------- | ------ | ---- | ------------- |
| bundleName | string | 是    | 指定应用的Bundle名称 |
Z
zengyawen 已提交
136

H
huangjie 已提交
137 138
**返回值:**

H
HelloCrease 已提交
139 140 141
| 类型                                       | 说明                 |
| ---------------------------------------- | ------------------ |
| Promise<[ResourceManager](#resourcemanager)> | Promise方式返回的资源管理对象 |
Z
zengyawen 已提交
142

H
HelloCrease 已提交
143
**示例:** 
H
HelloCrease 已提交
144
  ```js
Z
zengyawen 已提交
145 146 147 148 149 150 151
  resourceManager.getResourceManager("com.example.myapplication").then(mgr => {
  }).catch(error => {
  });
  ```


## Direction
Z
zengyawen 已提交
152 153 154

用于表示设备屏幕方向。

H
HelloCrease 已提交
155
**系统能力**:SystemCapability.Global.ResourceManager
H
HelloCrease 已提交
156

H
huangjie 已提交
157
| 名称                   | 值  | 说明   |
H
HelloCrease 已提交
158 159 160
| -------------------- | ---- | ---- |
| DIRECTION_VERTICAL   | 0    | 竖屏   |
| DIRECTION_HORIZONTAL | 1    | 横屏   |
Z
zengyawen 已提交
161 162 163


## DeviceType
Z
zengyawen 已提交
164 165 166

用于表示当前设备类型。

H
HelloCrease 已提交
167
**系统能力**:SystemCapability.Global.ResourceManager
H
HelloCrease 已提交
168

H
huangjie 已提交
169
| 名称                   | 值  | 说明   |
H
HelloCrease 已提交
170 171 172 173 174 175 176
| -------------------- | ---- | ---- |
| DEVICE_TYPE_PHONE    | 0x00 | 手机   |
| DEVICE_TYPE_TABLET   | 0x01 | 平板   |
| DEVICE_TYPE_CAR      | 0x02 | 汽车   |
| DEVICE_TYPE_PC       | 0x03 | 电脑   |
| DEVICE_TYPE_TV       | 0x04 | 电视   |
| DEVICE_TYPE_WEARABLE | 0x06 | 穿戴   |
Z
zengyawen 已提交
177 178 179


## ScreenDensity
Z
zengyawen 已提交
180 181 182

用于表示当前设备屏幕密度。

H
HelloCrease 已提交
183
**系统能力**:SystemCapability.Global.ResourceManager
H
HelloCrease 已提交
184

H
huangjie 已提交
185
| 名称             | 值  | 说明         |
H
HelloCrease 已提交
186 187 188 189 190 191 192
| -------------- | ---- | ---------- |
| SCREEN_SDPI    | 120  | 小规模的屏幕密度   |
| SCREEN_MDPI    | 160  | 中规模的屏幕密度   |
| SCREEN_LDPI    | 240  | 大规模的屏幕密度   |
| SCREEN_XLDPI   | 320  | 特大规模的屏幕密度  |
| SCREEN_XXLDPI  | 480  | 超大规模的屏幕密度  |
| SCREEN_XXXLDPI | 640  | 超特大规模的屏幕密度 |
Z
zengyawen 已提交
193 194 195


## Configuration
Z
zengyawen 已提交
196 197 198

表示当前设备的状态。

H
HelloCrease 已提交
199
**系统能力**:SystemCapability.Global.ResourceManager
H
HelloCrease 已提交
200

H
huangjie 已提交
201
**参数:** 
Z
zengyawen 已提交
202

H
huangjie 已提交
203
| 名称        | 类型                    | 可读   | 可写   | 说明       |
H
HelloCrease 已提交
204 205 206
| --------- | ----------------------- | ---- | ---- | -------- |
| direction | [Direction](#direction) | 是    | 否    | 当前设备屏幕方向 |
| locale    | string                  | 是    | 否    | 当前系统语言   |
Z
zengyawen 已提交
207

208 209
**示例:**

H
HelloCrease 已提交
210
  ```js
211 212
resourceManager.getResourceManager((error, mgr) => {
      mgr.getConfiguration((error, value) => {
W
wplan1 已提交
213 214
          let direction = value.direction;
          let locale = value.locale;
215 216 217
      });
  });
  ```
Z
zengyawen 已提交
218 219

## DeviceCapability
Z
zengyawen 已提交
220 221 222

表示设备支持的能力。

H
HelloCrease 已提交
223
**系统能力**:SystemCapability.Global.ResourceManager
H
HelloCrease 已提交
224

H
huangjie 已提交
225
**参数:**
Z
zengyawen 已提交
226

H
huangjie 已提交
227
| 名称            | 类型                            | 可读   | 可写   | 说明       |
H
HelloCrease 已提交
228 229 230
| ------------- | ------------------------------- | ---- | ---- | -------- |
| screenDensity | [ScreenDensity](#screendensity) | 是    | 否    | 当前设备屏幕密度 |
| deviceType    | [DeviceType](#devicetype)       | 是    | 否    | 当前设备类型   |
Z
zengyawen 已提交
231

232 233
**示例:**

H
HelloCrease 已提交
234
  ```js
235 236
resourceManager.getResourceManager((error, mgr) => {
      mgr.getDeviceCapability((error, value) => {
W
wplan1 已提交
237 238
          let screenDensity = value.screenDensity;
          let deviceType = value.deviceType;
239 240 241
      });
  });
  ```
Z
zengyawen 已提交
242

W
wplan1 已提交
243 244
## RawFileDescriptor<sup>8+</sup>

H
HelloCrease 已提交
245 246 247
表示rawfile的descriptor信息。

**系统能力:** SystemCapability.Global.ResourceManager
W
wplan1 已提交
248

H
huangjie 已提交
249 250 251 252 253 254 255
**参数:**

| 名称     | 类型    | 可读   | 可写  | 说明           |
| ------ | ------  | ---- | ---- | ------------------ |
| fd     | number  | 是    | 否 | rawfile的descriptor |
| offset | number  | 是    | 否 | rawfile的起始偏移量      |
| length | number  | 是    | 否 | rawfile的文件长度       |
W
wplan1 已提交
256

257
## Resource<sup>9+</sup>
258 259 260 261 262

表示的资源信息。

**系统能力:** 以下各项对应的系统能力均为SystemCapability.Global.ResourceManager

H
huangjie 已提交
263 264 265 266 267 268 269
**参数:**

| 名称         | 类型     | 可读   | 可写  |说明          |
| ---------- | ------ | ----- | ----  | ---------------|
| bundleName | string | 是    | 否 | 应用的bundle名称 |
| moduleName | string | 是    | 否 | 应用的module名称 |
| id         | number | 是    | 否 | 资源的id值      |
270

W
wplan1 已提交
271

Z
zengyawen 已提交
272
## ResourceManager
Z
zengyawen 已提交
273 274 275

提供访问应用资源的能力。

276 277
> **说明:**
>
Z
zengyawen 已提交
278
> - ResourceManager涉及到的方法,仅限基于TS扩展的声明式开发范式使用。
H
HelloCrease 已提交
279
>
Z
zengyawen 已提交
280 281
> - 资源文件在工程的resources目录中定义,id可通过$r(资源地址).id的方式获取,例如$r('app.string.test').id。

H
huangjie 已提交
282
### getStringValue<sup>9+</sup>
Z
zengyawen 已提交
283

H
huangjie 已提交
284
getStringValue(resId: number, callback: AsyncCallback&lt;string&gt;): void
Z
zengyawen 已提交
285 286 287

用户获取指定资源ID对应的字符串,使用callback形式返回字符串。

V
VictoriaGuo 已提交
288 289
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
290
**参数:** 
H
huangjie 已提交
291

H
HelloCrease 已提交
292 293 294 295
| 参数名      | 类型                          | 必填   | 说明              |
| -------- | --------------------------- | ---- | --------------- |
| resId    | number                      | 是    | 资源ID值           |
| callback | AsyncCallback&lt;string&gt; | 是    | 异步回调,用于返回获取的字符串 |
Z
zengyawen 已提交
296

H
huangjie 已提交
297 298 299 300 301 302
**错误码:**

以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
303 304 305
| 9001001  | If the module resId invalid.             |
| 9001002  | If the resource not found by resId.      |
| 9001006  | If the resource re-ref too much.         |
H
huangjie 已提交
306 307

**示例Stage:** 
H
HelloCrease 已提交
308
  ```ts
H
huangjie 已提交
309
    try {
H
huangjie 已提交
310
        this.context.resourceManager.getStringValue($r('app.string.test').id, (error, value) => {
Z
zengyawen 已提交
311
          if (error != null) {
W
wplan1 已提交
312
              console.log("error is " + error);
Z
zengyawen 已提交
313
          } else {
W
wplan1 已提交
314
              let str = value;
Z
zengyawen 已提交
315 316
          }
      });
H
huangjie 已提交
317 318 319
    } catch (error) {
        console.error(`callback getStringValue failed, error code: ${error.code}, message: ${error.message}.`)
    }
Z
zengyawen 已提交
320 321 322
  ```


H
huangjie 已提交
323
### getStringValue<sup>9+</sup>
Z
zengyawen 已提交
324

H
huangjie 已提交
325
getStringValue(resId: number): Promise&lt;string&gt;
Z
zengyawen 已提交
326 327 328

用户获取指定资源ID对应的字符串,使用Promise形式返回字符串。

V
VictoriaGuo 已提交
329 330
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
331
**参数:** 
H
huangjie 已提交
332

H
HelloCrease 已提交
333 334 335
| 参数名   | 类型     | 必填   | 说明    |
| ----- | ------ | ---- | ----- |
| resId | number | 是    | 资源ID值 |
Z
zengyawen 已提交
336

H
huangjie 已提交
337 338
**返回值:**

H
HelloCrease 已提交
339 340 341
| 类型                    | 说明          |
| --------------------- | ----------- |
| Promise&lt;string&gt; | 资源ID值对应的字符串 |
Z
zengyawen 已提交
342

H
huangjie 已提交
343 344
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
345 346
**错误码:**

H
huangjie 已提交
347 348
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
349 350 351
| 9001001  | If the resId invalid.                       |
| 9001002  | If the resource not found by resId.         |
| 9001006  | If the resource re-ref too much.            |
H
huangjie 已提交
352

H
HelloCrease 已提交
353
**示例:** 
H
HelloCrease 已提交
354
  ```ts
H
huangjie 已提交
355 356 357 358 359 360 361 362 363
  try {
    this.context.resourceManager.getStringValue($r('app.string.test').id).then(value => {
        let str = value;
    }).catch(error => {
        console.log("getStringValue promise error is " + error);
    });
  } catch (error) {
    console.error(`promise getStringValue failed, error code: ${error.code}, message: ${error.message}.`)
  }
Z
zengyawen 已提交
364 365 366
  ```


H
huangjie 已提交
367
### getStringValue<sup>9+</sup>
368

H
huangjie 已提交
369
getStringValue(resource: Resource, callback: AsyncCallback&lt;string&gt;): void
370 371 372 373 374 375

用户获取指定resource对象对应的字符串,使用callback形式返回字符串。

**系统能力**:SystemCapability.Global.ResourceManager

**参数:** 
H
huangjie 已提交
376

377 378
| 参数名      | 类型                          | 必填   | 说明              |
| -------- | --------------------------- | ---- | --------------- |
H
HelloCrease 已提交
379
| resource | [Resource](#resource9)      | 是    | 资源信息            |
380 381
| callback | AsyncCallback&lt;string&gt; | 是    | 异步回调,用于返回获取的字符串 |

H
huangjie 已提交
382 383
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
384 385
**错误码:**

H
huangjie 已提交
386 387
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
388 389 390
| 9001001  | If the resId invalid.                       |
| 9001002  | If the resource not found by resId.         |
| 9001006  | If the resource re-ref too much.            |
H
huangjie 已提交
391

392
**示例:** 
H
HelloCrease 已提交
393
  ```ts
394 395 396 397 398
  let resource = {
      bundleName: "com.example.myapplication",
      moduleName: "entry",
      id: $r('app.string.test').id
  };
H
huangjie 已提交
399
  try {
H
huangjie 已提交
400 401 402 403 404 405 406 407 408 409 410
    this.context.resourceManager.getStringValue(resource, (error, value) => {
        if (error != null) {
            console.log("error is " + error);
        } else {
            let str = value;
        }
    });
  } catch (error) {
    console.error(`callback getStringValue failed, error code: ${error.code}, message: ${error.message}.`)
  }
  
411 412 413
  ```


H
huangjie 已提交
414 415 416
### getStringValue<sup>9+</sup>

getStringValue(resource: Resource): Promise&lt;string&gt;
417 418 419 420 421

用户获取指定resource对象对应的字符串,使用Promise形式返回字符串。

**系统能力**:SystemCapability.Global.ResourceManager

H
huangjie 已提交
422 423
**参数:**

H
HelloCrease 已提交
424 425
| 参数名      | 类型                     | 必填   | 说明   |
| -------- | ---------------------- | ---- | ---- |
426
| resource | [Resource](#resource9) | 是    | 资源信息 |
427

H
huangjie 已提交
428
**返回值:**
H
huangjie 已提交
429

H
HelloCrease 已提交
430 431
| 类型                    | 说明               |
| --------------------- | ---------------- |
432 433
| Promise&lt;string&gt; | resource对象对应的字符串 |

H
huangjie 已提交
434 435
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
436 437
**错误码:**

H
huangjie 已提交
438 439
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
440 441 442
| 9001001  | If the resId invalid.                       |
| 9001002  | If the resource not found by resId.         |
| 9001006  | If the resource re-ref too much.            |
H
huangjie 已提交
443

444
**示例:** 
H
HelloCrease 已提交
445
  ```ts
446 447 448 449 450
  let resource = {
      bundleName: "com.example.myapplication",
      moduleName: "entry",
      id: $r('app.string.test').id
  };
H
huangjie 已提交
451 452
  try {
    this.context.resourceManager.getStringValue(resource).then(value => {
453
      let str = value;
H
huangjie 已提交
454 455 456 457 458 459
    }).catch(error => {
      console.log("getStringValue promise error is " + error);
    });
  } catch (error) {
    console.error(`callback getStringValue failed, error code: ${error.code}, message: ${error.message}.`)
  }
460 461
  ```

Z
zengyawen 已提交
462

H
huangjie 已提交
463 464 465
### getStringArrayValue<sup>9+</sup>

getStringArrayValue(resId: number, callback: AsyncCallback&lt;Array&lt;string&gt;&gt;): void
Z
zengyawen 已提交
466 467 468

用户获取指定资源ID对应的字符串数组,使用callback形式返回字符串数组。

V
VictoriaGuo 已提交
469 470
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
471
**参数:** 
H
huangjie 已提交
472

H
HelloCrease 已提交
473 474 475 476
| 参数名      | 类型                                       | 必填   | 说明                |
| -------- | ---------------------------------------- | ---- | ----------------- |
| resId    | number                                   | 是    | 资源ID值             |
| callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是    | 异步回调,用于返回获取的字符串数组 |
Z
zengyawen 已提交
477

H
huangjie 已提交
478 479
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
480 481
**错误码:**

H
huangjie 已提交
482 483
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
484 485 486
| 9001001  | If the resId invalid.                       |
| 9001002  | If the resource not found by resId.         |
| 9001006  | If the resource re-ref too much.            |
H
huangjie 已提交
487

H
HelloCrease 已提交
488
**示例:** 
H
HelloCrease 已提交
489
  ```ts
H
huangjie 已提交
490 491 492 493 494 495 496 497 498 499 500
  try {
    this.context.resourceManager.getStringArrayValue($r('app.strarray.test').id, (error, value) => {
        if (error != null) {
            console.log("error is " + error);
        } else {
            let strArray = value;
        }
    });
  } catch (error) {
    console.error(`callback getStringArrayValue failed, error code: ${error.code}, message: ${error.message}.`)
  }
Z
zengyawen 已提交
501 502 503
  ```


H
huangjie 已提交
504
### getStringArrayValue<sup>9+</sup>
Z
zengyawen 已提交
505

H
huangjie 已提交
506
getStringArrayValue(resId: number): Promise&lt;Array&lt;string&gt;&gt;
Z
zengyawen 已提交
507 508 509

用户获取指定资源ID对应的字符串数组,使用Promise形式返回字符串数组。

V
VictoriaGuo 已提交
510 511
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
512
**参数:** 
H
huangjie 已提交
513

H
HelloCrease 已提交
514 515 516
| 参数名   | 类型     | 必填   | 说明    |
| ----- | ------ | ---- | ----- |
| resId | number | 是    | 资源ID值 |
Z
zengyawen 已提交
517

H
huangjie 已提交
518 519
**返回值:**

H
HelloCrease 已提交
520 521 522
| 类型                                 | 说明            |
| ---------------------------------- | ------------- |
| Promise&lt;Array&lt;string&gt;&gt; | 资源ID值对应的字符串数组 |
Z
zengyawen 已提交
523

H
huangjie 已提交
524 525
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
526 527
**错误码:**

H
huangjie 已提交
528 529
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
530 531 532
| 9001001  | If the resId invalid.                       |
| 9001002  | If the resource not found by resId.         |
| 9001006  | If the resource re-ref too much.            |
H
huangjie 已提交
533

H
HelloCrease 已提交
534
**示例:** 
H
HelloCrease 已提交
535
  ```ts
H
huangjie 已提交
536 537 538 539 540 541 542 543 544
  try {
    this.context.resourceManager.getStringArrayValue($r('app.strarray.test').id).then(value => {
        let strArray = value;
    }).catch(error => {
        console.log("getStringArrayValue promise error is " + error);
    });
  } catch (error) {
    console.error(`promise getStringArrayValue failed, error code: ${error.code}, message: ${error.message}.`)
  }
Z
zengyawen 已提交
545 546
  ```

H
huangjie 已提交
547
### getStringArrayValue<sup>9+</sup>
548

H
huangjie 已提交
549
getStringArrayValue(resource: Resource, callback: AsyncCallback&lt;Array&lt;string&gt;&gt;): void
550 551 552 553 554 555

用户获取指定resource对象对应的字符串数组,使用callback形式返回回字符串数组。

**系统能力**:SystemCapability.Global.ResourceManager

**参数:** 
H
huangjie 已提交
556

H
HelloCrease 已提交
557 558 559
| 参数名      | 类型                                       | 必填   | 说明                |
| -------- | ---------------------------------------- | ---- | ----------------- |
| resource | [Resource](#resource9)                   | 是    | 资源信息              |
560 561
| callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是    | 异步回调,用于返回获取的字符串数组 |

H
huangjie 已提交
562 563
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
564 565
**错误码:**

H
huangjie 已提交
566 567
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
568 569 570
| 9001001  | If the resId invalid.                       |
| 9001002  | If the resource not found by resId.         |
| 9001006  | If the resource re-ref too much.            |
H
huangjie 已提交
571

572
**示例:** 
H
HelloCrease 已提交
573
  ```ts
574 575 576 577 578
  let resource = {
      bundleName: "com.example.myapplication",
      moduleName: "entry",
      id: $r('app.strarray.test').id
  };
H
huangjie 已提交
579 580
  try {
    this.context.resourceManager.getStringArrayValue(resource, (error, value) => {
581 582 583 584 585
      if (error != null) {
          console.log("error is " + error);
      } else {
          let strArray = value;
      }
H
huangjie 已提交
586 587 588 589
    });
  } catch (error) {
    console.error(`callback getStringArrayValue failed, error code: ${error.code}, message: ${error.message}.`)
  }
590 591
  ```

H
huangjie 已提交
592
### getStringArrayValue<sup>9+</sup>
593

H
huangjie 已提交
594
getStringArrayValue(resource: Resource): Promise&lt;Array&lt;string&gt;&gt;
595 596 597 598 599 600

用户获取指定resource对象对应的字符串数组,使用Promise形式返回字符串数组。

**系统能力**:SystemCapability.Global.ResourceManager

**参数:** 
H
huangjie 已提交
601

H
HelloCrease 已提交
602 603
| 参数名      | 类型                     | 必填   | 说明   |
| -------- | ---------------------- | ---- | ---- |
604
| resource | [Resource](#resource9) | 是    | 资源信息 |
605

H
huangjie 已提交
606 607
**返回值:**

H
HelloCrease 已提交
608 609
| 类型                                 | 说明                 |
| ---------------------------------- | ------------------ |
610 611
| Promise&lt;Array&lt;string&gt;&gt; | resource对象对应的字符串数组 |

H
huangjie 已提交
612 613
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
614 615
**错误码:**

H
huangjie 已提交
616 617
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
618 619 620
| 9001001  | If the resId invalid.                       |
| 9001002  | If the resource not found by resId.         |
| 9001006  | If the resource re-ref too much.            |
H
huangjie 已提交
621

622
**示例:** 
H
HelloCrease 已提交
623
  ```ts
624 625 626 627 628
  let resource = {
      bundleName: "com.example.myapplication",
      moduleName: "entry",
      id: $r('app.strarray.test').id
  };
H
huangjie 已提交
629 630
  try {
    this.context.resourceManager.getStringArrayValue(resource).then(value => {
631
      let strArray = value;
H
huangjie 已提交
632 633 634 635 636 637
    }).catch(error => {
        console.log("getStringArray promise error is " + error);
    });
  } catch (error) {
    console.error(`promise getStringArrayValue failed, error code: ${error.code}, message: ${error.message}.`)
  }
638
  ```
Z
zengyawen 已提交
639 640


H
huangjie 已提交
641
### getMediaContent<sup>9+</sup>
H
huangjie 已提交
642 643

getMediaContent(resId: number, callback: AsyncCallback&lt;Uint8Array&gt;): void
Z
zengyawen 已提交
644 645 646

用户获取指定资源ID对应的媒体文件内容,使用callback形式返回字节数组。

V
VictoriaGuo 已提交
647 648
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
649
**参数:** 
H
huangjie 已提交
650

H
HelloCrease 已提交
651 652 653 654
| 参数名      | 类型                              | 必填   | 说明                 |
| -------- | ------------------------------- | ---- | ------------------ |
| resId    | number                          | 是    | 资源ID值              |
| callback | AsyncCallback&lt;Uint8Array&gt; | 是    | 异步回调,用于返回获取的媒体文件内容 |
Z
zengyawen 已提交
655

H
huangjie 已提交
656 657
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
658 659
**错误码:**

H
huangjie 已提交
660 661
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
662 663
| 9001001  | If the resId invalid.                       |
| 9001002  | If the resource not found by resId.         |
H
huangjie 已提交
664

H
HelloCrease 已提交
665
**示例:** 
H
HelloCrease 已提交
666
  ```ts
H
huangjie 已提交
667 668 669 670 671 672 673 674 675 676 677
  try {
    this.context.resourceManager.getMediaContent($r('app.media.test').id, (error, value) => {
        if (error != null) {
            console.log("error is " + error);
        } else {
            let media = value;
        }
    });
  } catch (error) {
    console.error(`callback getMediaContent failed, error code: ${error.code}, message: ${error.message}.`)
  }
Z
zengyawen 已提交
678 679 680
  ```


H
huangjie 已提交
681
### getMediaContent<sup>9+</sup>
Z
zengyawen 已提交
682

H
huangjie 已提交
683
getMediaContent(resId: number): Promise&lt;Uint8Array&gt;
Z
zengyawen 已提交
684 685 686

用户获取指定资源ID对应的媒体文件内容,使用Promise形式返回字节数组。

V
VictoriaGuo 已提交
687 688
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
689
**参数:** 
H
huangjie 已提交
690

H
HelloCrease 已提交
691 692 693
| 参数名   | 类型     | 必填   | 说明    |
| ----- | ------ | ---- | ----- |
| resId | number | 是    | 资源ID值 |
Z
zengyawen 已提交
694

H
huangjie 已提交
695 696
**返回值:**

H
HelloCrease 已提交
697 698 699
| 类型                        | 说明             |
| ------------------------- | -------------- |
| Promise&lt;Uint8Array&gt; | 资源ID值对应的媒体文件内容 |
Z
zengyawen 已提交
700

H
huangjie 已提交
701 702
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
703 704
**错误码:**

H
huangjie 已提交
705 706
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
707 708
| 9001001  | If the resId invalid.                       |
| 9001002  | If the resource not found by resId.         |
H
huangjie 已提交
709

H
HelloCrease 已提交
710
**示例:** 
H
HelloCrease 已提交
711
  ```ts
H
huangjie 已提交
712
  try {
H
huangjie 已提交
713
      this.context.resourceManager.getMediaContent($r('app.media.test').id).then(value => {
W
wplan1 已提交
714
          let media = value;
Z
zengyawen 已提交
715
      }).catch(error => {
H
huangjie 已提交
716
          console.log("getMediaContent promise error is " + error);
Z
zengyawen 已提交
717
      });
H
huangjie 已提交
718 719 720
  } catch (error) {
    console.error(`promise getMediaContent failed, error code: ${error.code}, message: ${error.message}.`)
  }
Z
zengyawen 已提交
721 722
  ```

H
huangjie 已提交
723
### getMediaContent<sup>9+</sup>
724

H
huangjie 已提交
725
getMediaContent(resource: Resource, callback: AsyncCallback&lt;Uint8Array&gt;): void
726 727 728 729 730 731

用户获取指定resource对象对应的媒体文件内容,使用callback形式返回字节数组。

**系统能力**:SystemCapability.Global.ResourceManager

**参数:** 
H
huangjie 已提交
732

H
HelloCrease 已提交
733 734 735
| 参数名      | 类型                              | 必填   | 说明                 |
| -------- | ------------------------------- | ---- | ------------------ |
| resource | [Resource](#resource9)          | 是    | 资源信息               |
736 737
| callback | AsyncCallback&lt;Uint8Array&gt; | 是    | 异步回调,用于返回获取的媒体文件内容 |

H
huangjie 已提交
738 739
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
740 741
**错误码:**

H
huangjie 已提交
742 743
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
744 745
| 9001001  | If the resId invalid.                       |
| 9001002  | If the resource not found by resId.         |
H
huangjie 已提交
746

747
**示例:** 
H
HelloCrease 已提交
748
  ```ts
749 750 751 752 753
  let resource = {
      bundleName: "com.example.myapplication",
      moduleName: "entry",
      id: $r('app.media.test').id
  };
H
huangjie 已提交
754 755 756
  try {
    this.context.resourceManager.getMediaContent(resource, (error, value) => {
        if (error != null) {
757
          console.log("error is " + error);
H
huangjie 已提交
758
        } else {
759
          let media = value;
H
huangjie 已提交
760 761 762 763 764
        }
    });
  } catch (error) {
    console.error(`callback getMediaContent failed, error code: ${error.code}, message: ${error.message}.`)
  }
765 766
  ```

H
huangjie 已提交
767
### getMediaContent<sup>9+</sup>
768

H
huangjie 已提交
769
getMediaContent(resource: Resource): Promise&lt;Uint8Array&gt;
770 771 772 773 774 775

用户获取指定resource对象对应的媒体文件内容,使用Promise形式返回字节数组。

**系统能力**:SystemCapability.Global.ResourceManager

**参数:** 
H
huangjie 已提交
776

H
HelloCrease 已提交
777 778
| 参数名      | 类型                     | 必填   | 说明   |
| -------- | ---------------------- | ---- | ---- |
779
| resource | [Resource](#resource9) | 是    | 资源信息 |
780

H
huangjie 已提交
781 782
**返回值:**

H
HelloCrease 已提交
783 784
| 类型                        | 说明                  |
| ------------------------- | ------------------- |
785 786
| Promise&lt;Uint8Array&gt; | resource对象对应的媒体文件内容 |

H
huangjie 已提交
787 788
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
789 790
**错误码:**

H
huangjie 已提交
791 792
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
793 794
| 9001001  | If the resId invalid.                       |
| 9001002  | If the resource not found by resId.         |
H
huangjie 已提交
795

796
**示例:** 
H
HelloCrease 已提交
797
  ```ts
798 799 800 801 802
  let resource = {
      bundleName: "com.example.myapplication",
      moduleName: "entry",
      id: $r('app.media.test').id
  };
H
huangjie 已提交
803 804
  try {
    this.context.resourceManager.getMediaContent(resource).then(value => {
805
      let media = value;
H
huangjie 已提交
806 807 808 809 810 811
    }).catch(error => {
      console.log("getMediaContent promise error is " + error);
    });
  } catch (error) {
    console.error(`promise getMediaContent failed, error code: ${error.code}, message: ${error.message}.`)
  }
812
  ```
Z
zengyawen 已提交
813 814


H
huangjie 已提交
815
### getMediaContentBase64<sup>9+</sup>
H
huangjie 已提交
816 817

getMediaContentBase64(resId: number, callback: AsyncCallback&lt;string&gt;): void
Z
zengyawen 已提交
818 819 820

用户获取指定资源ID对应的图片资源Base64编码,使用callback形式返回字符串。

V
VictoriaGuo 已提交
821 822
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
823
**参数:** 
H
huangjie 已提交
824

H
HelloCrease 已提交
825 826 827 828
| 参数名      | 类型                          | 必填   | 说明                       |
| -------- | --------------------------- | ---- | ------------------------ |
| resId    | number                      | 是    | 资源ID值                    |
| callback | AsyncCallback&lt;string&gt; | 是    | 异步回调,用于返回获取的图片资源Base64编码 |
Z
zengyawen 已提交
829

H
huangjie 已提交
830 831
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
832 833
**错误码:**

H
huangjie 已提交
834 835
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
836 837
| 9001001  | If the resId invalid.                       |
| 9001002  | If the resource not found by resId.         |
H
huangjie 已提交
838

H
HelloCrease 已提交
839
**示例:** 
H
HelloCrease 已提交
840
  ```ts
H
huangjie 已提交
841
  try {
H
huangjie 已提交
842
    this.context.resourceManager.getMediaContentBase64($r('app.media.test').id, (error, value) => {
H
huangjie 已提交
843 844 845 846 847 848 849 850 851
        if (error != null) {
            console.log("error is " + error);
        } else {
            let media = value;
        }
    });       
  } catch (error) {
    console.error(`callback getMediaContentBase64 failed, error code: ${error.code}, message: ${error.message}.`)
  }
Z
zengyawen 已提交
852 853 854
  ```


H
huangjie 已提交
855
### getMediaContentBase64<sup>9+</sup>
Z
zengyawen 已提交
856

H
huangjie 已提交
857
getMediaContentBase64(resId: number): Promise&lt;string&gt;
Z
zengyawen 已提交
858 859 860

用户获取指定资源ID对应的图片资源Base64编码,使用Promise形式返回字符串。

V
VictoriaGuo 已提交
861 862
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
863
**参数:** 
H
huangjie 已提交
864

H
HelloCrease 已提交
865 866 867
| 参数名   | 类型     | 必填   | 说明    |
| ----- | ------ | ---- | ----- |
| resId | number | 是    | 资源ID值 |
Z
zengyawen 已提交
868

H
huangjie 已提交
869 870
**返回值:**

H
HelloCrease 已提交
871 872 873
| 类型                    | 说明                   |
| --------------------- | -------------------- |
| Promise&lt;string&gt; | 资源ID值对应的图片资源Base64编码 |
Z
zengyawen 已提交
874

H
huangjie 已提交
875 876
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
877 878
**错误码:**

H
huangjie 已提交
879 880
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
881 882
| 9001001  | If the resId invalid.                       |
| 9001002  | If the resource not found by resId.         |
H
huangjie 已提交
883

H
HelloCrease 已提交
884
**示例:** 
H
HelloCrease 已提交
885
  ```ts
H
huangjie 已提交
886
  try {
H
huangjie 已提交
887
    this.context.resourceManager.getMediaContentBase64($r('app.media.test').id).then(value => {
H
huangjie 已提交
888 889 890 891 892 893 894
        let media = value;
    }).catch(error => {
        console.log("getMediaContentBase64 promise error is " + error);
    });
  } catch (error) {
    console.error(`promise getMediaContentBase64 failed, error code: ${error.code}, message: ${error.message}.`)
  } 
Z
zengyawen 已提交
895 896
  ```

H
huangjie 已提交
897
### getMediaContentBase64<sup>9+</sup>
898

H
huangjie 已提交
899
getMediaContentBase64(resource: Resource, callback: AsyncCallback&lt;string&gt;): void
900 901 902 903 904

用户获取指定resource对象对应的图片资源Base64编码,使用callback形式返回字符串。

**系统能力**:SystemCapability.Global.ResourceManager

H
huangjie 已提交
905 906
**参数:**

907 908
| 参数名      | 类型                          | 必填   | 说明                       |
| -------- | --------------------------- | ---- | ------------------------ |
H
HelloCrease 已提交
909
| resource | [Resource](#resource9)      | 是    | 资源信息                     |
910 911
| callback | AsyncCallback&lt;string&gt; | 是    | 异步回调,用于返回获取的图片资源Base64编码 |

H
huangjie 已提交
912 913
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
914 915
**错误码:**

H
huangjie 已提交
916 917
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
918 919
| 9001001  | If the resId invalid.                       |
| 9001002  | If the resource not found by resId.         |
H
huangjie 已提交
920

921
**示例:** 
H
HelloCrease 已提交
922
  ```ts
923 924 925 926 927
  let resource = {
      bundleName: "com.example.myapplication",
      moduleName: "entry",
      id: $r('app.media.test').id
  };
H
huangjie 已提交
928 929 930 931 932 933 934 935 936 937 938
  try {
    this.context.resourceManager.getMediaContentBase64(resource, (error, value) => {
        if (error != null) {
            console.log("error is " + error);
        } else {
            let media = value;
        }
    });
  } catch (error) {
    console.error(`promise getMediaContentBase64 failed, error code: ${error.code}, message: ${error.message}.`)
  }
939 940
  ```

H
huangjie 已提交
941
### getMediaContentBase64<sup>9+</sup>
942

H
huangjie 已提交
943
getMediaContentBase64(resource: Resource): Promise&lt;string&gt;
944 945 946 947 948 949

用户获取指定resource对象对应的图片资源Base64编码,使用Promise形式返回字符串。

**系统能力**:SystemCapability.Global.ResourceManager

**参数:** 
H
huangjie 已提交
950

H
HelloCrease 已提交
951 952
| 参数名      | 类型                     | 必填   | 说明   |
| -------- | ---------------------- | ---- | ---- |
953
| resource | [Resource](#resource9) | 是    | 资源信息 |
954

H
huangjie 已提交
955 956
**返回值:**

H
HelloCrease 已提交
957 958
| 类型                    | 说明                        |
| --------------------- | ------------------------- |
959 960
| Promise&lt;string&gt; | resource对象对应的图片资源Base64编码 |

H
huangjie 已提交
961 962
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
963 964
**错误码:**

H
huangjie 已提交
965 966
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
967 968
| 9001001  | If the resId invalid.                       |
| 9001002  | If the resource not found by resId.         |
H
huangjie 已提交
969

970
**示例:** 
H
HelloCrease 已提交
971
  ```ts
972 973 974 975 976
  let resource = {
      bundleName: "com.example.myapplication",
      moduleName: "entry",
      id: $r('app.media.test').id
  };
H
huangjie 已提交
977 978 979 980 981 982 983 984 985
  try {
    this.context.resourceManager.getMediaContentBase64(resource).then(value => {
        let media = value;
    }).catch(error => {
        console.log("getMediaContentBase64 promise error is " + error);
    });
  } catch (error) {
    console.error(`promise getMediaContentBase64 failed, error code: ${error.code}, message: ${error.message}.`)
  }
986 987
  ```

Z
zengyawen 已提交
988 989 990 991

### getConfiguration

getConfiguration(callback: AsyncCallback&lt;Configuration&gt;): void
Z
zengyawen 已提交
992 993 994

用户获取设备的Configuration,使用callback形式返回Configuration对象。

V
VictoriaGuo 已提交
995 996
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
997
**参数:** 
H
huangjie 已提交
998

H
HelloCrease 已提交
999 1000 1001
| 参数名      | 类型                                       | 必填   | 说明                        |
| -------- | ---------------------------------------- | ---- | ------------------------- |
| callback | AsyncCallback&lt;[Configuration](#configuration)&gt; | 是    | 异步回调,用于返回设备的Configuration |
Z
zengyawen 已提交
1002

H
HelloCrease 已提交
1003
**示例:** 
H
HelloCrease 已提交
1004
  ```ts
Z
zengyawen 已提交
1005 1006 1007
  resourceManager.getResourceManager((error, mgr) => {
      mgr.getConfiguration((error, value) => {
          if (error != null) {
W
wplan1 已提交
1008
              console.log("error is " + error);
Z
zengyawen 已提交
1009
          } else {
W
wplan1 已提交
1010 1011
              let direction = value.direction;
              let locale = value.locale;
Z
zengyawen 已提交
1012 1013 1014 1015
          }
      });
  });
  ```
Z
zengyawen 已提交
1016 1017


Z
zengyawen 已提交
1018
### getConfiguration
Z
zengyawen 已提交
1019

Z
zengyawen 已提交
1020 1021 1022
getConfiguration(): Promise&lt;Configuration&gt;

用户获取设备的Configuration,使用Promise形式返回Configuration对象。
Z
zengyawen 已提交
1023

V
VictoriaGuo 已提交
1024 1025
**系统能力**:SystemCapability.Global.ResourceManager

H
huangjie 已提交
1026 1027
**返回值:**

H
HelloCrease 已提交
1028 1029 1030
| 类型                                       | 说明               |
| ---------------------------------------- | ---------------- |
| Promise&lt;[Configuration](#configuration)&gt; | 设备的Configuration |
Z
zengyawen 已提交
1031

H
HelloCrease 已提交
1032
**示例:** 
H
HelloCrease 已提交
1033
  ```ts
Z
zengyawen 已提交
1034 1035
  resourceManager.getResourceManager((error, mgr) => {
      mgr.getConfiguration().then(value => {
W
wplan1 已提交
1036 1037
          let direction = value.direction;
          let locale = value.locale;
Z
zengyawen 已提交
1038
      }).catch(error => {
W
wplan1 已提交
1039
          console.log("getConfiguration promise error is " + error);
Z
zengyawen 已提交
1040 1041 1042
      });
  });
  ```
Z
zengyawen 已提交
1043 1044


Z
zengyawen 已提交
1045 1046 1047
### getDeviceCapability

getDeviceCapability(callback: AsyncCallback&lt;DeviceCapability&gt;): void
Z
zengyawen 已提交
1048 1049 1050

用户获取设备的DeviceCapability,使用callback形式返回DeviceCapability对象。

V
VictoriaGuo 已提交
1051 1052
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
1053
**参数:** 
H
huangjie 已提交
1054

H
HelloCrease 已提交
1055 1056 1057
| 参数名      | 类型                                       | 必填   | 说明                           |
| -------- | ---------------------------------------- | ---- | ---------------------------- |
| callback | AsyncCallback&lt;[DeviceCapability](#devicecapability)&gt; | 是    | 异步回调,用于返回设备的DeviceCapability |
Z
zengyawen 已提交
1058

H
HelloCrease 已提交
1059
**示例:** 
H
HelloCrease 已提交
1060
  ```ts
Z
zengyawen 已提交
1061 1062 1063
  resourceManager.getResourceManager((error, mgr) => {
      mgr.getDeviceCapability((error, value) => {
          if (error != null) {
W
wplan1 已提交
1064
              console.log("error is " + error);
Z
zengyawen 已提交
1065
          } else {
W
wplan1 已提交
1066 1067
              let screenDensity = value.screenDensity;
              let deviceType = value.deviceType;
Z
zengyawen 已提交
1068 1069 1070 1071
          }
      });
  });
  ```
Z
zengyawen 已提交
1072 1073


Z
zengyawen 已提交
1074
### getDeviceCapability
Z
zengyawen 已提交
1075

Z
zengyawen 已提交
1076 1077 1078
getDeviceCapability(): Promise&lt;DeviceCapability&gt;

用户获取设备的DeviceCapability,使用Promise形式返回DeviceCapability对象。
Z
zengyawen 已提交
1079

V
VictoriaGuo 已提交
1080 1081
**系统能力**:SystemCapability.Global.ResourceManager

H
huangjie 已提交
1082 1083
**返回值:**

H
HelloCrease 已提交
1084 1085 1086
| 类型                                       | 说明                  |
| ---------------------------------------- | ------------------- |
| Promise&lt;[DeviceCapability](#devicecapability)&gt; | 设备的DeviceCapability |
Z
zengyawen 已提交
1087

H
HelloCrease 已提交
1088
**示例:** 
H
HelloCrease 已提交
1089
  ```ts
Z
zengyawen 已提交
1090 1091
  resourceManager.getResourceManager((error, mgr) => {
      mgr.getDeviceCapability().then(value => {
W
wplan1 已提交
1092 1093
          let screenDensity = value.screenDensity;
          let deviceType = value.deviceType;
Z
zengyawen 已提交
1094
      }).catch(error => {
W
wplan1 已提交
1095
          console.log("getDeviceCapability promise error is " + error);
Z
zengyawen 已提交
1096 1097 1098
      });
  });
  ```
Z
zengyawen 已提交
1099 1100


H
huangjie 已提交
1101
### getPluralStringValue<sup>9+</sup>
Z
zengyawen 已提交
1102

H
huangjie 已提交
1103
getPluralStringValue(resId: number, num: number, callback: AsyncCallback&lt;string&gt;): void
Z
zengyawen 已提交
1104 1105 1106

根据指定数量获取指定ID字符串表示的单复数字符串,使用callback形式返回字符串。

V
VictoriaGuo 已提交
1107 1108
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
1109
**参数:** 
H
huangjie 已提交
1110

H
HelloCrease 已提交
1111 1112 1113 1114 1115
| 参数名      | 类型                          | 必填   | 说明                              |
| -------- | --------------------------- | ---- | ------------------------------- |
| resId    | number                      | 是    | 资源ID值                           |
| num      | number                      | 是    | 数量值                             |
| callback | AsyncCallback&lt;string&gt; | 是    | 异步回调,返回根据指定数量获取指定ID字符串表示的单复数字符串 |
Z
zengyawen 已提交
1116

H
huangjie 已提交
1117 1118
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
1119 1120
**错误码:**

H
huangjie 已提交
1121 1122
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
1123 1124 1125
| 9001001  | If the resId invalid.                       |
| 9001002  | If the resource not found by resId.         |
| 9001006  | If the resource re-ref too much.            |
H
huangjie 已提交
1126

H
HelloCrease 已提交
1127
**示例:** 
H
HelloCrease 已提交
1128
  ```ts
H
huangjie 已提交
1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139
  try {
    this.context.resourceManager.getPluralStringValue($r("app.plural.test").id, 1, (error, value) => {
        if (error != null) {
            console.log("error is " + error);
        } else {
            let str = value;
        }
    });
  } catch (error) {
    console.error(`callback getPluralStringValue failed, error code: ${error.code}, message: ${error.message}.`)
  }   
Z
zengyawen 已提交
1140
  ```
Z
zengyawen 已提交
1141 1142


H
huangjie 已提交
1143
### getPluralStringValue<sup>9+</sup>
Z
zengyawen 已提交
1144

H
huangjie 已提交
1145
getPluralStringValue(resId: number, num: number): Promise&lt;string&gt;
Z
zengyawen 已提交
1146 1147

根据指定数量获取对指定ID字符串表示的单复数字符串,使用Promise形式返回字符串。
Z
zengyawen 已提交
1148

V
VictoriaGuo 已提交
1149 1150
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
1151
**参数:** 
H
huangjie 已提交
1152

H
HelloCrease 已提交
1153 1154 1155 1156
| 参数名   | 类型     | 必填   | 说明    |
| ----- | ------ | ---- | ----- |
| resId | number | 是    | 资源ID值 |
| num   | number | 是    | 数量值   |
Z
zengyawen 已提交
1157

H
huangjie 已提交
1158 1159
**返回值:**

H
HelloCrease 已提交
1160 1161 1162
| 类型                    | 说明                        |
| --------------------- | ------------------------- |
| Promise&lt;string&gt; | 根据提供的数量获取对应ID字符串表示的单复数字符串 |
Z
zengyawen 已提交
1163

H
huangjie 已提交
1164 1165
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
1166 1167
**错误码:**

H
huangjie 已提交
1168 1169
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
1170 1171 1172
| 9001001  | If the resId invalid.                       |
| 9001002  | If the resource not found by resId.         |
| 9001006  | If the resource re-ref too much.            |
H
huangjie 已提交
1173

H
HelloCrease 已提交
1174
**示例:** 
H
HelloCrease 已提交
1175
  ```ts
H
huangjie 已提交
1176 1177 1178 1179 1180 1181 1182 1183 1184
  try {
    this.context.resourceManager.getPluralStringValue($r("app.plural.test").id, 1).then(value => {
        let str = value;
    }).catch(error => {
        console.log("getPluralStringValue promise error is " + error);
    });
  } catch (error) {
    console.error(`callback getPluralStringValue failed, error code: ${error.code}, message: ${error.message}.`)
  }  
Z
zengyawen 已提交
1185
  ```
Z
zengyawen 已提交
1186

H
huangjie 已提交
1187
### getPluralStringValue<sup>9+</sup>
1188

H
huangjie 已提交
1189
getPluralStringValue(resource: Resource, num: number, callback: AsyncCallback&lt;string&gt;): void
1190 1191 1192 1193 1194 1195

根据指定数量获取指定resource对象表示的单复数字符串,使用callback形式返回字符串。

**系统能力**:SystemCapability.Global.ResourceManager

**参数:** 
H
huangjie 已提交
1196

H
HelloCrease 已提交
1197 1198 1199 1200
| 参数名      | 类型                          | 必填   | 说明                                   |
| -------- | --------------------------- | ---- | ------------------------------------ |
| resource | [Resource](#resource9)      | 是    | 资源信息                                 |
| num      | number                      | 是    | 数量值                                  |
1201 1202
| callback | AsyncCallback&lt;string&gt; | 是    | 异步回调,返回根据指定数量获取指定resource对象表示的单复数字符串 |

H
huangjie 已提交
1203 1204
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
1205 1206
**错误码:**

H
huangjie 已提交
1207 1208
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
1209 1210 1211
| 9001001  | If the resId invalid.                       |
| 9001002  | If the resource not found by resId.         |
| 9001006  | If the resource re-ref too much.            |
H
huangjie 已提交
1212

1213
**示例:** 
H
HelloCrease 已提交
1214
  ```ts
1215 1216 1217 1218 1219
  let resource = {
      bundleName: "com.example.myapplication",
      moduleName: "entry",
      id: $r('app.plural.test').id
  };
H
huangjie 已提交
1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231
  try {
    this.context.resourceManager.getPluralStringValue(resource, 1, (error, value) => {
        if (error != null) {
            console.log("error is " + error);
        } else {
            let str = value;
        }
    });
  } catch (error) {
    console.error(`callback getPluralStringValue failed, error code: ${error.code}, message: ${error.message}.`)
  }  
  
1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242
  ```

### getPluralString<sup>9+</sup>

getPluralString(resource: Resource, num: number): Promise&lt;string&gt;

根据指定数量获取对指定resource对象表示的单复数字符串,使用Promise形式返回字符串。

**系统能力**:SystemCapability.Global.ResourceManager

**参数:** 
H
huangjie 已提交
1243

H
HelloCrease 已提交
1244 1245
| 参数名      | 类型                     | 必填   | 说明   |
| -------- | ---------------------- | ---- | ---- |
1246
| resource | [Resource](#resource9) | 是    | 资源信息 |
H
HelloCrease 已提交
1247
| num      | number                 | 是    | 数量值  |
1248

H
huangjie 已提交
1249 1250
**返回值:**

H
HelloCrease 已提交
1251 1252
| 类型                    | 说明                             |
| --------------------- | ------------------------------ |
1253 1254
| Promise&lt;string&gt; | 根据提供的数量获取对应resource对象表示的单复数字符串 |

H
huangjie 已提交
1255 1256
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
1257 1258
**错误码:**

H
huangjie 已提交
1259 1260
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
1261 1262 1263
| 9001001  | If the resId invalid.                       |
| 9001002  | If the resource not found by resId.         |
| 9001006  | If the resource re-ref too much.            |
H
huangjie 已提交
1264

1265
**示例:** 
H
HelloCrease 已提交
1266
  ```ts
1267 1268 1269 1270 1271
  let resource = {
      bundleName: "com.example.myapplication",
      moduleName: "entry",
      id: $r('app.plural.test').id
  };
H
huangjie 已提交
1272 1273 1274 1275 1276 1277 1278 1279 1280
  try {
    this.context.resourceManager.getPluralString(resource, 1).then(value => {
        let str = value;
    }).catch(error => {
        console.log("getPluralString promise error is " + error);
    });
  } catch (error) {
    console.error(`callback getPluralStringValue failed, error code: ${error.code}, message: ${error.message}.`)
  }
1281 1282
  ```

Z
zengyawen 已提交
1283

H
huangjie 已提交
1284 1285 1286
### getRawFileContent<sup>9+</sup>

getRawFileContent(path: string, callback: AsyncCallback&lt;Uint8Array&gt;): void
Z
zengyawen 已提交
1287

H
huangjie 已提交
1288
用户获取resources/rawfile目录下对应的rawfile文件内容,使用callback形式返回字节数组。
Z
zengyawen 已提交
1289

V
VictoriaGuo 已提交
1290 1291
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
1292
**参数:** 
H
huangjie 已提交
1293

H
HelloCrease 已提交
1294 1295 1296 1297
| 参数名      | 类型                              | 必填   | 说明                      |
| -------- | ------------------------------- | ---- | ----------------------- |
| path     | string                          | 是    | rawfile文件路径             |
| callback | AsyncCallback&lt;Uint8Array&gt; | 是    | 异步回调,用于返回获取的rawfile文件内容 |
Z
zengyawen 已提交
1298

H
huangjie 已提交
1299 1300
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
1301 1302
**错误码:**

H
huangjie 已提交
1303 1304
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
1305
| 9001005  | If the resource not found by path.          |
H
huangjie 已提交
1306

H
HelloCrease 已提交
1307
**示例:** 
H
HelloCrease 已提交
1308
  ```ts
H
huangjie 已提交
1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320
  try {
    this.context.resourceManager.getRawFileContent("test.xml", (error, value) => {
        if (error != null) {
            console.log("error is " + error);
        } else {
            let rawFile = value;
        }
    });
  } catch (error) {
    console.error(`callback getRawFileContent failed, error code: ${error.code}, message: ${error.message}.`)
  }
      
Z
zengyawen 已提交
1321 1322
  ```

H
huangjie 已提交
1323
### getRawFileContent<sup>9+</sup>
Z
zengyawen 已提交
1324

H
huangjie 已提交
1325
getRawFileContent(path: string): Promise&lt;Uint8Array&gt;
Z
zengyawen 已提交
1326

H
huangjie 已提交
1327
用户获取resources/rawfile目录下对应的rawfile文件内容,使用Promise形式返回字节数组。
Z
zengyawen 已提交
1328

V
VictoriaGuo 已提交
1329 1330
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
1331
**参数:** 
H
huangjie 已提交
1332

H
HelloCrease 已提交
1333 1334 1335
| 参数名  | 类型     | 必填   | 说明          |
| ---- | ------ | ---- | ----------- |
| path | string | 是    | rawfile文件路径 |
Z
zengyawen 已提交
1336

H
huangjie 已提交
1337 1338
**返回值:**

H
HelloCrease 已提交
1339 1340 1341
| 类型                        | 说明          |
| ------------------------- | ----------- |
| Promise&lt;Uint8Array&gt; | rawfile文件内容 |
Z
zengyawen 已提交
1342

H
huangjie 已提交
1343 1344
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
1345 1346
**错误码:**

H
huangjie 已提交
1347 1348
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
1349
| 9001005  | If the resource not found by path.          |
H
huangjie 已提交
1350

H
HelloCrease 已提交
1351
**示例:** 
H
HelloCrease 已提交
1352
  ```ts
H
huangjie 已提交
1353 1354 1355 1356 1357 1358 1359 1360 1361
  try {
    this.context.resourceManager.getRawFileContent("test.xml").then(value => {
        let rawFile = value;
    }).catch(error => {
        console.log("getRawFileContent promise error is " + error);
    });
  } catch (error) {
    console.error(`promise getRawFileContent failed, error code: ${error.code}, message: ${error.message}.`)
  }
Z
zengyawen 已提交
1362
  ```
W
wplan1 已提交
1363 1364


H
huangjie 已提交
1365 1366 1367
### getRawFd<sup>9+</sup>

getRawFd(path: string, callback: AsyncCallback&lt;RawFileDescriptor&gt;): void
W
wplan1 已提交
1368

H
huangjie 已提交
1369
用户获取resources/rawfile目录下对应rawfile文件的descriptor,使用callback形式返回。
W
wplan1 已提交
1370 1371 1372

**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
1373
**参数:** 
H
huangjie 已提交
1374

H
HelloCrease 已提交
1375 1376 1377
| 参数名      | 类型                                       | 必填   | 说明                               |
| -------- | ---------------------------------------- | ---- | -------------------------------- |
| path     | string                                   | 是    | rawfile文件路径                      |
H
huangjie 已提交
1378
| callback | AsyncCallback&lt;[RawFileDescriptor](#rawfiledescriptor8)&gt; | 是    | 异步回调,用于返回获取的rawfile文件的descriptor |
H
huangjie 已提交
1379 1380 1381

以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
1382 1383
**错误码:**

H
huangjie 已提交
1384 1385
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
1386
| 9001005  | If the resource not found by path.          |
W
wplan1 已提交
1387

H
HelloCrease 已提交
1388
**示例:** 
H
HelloCrease 已提交
1389
  ```ts
H
huangjie 已提交
1390 1391 1392
  try {
    this.context.resourceManager.getRawFd("test.xml", (error, value) => {
        if (error != null) {
H
huangjie 已提交
1393
            console.log(`callback getRawFd failed error code: ${error.code}, message: ${error.message}.`);
H
huangjie 已提交
1394 1395 1396 1397 1398
        } else {
            let fd = value.fd;
            let offset = value.offset;
            let length = value.length;
        }
H
huangjie 已提交
1399 1400 1401 1402
    });
  } catch (error) {
      console.error(`callback getRawFd failed, error code: ${error.code}, message: ${error.message}.`)
  };
W
wplan1 已提交
1403 1404
  ```

H
huangjie 已提交
1405
### getRawFd<sup>9+</sup>
W
wplan1 已提交
1406

H
huangjie 已提交
1407
getRawFd(path: string): Promise&lt;RawFileDescriptor&gt;
W
wplan1 已提交
1408

H
huangjie 已提交
1409
用户获取resources/rawfile目录下对应rawfile文件的descriptor,使用Promise形式返回。
W
wplan1 已提交
1410 1411 1412

**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
1413
**参数:** 
H
huangjie 已提交
1414

H
HelloCrease 已提交
1415 1416 1417
| 参数名  | 类型     | 必填   | 说明          |
| ---- | ------ | ---- | ----------- |
| path | string | 是    | rawfile文件路径 |
W
wplan1 已提交
1418

H
huangjie 已提交
1419 1420
**返回值:**

H
HelloCrease 已提交
1421 1422
| 类型                                       | 说明                  |
| ---------------------------------------- | ------------------- |
H
huangjie 已提交
1423
| Promise&lt;[RawFileDescriptor](#rawfiledescriptor8)&gt; | rawfile文件descriptor |
H
huangjie 已提交
1424 1425 1426

以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
1427 1428
**错误码:**

H
huangjie 已提交
1429 1430
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
1431
| 9001005  | If the resource not found by path.          |
W
wplan1 已提交
1432

H
HelloCrease 已提交
1433
**示例:** 
H
HelloCrease 已提交
1434
  ```ts
H
huangjie 已提交
1435 1436 1437 1438 1439 1440
  try {
    this.context.resourceManager.getRawFd("test.xml").then(value => {
        let fd = value.fd;
        let offset = value.offset;
        let length = value.length;
    }).catch(error => {
H
huangjie 已提交
1441
        console.log(`promise getRawFd error error code: ${error.code}, message: ${error.message}.`);
H
huangjie 已提交
1442 1443
    });
  } catch (error) {
H
huangjie 已提交
1444
    console.error(`promise getRawFd failed, error code: ${error.code}, message: ${error.message}.`);
H
huangjie 已提交
1445
  };
W
wplan1 已提交
1446 1447 1448 1449 1450 1451
  ```

### closeRawFileDescriptor<sup>8+</sup>

closeRawFileDescriptor(path: string, callback: AsyncCallback&lt;void&gt;): void

H
huangjie 已提交
1452
用户关闭resources/rawfile目录下rawfile文件的descriptor,使用callback形式返回。
W
wplan1 已提交
1453 1454 1455

**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
1456
**参数:** 
H
huangjie 已提交
1457

H
HelloCrease 已提交
1458 1459 1460 1461
| 参数名      | 类型                        | 必填   | 说明          |
| -------- | ------------------------- | ---- | ----------- |
| path     | string                    | 是    | rawfile文件路径 |
| callback | AsyncCallback&lt;void&gt; | 是    | 异步回调        |
W
wplan1 已提交
1462

H
HelloCrease 已提交
1463
**示例:** 
H
HelloCrease 已提交
1464
  ```ts
W
wplan1 已提交
1465 1466 1467
  resourceManager.getResourceManager((error, mgr) => {
      mgr.closeRawFileDescriptor("test.xml", (error, value) => {
          if (error != null) {
W
wplan1 已提交
1468
              console.log("error is " + error);
W
wplan1 已提交
1469 1470 1471 1472 1473 1474 1475 1476 1477
          }
      });
  });
  ```

### closeRawFileDescriptor<sup>8+</sup>

closeRawFileDescriptor(path: string): Promise&lt;void&gt;

H
huangjie 已提交
1478
用户关闭resources/rawfile目录下rawfile文件的descriptor,使用Promise形式返回。
W
wplan1 已提交
1479 1480 1481

**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
1482
**参数:** 
H
huangjie 已提交
1483

H
HelloCrease 已提交
1484 1485 1486
| 参数名  | 类型     | 必填   | 说明          |
| ---- | ------ | ---- | ----------- |
| path | string | 是    | rawfile文件路径 |
W
wplan1 已提交
1487

H
huangjie 已提交
1488 1489
**返回值:**

H
HelloCrease 已提交
1490 1491 1492
| 类型                  | 说明   |
| ------------------- | ---- |
| Promise&lt;void&gt; | 无返回值 |
W
wplan1 已提交
1493

H
HelloCrease 已提交
1494
**示例:** 
H
HelloCrease 已提交
1495
  ```ts
W
wplan1 已提交
1496 1497
  resourceManager.getResourceManager((error, mgr) => {
      mgr.closeRawFileDescriptor("test.xml").then(value => {
W
wplan1 已提交
1498
          let result = value;
W
wplan1 已提交
1499
      }).catch(error => {
W
wplan1 已提交
1500
          console.log("closeRawFileDescriptor promise error is " + error);
W
wplan1 已提交
1501 1502 1503 1504 1505
      });
  });
  ```


H
huangjie 已提交
1506
### closeRawFd<sup>9+</sup>
W
wplan1 已提交
1507

H
huangjie 已提交
1508
closeRawFd(path: string, callback: AsyncCallback&lt;void&gt;): void
H
huangjie 已提交
1509

H
huangjie 已提交
1510
用户关闭resources/rawfile目录下rawfile文件的descriptor,使用callback形式返回。
H
huangjie 已提交
1511

H
huangjie 已提交
1512
**系统能力**:SystemCapability.Global.ResourceManager
H
huangjie 已提交
1513

H
huangjie 已提交
1514
**参数:** 
H
huangjie 已提交
1515

H
huangjie 已提交
1516 1517 1518 1519
| 参数名      | 类型                        | 必填   | 说明          |
| -------- | ------------------------- | ---- | ----------- |
| path     | string                    | 是    | rawfile文件路径 |
| callback | AsyncCallback&lt;void&gt; | 是    | 异步回调        |
H
huangjie 已提交
1520

H
huangjie 已提交
1521
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)
H
huangjie 已提交
1522

H
huangjie 已提交
1523 1524
**错误码:**

H
huangjie 已提交
1525 1526 1527
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 9001005  | The resource not found by path.          |
H
huangjie 已提交
1528

H
huangjie 已提交
1529
**示例:** 
H
HelloCrease 已提交
1530
  ```ts
H
huangjie 已提交
1531
  try {
H
huangjie 已提交
1532
    this.context.resourceManager.closeRawFd("test.xml", (error, value) => {
H
huangjie 已提交
1533 1534 1535 1536 1537 1538 1539 1540
        if (error != null) {
            console.log("error is " + error);
        }
    });
  } catch (error) {
    console.error(`callback closeRawFd failed, error code: ${error.code}, message: ${error.message}.`)
  }
      
H
huangjie 已提交
1541 1542
  ```

H
huangjie 已提交
1543
### closeRawFd<sup>8+</sup>
H
huangjie 已提交
1544

H
huangjie 已提交
1545
closeRawFd(path: string): Promise&lt;void&gt;
H
huangjie 已提交
1546

H
huangjie 已提交
1547 1548 1549 1550 1551
用户关闭resources/rawfile目录下rawfile文件的descriptor,使用Promise形式返回。

**系统能力**:SystemCapability.Global.ResourceManager

**参数:** 
H
huangjie 已提交
1552

H
huangjie 已提交
1553 1554 1555 1556
| 参数名  | 类型     | 必填   | 说明          |
| ---- | ------ | ---- | ----------- |
| path | string | 是    | rawfile文件路径 |

H
huangjie 已提交
1557 1558
**返回值:**

H
huangjie 已提交
1559 1560 1561 1562 1563 1564
| 类型                  | 说明   |
| ------------------- | ---- |
| Promise&lt;void&gt; | 无返回值 |

以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
1565 1566
**错误码:**

H
huangjie 已提交
1567 1568
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
1569
| 9001005  | If the resource not found by path.          |
H
huangjie 已提交
1570 1571 1572 1573

**示例:** 
  ```ts
  try {
H
huangjie 已提交
1574
    this.context.resourceManager.closeRawFd("test.xml").then(value => {
H
huangjie 已提交
1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607
        let result = value;
    }).catch(error => {
        console.log("closeRawFd promise error is " + error);
    });
  } catch (error) {
    console.error(`promise closeRawFd failed, error code: ${error.code}, message: ${error.message}.`)
  }
  ```

### release<sup>7+</sup>

release()

用户释放创建的resourceManager。

**系统能力**:SystemCapability.Global.ResourceManager

**示例:** 
  ```ts
  resourceManager.getResourceManager((error, mgr) => {
      mgr.release();
  });
  ```

### getStringByName<sup>9+</sup>

getStringByName(resName: string, callback: AsyncCallback&lt;string&gt;): void

用户获取指定资源名称对应的字符串,使用callback形式返回字符串。

**系统能力**:SystemCapability.Global.ResourceManager

**参数:**
H
huangjie 已提交
1608

H
huangjie 已提交
1609 1610 1611 1612 1613 1614 1615
| 参数名      | 类型                          | 必填   | 说明              |
| -------- | --------------------------- | ---- | --------------- |
| resName  | string                      | 是    | 资源名称            |
| callback | AsyncCallback&lt;string&gt; | 是    | 异步回调,用于返回获取的字符串 |

以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
1616 1617
**错误码:**

H
huangjie 已提交
1618 1619
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
1620 1621 1622
| 9001003  | If the resName invalid.                     |
| 9001004  | If the resource not found by resName.       |
| 9001006  | If the resource re-ref too much.            |
H
huangjie 已提交
1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644

**示例:**
  ```ts
  try {
    this.context.resourceManager.getStringByName("test", (error, value) => {
        if (error != null) {
             console.log("error is " + error);
        } else {
            let string = value;
        }
    });
  } catch (error) {
    console.error(`callback getStringByName failed, error code: ${error.code}, message: ${error.message}.`)
  }
  
  ```

### getStringByName<sup>9+</sup>

getStringByName(resName: string): Promise&lt;string&gt;

用户获取指定资源名称对应的字符串,使用Promise形式返回字符串。
H
huangjie 已提交
1645 1646 1647 1648

**系统能力**:SystemCapability.Global.ResourceManager

**参数:**
H
huangjie 已提交
1649

H
HelloCrease 已提交
1650
| 参数名     | 类型     | 必填   | 说明   |
H
huangjie 已提交
1651
| ------- | ------ | ---- | ---- |
H
HelloCrease 已提交
1652
| resName | string | 是    | 资源名称 |
H
huangjie 已提交
1653 1654

**返回值:**
H
huangjie 已提交
1655

H
HelloCrease 已提交
1656 1657
| 类型                    | 说明         |
| --------------------- | ---------- |
H
huangjie 已提交
1658 1659
| Promise&lt;string&gt; | 资源名称对应的字符串 |

H
huangjie 已提交
1660 1661
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
1662 1663
**错误码:**

H
huangjie 已提交
1664 1665
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
1666 1667 1668
| 9001003  | If the resName invalid.                     |
| 9001004  | If the resource not found by resName.       |
| 9001006  | If the resource re-ref too much.            |
H
huangjie 已提交
1669

H
huangjie 已提交
1670
**示例:**
H
HelloCrease 已提交
1671
  ```ts
H
huangjie 已提交
1672 1673 1674 1675 1676 1677 1678 1679 1680
  try {
    this.context.resourceManager.getStringByName("test").then(value => {
        let string = value;
    }).catch(error => {
        console.log("getStringByName promise error is " + error);
    });
  } catch (error) {
    console.error(`promise getStringByName failed, error code: ${error.code}, message: ${error.message}.`)
  }
H
huangjie 已提交
1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691
  ```

### getStringArrayByName<sup>9+</sup>

getStringArrayByName(resName: string, callback: AsyncCallback&lt;Array&lt;string&gt;&gt;): void

用户获取指定资源名称对应的字符串数组,使用callback形式返回字符串数组。

**系统能力**:SystemCapability.Global.ResourceManager

**参数:**
H
huangjie 已提交
1692

H
huangjie 已提交
1693 1694
| 参数名      | 类型                                       | 必填   | 说明                |
| -------- | ---------------------------------------- | ---- | ----------------- |
H
HelloCrease 已提交
1695
| resName  | string                                   | 是    | 资源名称              |
H
huangjie 已提交
1696 1697
| callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是    | 异步回调,用于返回获取的字符串数组 |

H
huangjie 已提交
1698 1699
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
1700 1701
**错误码:**

H
huangjie 已提交
1702 1703
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
1704 1705 1706
| 9001003  | If the resName invalid.                     |
| 9001004  | If the resource not found by resName.       |
| 9001006  | If the resource re-ref too much.            |
H
huangjie 已提交
1707

H
huangjie 已提交
1708
**示例:** 
H
HelloCrease 已提交
1709
  ```ts
H
huangjie 已提交
1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720
  try {
    this.context.resourceManager.getStringArrayByName("test", (error, value) => {
        if (error != null) {
            console.log("error is " + error);
        } else {
            let strArray = value;
        }
    });
  } catch (error) {
    console.error(`callback getStringArrayByName failed, error code: ${error.code}, message: ${error.message}.`)
  }
H
huangjie 已提交
1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731
  ```

### getStringArrayByName<sup>9+</sup>

getStringArrayByName(resName: string): Promise&lt;Array&lt;string&gt;&gt;

用户获取指定资源名称对应的字符串数组,使用Promise形式返回字符串数组。

**系统能力**:SystemCapability.Global.ResourceManager

**参数:** 
H
huangjie 已提交
1732

H
HelloCrease 已提交
1733 1734 1735
| 参数名     | 类型     | 必填   | 说明   |
| ------- | ------ | ---- | ---- |
| resName | string | 是    | 资源名称 |
H
huangjie 已提交
1736

H
huangjie 已提交
1737 1738
**返回值:**

H
HelloCrease 已提交
1739 1740
| 类型                                 | 说明           |
| ---------------------------------- | ------------ |
H
huangjie 已提交
1741 1742
| Promise&lt;Array&lt;string&gt;&gt; | 资源名称对应的字符串数组 |

H
huangjie 已提交
1743 1744
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
1745 1746
**错误码:**

H
huangjie 已提交
1747 1748
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
1749 1750 1751
| 9001003  | If the resName invalid.                     |
| 9001004  | If the resource not found by resName.       |
| 9001006  | If the resource re-ref too much.            |
H
huangjie 已提交
1752

H
huangjie 已提交
1753
**示例:** 
H
HelloCrease 已提交
1754
  ```ts
H
huangjie 已提交
1755 1756 1757 1758 1759 1760 1761 1762 1763
  try {
    this.context.resourceManager.getStringArrayByName("test").then(value => {
        let strArray = value;
    }).catch(error => {
        console.log("getStringArrayByName promise error is " + error);
    });
  } catch (error) {
    console.error(`promise getStringArrayByName failed, error code: ${error.code}, message: ${error.message}.`)
  }
H
huangjie 已提交
1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774
  ```

### getMediaByName<sup>9+</sup>

getMediaByName(resName: string, callback: AsyncCallback&lt;Uint8Array&gt;): void

用户获取指定资源ID对应的媒体文件内容,使用callback形式返回字节数组。

**系统能力**:SystemCapability.Global.ResourceManager

**参数:** 
H
huangjie 已提交
1775

H
huangjie 已提交
1776 1777
| 参数名      | 类型                              | 必填   | 说明                 |
| -------- | ------------------------------- | ---- | ------------------ |
H
HelloCrease 已提交
1778
| resName  | string                          | 是    | 资源名称               |
H
huangjie 已提交
1779 1780
| callback | AsyncCallback&lt;Uint8Array&gt; | 是    | 异步回调,用于返回获取的媒体文件内容 |

H
huangjie 已提交
1781 1782
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
1783 1784
**错误码:**

H
huangjie 已提交
1785 1786
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
1787 1788 1789
| 9001003  | If the resName invalid.                     |
| 9001004  | If the resource not found by resName.       |
| 9001006  | If the resource re-ref too much.            |
H
huangjie 已提交
1790

H
huangjie 已提交
1791
**示例:** 
H
HelloCrease 已提交
1792
  ```ts
H
huangjie 已提交
1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803
  try {
    this.context.resourceManager.getMediaByName("test", (error, value) => {
        if (error != null) {
            console.log("error is " + error);
        } else {
            let media = value;
        }
    });
  } catch (error) {
    console.error(`callback getMediaByName failed, error code: ${error.code}, message: ${error.message}.`)
  }
H
huangjie 已提交
1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814
  ```

### getMediaByName<sup>9+</sup>

getMediaByName(resName: string): Promise&lt;Uint8Array&gt;

用户获取指定资源名称对应的媒体文件内容,使用Promise形式返回字节数组。

**系统能力**:SystemCapability.Global.ResourceManager

**参数:** 
H
huangjie 已提交
1815

H
HelloCrease 已提交
1816 1817
| 参数名     | 类型     | 必填   | 说明   |
| ------- | ------ | ---- | ---- |
H
huangjie 已提交
1818 1819
| resName | string | 是    | 资源名称 |

H
huangjie 已提交
1820 1821
**返回值:**

H
HelloCrease 已提交
1822 1823
| 类型                        | 说明            |
| ------------------------- | ------------- |
H
huangjie 已提交
1824 1825
| Promise&lt;Uint8Array&gt; | 资源名称对应的媒体文件内容 |

H
huangjie 已提交
1826 1827
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
1828 1829
**错误码:**

H
huangjie 已提交
1830 1831
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
1832 1833 1834
| 9001003  | If the resName invalid.                     |
| 9001004  | If the resource not found by resName.       |
| 9001006  | If the resource re-ref too much.            |
H
huangjie 已提交
1835

H
huangjie 已提交
1836
**示例:** 
H
HelloCrease 已提交
1837
  ```ts
H
huangjie 已提交
1838 1839 1840 1841 1842 1843 1844 1845 1846
  try {
    this.context.resourceManager.getMediaByName("test").then(value => {
        let media = value;
    }).catch(error => {
        console.log("getMediaByName promise error is " + error);
    });
  } catch (error) {
    console.error(`promise getMediaByName failed, error code: ${error.code}, message: ${error.message}.`)
  }
H
huangjie 已提交
1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857
  ```

### getMediaBase64ByName<sup>9+</sup>

getMediaBase64ByName(resName: string, callback: AsyncCallback&lt;string&gt;): void

用户获取指定资源名称对应的图片资源Base64编码,使用callback形式返回字符串。

**系统能力**:SystemCapability.Global.ResourceManager

**参数:** 
H
huangjie 已提交
1858

H
huangjie 已提交
1859 1860
| 参数名      | 类型                          | 必填   | 说明                       |
| -------- | --------------------------- | ---- | ------------------------ |
H
HelloCrease 已提交
1861
| resName  | string                      | 是    | 资源名称                     |
H
huangjie 已提交
1862 1863
| callback | AsyncCallback&lt;string&gt; | 是    | 异步回调,用于返回获取的图片资源Base64编码 |

H
huangjie 已提交
1864 1865
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
1866 1867
**错误码:**

H
huangjie 已提交
1868 1869
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
1870 1871 1872
| 9001003  | If the resName invalid.                     |
| 9001004  | If the resource not found by resName.       |
| 9001006  | If the resource re-ref too much.            |
H
huangjie 已提交
1873

H
huangjie 已提交
1874
**示例:** 
H
HelloCrease 已提交
1875
  ```ts
H
huangjie 已提交
1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886
  try {
    this.context.resourceManager.getMediaBase64ByName("test", (error, value) => {
        if (error != null) {
            console.log("error is " + error);
        } else {
            let media = value;
        }
    });
  } catch (error) {
    console.error(`callback getMediaBase64ByName failed, error code: ${error.code}, message: ${error.message}.`)
  }
H
huangjie 已提交
1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897
  ```

### getMediaBase64ByName<sup>9+</sup>

getMediaBase64ByName(resName: string): Promise&lt;string&gt;

用户获取指定资源名称对应的图片资源Base64编码,使用Promise形式返回字符串。

**系统能力**:SystemCapability.Global.ResourceManager

**参数:** 
H
huangjie 已提交
1898

H
HelloCrease 已提交
1899 1900 1901
| 参数名     | 类型     | 必填   | 说明   |
| ------- | ------ | ---- | ---- |
| resName | string | 是    | 资源名称 |
H
huangjie 已提交
1902

H
huangjie 已提交
1903 1904
**返回值:**

H
HelloCrease 已提交
1905 1906
| 类型                    | 说明                  |
| --------------------- | ------------------- |
H
huangjie 已提交
1907 1908
| Promise&lt;string&gt; | 资源名称对应的图片资源Base64编码 |

H
huangjie 已提交
1909 1910
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
1911 1912
**错误码:**

H
huangjie 已提交
1913 1914
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
1915 1916 1917
| 9001003  | If the resName invalid.                     |
| 9001004  | If the resource not found by resName.       |
| 9001006  | If the resource re-ref too much.            |
H
huangjie 已提交
1918

H
huangjie 已提交
1919
**示例:** 
H
HelloCrease 已提交
1920
  ```ts
H
huangjie 已提交
1921 1922 1923 1924 1925 1926 1927 1928 1929
  try {
    this.context.resourceManager.getMediaBase64ByName("test").then(value => {
        let media = value;
    }).catch(error => {
        console.log("getMediaBase64ByName promise error is " + error);
    });
  } catch (error) {
    console.error(`promise getMediaBase64ByName failed, error code: ${error.code}, message: ${error.message}.`)
  }
H
huangjie 已提交
1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940
  ```

### getPluralStringByName<sup>9+</sup>

getPluralStringByName(resName: string, num: number, callback: AsyncCallback&lt;string&gt;): void

根据传入的数量值,获取资源名称对应的字符串资源,使用callback形式返回字符串。

**系统能力**:SystemCapability.Global.ResourceManager

**参数:** 
H
huangjie 已提交
1941

H
HelloCrease 已提交
1942 1943 1944 1945
| 参数名      | 类型                          | 必填   | 说明                            |
| -------- | --------------------------- | ---- | ----------------------------- |
| resName  | string                      | 是    | 资源名称                          |
| num      | number                      | 是    | 数量值                           |
H
huangjie 已提交
1946 1947
| callback | AsyncCallback&lt;string&gt; | 是    | 异步回调,返回根据传入的数量值获取资源名称对应的字符串资源 |

H
huangjie 已提交
1948 1949
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
1950 1951
**错误码:**

H
huangjie 已提交
1952 1953
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
1954 1955 1956
| 9001003  | If the resName invalid.                     |
| 9001004  | If the resource not found by resName.       |
| 9001006  | If the resource re-ref too much.            |
H
huangjie 已提交
1957

H
huangjie 已提交
1958
**示例:** 
H
HelloCrease 已提交
1959
  ```ts
H
huangjie 已提交
1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971
  try {
    this.context.resourceManager.getPluralStringByName("test", 1, (error, value) => {
        if (error != null) {
            console.log("error is " + error);
        } else {
            let str = value;
        }
    });
  } catch (error) {
    console.error(`callback getPluralStringByName failed, error code: ${error.code}, message: ${error.message}.`)
  }
  
H
huangjie 已提交
1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982
  ```

### getPluralStringByName<sup>9+</sup>

getPluralStringByName(resName: string, num: number): Promise&lt;string&gt;

根据传入的数量值,获取资源名称对应的字符串资源,使用Promise形式返回字符串。

**系统能力**:SystemCapability.Global.ResourceManager

**参数:** 
H
huangjie 已提交
1983

H
HelloCrease 已提交
1984 1985
| 参数名     | 类型     | 必填   | 说明   |
| ------- | ------ | ---- | ---- |
H
huangjie 已提交
1986
| resName | string | 是    | 资源名称 |
H
HelloCrease 已提交
1987
| num     | number | 是    | 数量值  |
H
huangjie 已提交
1988

H
huangjie 已提交
1989 1990
**返回值:**

H
HelloCrease 已提交
1991 1992
| 类型                    | 说明                     |
| --------------------- | ---------------------- |
H
huangjie 已提交
1993 1994
| Promise&lt;string&gt; | 根据传入的数量值获取资源名称对应的字符串资源 |

H
huangjie 已提交
1995 1996
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
1997 1998
**错误码:**

H
huangjie 已提交
1999 2000
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
2001 2002 2003
| 9001003  | If the resName invalid.                     |
| 9001004  | If the resource not found by resName.       |
| 9001006  | If the resource re-ref too much.            |
H
huangjie 已提交
2004

H
huangjie 已提交
2005
**示例:** 
H
HelloCrease 已提交
2006
  ```ts
H
huangjie 已提交
2007 2008
  try {
    this.context.resourceManager.getPluralStringByName("test", 1).then(value => {
H
huangjie 已提交
2009
      let str = value;
H
huangjie 已提交
2010
    }).catch(error => {
H
huangjie 已提交
2011
      console.log("getPluralStringByName promise error is " + error);
H
huangjie 已提交
2012 2013 2014 2015
    });
  } catch (error) {
    console.error(`promise getPluralStringByName failed, error code: ${error.code}, message: ${error.message}.`)
  }
H
huangjie 已提交
2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026
  ```

### getStringSync<sup>9+</sup>

getStringSync(resId: number): string

用户获取指定资源ID对应的字符串,使用同步方式返回字符串。

**系统能力**:SystemCapability.Global.ResourceManager

**参数:** 
H
huangjie 已提交
2027

H
huangjie 已提交
2028 2029 2030 2031
| 参数名   | 类型     | 必填   | 说明    |
| ----- | ------ | ---- | ----- |
| resId | number | 是    | 资源ID值 |

H
huangjie 已提交
2032 2033
**返回值:**

H
HelloCrease 已提交
2034 2035
| 类型     | 说明          |
| ------ | ----------- |
H
huangjie 已提交
2036 2037
| string | 资源ID值对应的字符串 |

H
huangjie 已提交
2038 2039 2040 2041 2042 2043 2044 2045 2046 2047
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

**错误码:**

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 9001001  | If the resId invalid.                       |
| 9001002  | If the resource not found by resId.         |
| 9001006  | If the resource re-ref too much.            |

H
huangjie 已提交
2048
**示例:** 
H
HelloCrease 已提交
2049
  ```ts
H
huangjie 已提交
2050 2051 2052 2053 2054
  try {
    this.context.resourceManager.getStringSync($r('app.string.test').id);
  } catch (error) {
    console.error(`getStringSync failed, error code: ${error.code}, message: ${error.message}.`)
  }
H
huangjie 已提交
2055 2056
  ```

2057 2058 2059 2060 2061 2062 2063 2064 2065
### getStringSync<sup>9+</sup>

getStringSync(resource: Resource): string

用户获取指定resource对象对应的字符串,使用同步方式返回字符串。

**系统能力**:SystemCapability.Global.ResourceManager

**参数:** 
H
huangjie 已提交
2066

H
HelloCrease 已提交
2067 2068
| 参数名      | 类型                     | 必填   | 说明   |
| -------- | ---------------------- | ---- | ---- |
2069
| resource | [Resource](#resource9) | 是    | 资源信息 |
2070

H
huangjie 已提交
2071 2072
**返回值:**

H
HelloCrease 已提交
2073 2074
| 类型     | 说明               |
| ------ | ---------------- |
2075 2076
| string | resource对象对应的字符串 |

H
huangjie 已提交
2077 2078
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
2079 2080
**错误码:**

H
huangjie 已提交
2081 2082
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
2083 2084 2085
| 9001001  | If the resId invalid.                       |
| 9001002  | If the resource not found by resId.         |
| 9001006  | If the resource re-ref too much.            |
H
huangjie 已提交
2086

2087
**示例:** 
H
HelloCrease 已提交
2088
  ```ts
2089 2090 2091 2092 2093
  let resource = {
      bundleName: "com.example.myapplication",
      moduleName: "entry",
      id: $r('app.string.test').id
  };
H
huangjie 已提交
2094 2095 2096 2097 2098
  try {
    this.context.resourceManager.getStringSync(resource);
  } catch (error) {
    console.error(`getStringSync failed, error code: ${error.code}, message: ${error.message}.`)
  }
2099 2100
  ```

H
huangjie 已提交
2101 2102 2103 2104 2105 2106 2107 2108 2109
### getStringByNameSync<sup>9+</sup>

getStringByNameSync(resName: string): string

用户获取指定资源名称对应的字符串,使用同步方式返回字符串。

**系统能力**:SystemCapability.Global.ResourceManager

**参数:** 
H
huangjie 已提交
2110

H
HelloCrease 已提交
2111 2112
| 参数名     | 类型     | 必填   | 说明   |
| ------- | ------ | ---- | ---- |
H
huangjie 已提交
2113 2114
| resName | string | 是    | 资源名称 |

H
huangjie 已提交
2115 2116
**返回值:**

H
HelloCrease 已提交
2117 2118
| 类型     | 说明         |
| ------ | ---------- |
H
huangjie 已提交
2119 2120
| string | 资源名称对应的字符串 |

H
huangjie 已提交
2121 2122
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
2123 2124
**错误码:**

H
huangjie 已提交
2125 2126
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
2127 2128 2129
| 9001003  | If the resName invalid.                     |
| 9001004  | If the resource not found by resName.       |
| 9001006  | If the resource re-ref too much.            |
H
huangjie 已提交
2130

H
huangjie 已提交
2131
**示例:** 
H
HelloCrease 已提交
2132
  ```ts
H
huangjie 已提交
2133 2134 2135 2136 2137
  try {
    this.context.resourceManager.getStringByNameSync("test");
  } catch (error) {
    console.error(`getStringByNameSync failed, error code: ${error.code}, message: ${error.message}.`)
  }
H
huangjie 已提交
2138 2139
  ```

H
huangjie 已提交
2140
### getBoolean<sup>9+</sup>
H
huangjie 已提交
2141 2142 2143 2144 2145 2146 2147 2148

getBoolean(resId: number): boolean

使用同步方式,返回获取指定资源ID对应的布尔结果。

**系统能力**:SystemCapability.Global.ResourceManager

**参数:** 
H
huangjie 已提交
2149

H
huangjie 已提交
2150 2151 2152 2153
| 参数名   | 类型     | 必填   | 说明    |
| ----- | ------ | ---- | ----- |
| resId | number | 是    | 资源ID值 |

H
huangjie 已提交
2154 2155
**返回值:**

H
HelloCrease 已提交
2156 2157
| 类型      | 说明           |
| ------- | ------------ |
H
huangjie 已提交
2158 2159
| boolean | 资源ID值对应的布尔结果 |

H
huangjie 已提交
2160 2161
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
2162 2163
**错误码:**

H
huangjie 已提交
2164 2165
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
2166 2167 2168
| 9001001  | If the resId invalid.                       |
| 9001002  | If the resource not found by resId.         |
| 9001006  | If the resource re-ref too much.            |
H
huangjie 已提交
2169

H
huangjie 已提交
2170
**示例:** 
H
HelloCrease 已提交
2171
  ```ts
H
huangjie 已提交
2172 2173 2174 2175 2176
  try {
    this.context.resourceManager.getBoolean($r('app.boolean.boolean_test').id);
  } catch (error) {
    console.error(`getBoolean failed, error code: ${error.code}, message: ${error.message}.`)
  }
H
huangjie 已提交
2177
  ```
2178 2179 2180 2181 2182 2183 2184 2185 2186
### getBoolean<sup>9+</sup>

getBoolean(resource: Resource): boolean

使用同步方式,返回获取指定resource对象对应的布尔结果。

**系统能力**:SystemCapability.Global.ResourceManager

**参数:** 
H
huangjie 已提交
2187

H
HelloCrease 已提交
2188 2189
| 参数名      | 类型                     | 必填   | 说明   |
| -------- | ---------------------- | ---- | ---- |
2190
| resource | [Resource](#resource9) | 是    | 资源信息 |
2191

H
huangjie 已提交
2192 2193
**返回值:**

H
HelloCrease 已提交
2194 2195
| 类型      | 说明                |
| ------- | ----------------- |
2196 2197
| boolean | resource对象对应的布尔结果 |

H
huangjie 已提交
2198 2199
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
2200 2201
**错误码:**

H
huangjie 已提交
2202 2203
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
2204 2205 2206
| 9001001  | If the resId invalid.                       |
| 9001002  | If the resource not found by resId.         |
| 9001006  | If the resource re-ref too much.            |
H
huangjie 已提交
2207

2208
**示例:** 
H
HelloCrease 已提交
2209
  ```ts
2210 2211 2212 2213 2214
  let resource = {
      bundleName: "com.example.myapplication",
      moduleName: "entry",
      id: $r('app.boolean.boolean_test').id
  };
H
huangjie 已提交
2215 2216 2217 2218 2219
  try {
    this.context.resourceManager.getBoolean(resource);
  } catch (error) {
    console.error(`getBoolean failed, error code: ${error.code}, message: ${error.message}.`)
  }
2220
  ```
H
huangjie 已提交
2221 2222 2223 2224 2225 2226 2227 2228 2229 2230

### getBooleanByName<sup>9+</sup>

getBooleanByName(resName: string): boolean

使用同步方式,返回获取指定资源名称对应的布尔结果

**系统能力**:SystemCapability.Global.ResourceManager

**参数:** 
H
huangjie 已提交
2231

H
HelloCrease 已提交
2232 2233 2234
| 参数名     | 类型     | 必填   | 说明   |
| ------- | ------ | ---- | ---- |
| resName | string | 是    | 资源名称 |
H
huangjie 已提交
2235

H
huangjie 已提交
2236 2237
**返回值:**

H
HelloCrease 已提交
2238 2239
| 类型      | 说明          |
| ------- | ----------- |
H
huangjie 已提交
2240 2241
| boolean | 资源名称对应的布尔结果 |

H
huangjie 已提交
2242 2243
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
2244 2245
**错误码:**

H
huangjie 已提交
2246 2247
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
2248 2249 2250
| 9001003  | If the resName invalid.                     |
| 9001004  | If the resource not found by resName.       |
| 9001006  | If the resource re-ref too much.            |
H
huangjie 已提交
2251

H
huangjie 已提交
2252
**示例:** 
H
HelloCrease 已提交
2253
  ```ts
H
huangjie 已提交
2254 2255 2256 2257 2258
  try {
    this.context.resourceManager.getBooleanByName("boolean_test");
  } catch (error) {
    console.error(`getBooleanByName failed, error code: ${error.code}, message: ${error.message}.`)
  }
H
huangjie 已提交
2259 2260
  ```

H
huangjie 已提交
2261
### getNumber<sup>9+</sup>
H
huangjie 已提交
2262 2263 2264 2265 2266 2267 2268 2269

getNumber(resId: number): number

用户获取指定资源ID对应的integer数值或者float数值,使用同步方式返回资源对应的数值。

**系统能力**:SystemCapability.Global.ResourceManager

**参数:** 
H
huangjie 已提交
2270

H
huangjie 已提交
2271 2272 2273 2274
| 参数名   | 类型     | 必填   | 说明    |
| ----- | ------ | ---- | ----- |
| resId | number | 是    | 资源ID值 |

H
huangjie 已提交
2275 2276
**返回值:**

H
HelloCrease 已提交
2277 2278
| 类型     | 说明         |
| ------ | ---------- |
H
huangjie 已提交
2279 2280
| number | 资源ID值对应的数值 |

H
huangjie 已提交
2281 2282
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
2283 2284
**错误码:**

H
huangjie 已提交
2285 2286
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
2287 2288 2289
| 9001001  | If the resId invalid.                       |
| 9001002  | If the resource not found by resId.         |
| 9001006  | If the resource re-ref too much.            |
H
huangjie 已提交
2290

H
huangjie 已提交
2291
**示例:** 
H
HelloCrease 已提交
2292
  ```ts
H
huangjie 已提交
2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303
  try {
    this.context.resourceManager.getNumber($r('app.integer.integer_test').id);
  } catch (error) {
    console.error(`getNumber failed, error code: ${error.code}, message: ${error.message}.`)
  }

  try {
    this.context.resourceManager.getNumber($r('app.float.float_test').id);
  } catch (error) {
    console.error(`getNumber failed, error code: ${error.code}, message: ${error.message}.`)
  }
H
huangjie 已提交
2304 2305
  ```

2306 2307 2308 2309 2310 2311 2312 2313 2314
### getNumber<sup>9+</sup>

getNumber(resource: Resource): number

用户获取指定resource对象对应的integer数值或者float数值,使用同步方式返回资源对应的数值。

**系统能力**:SystemCapability.Global.ResourceManager

**参数:** 
H
huangjie 已提交
2315

H
HelloCrease 已提交
2316 2317
| 参数名      | 类型                     | 必填   | 说明   |
| -------- | ---------------------- | ---- | ---- |
2318
| resource | [Resource](#resource9) | 是    | 资源信息 |
2319

H
huangjie 已提交
2320 2321
**返回值:**

H
HelloCrease 已提交
2322 2323
| 类型     | 说明              |
| ------ | --------------- |
2324 2325
| number | resource对象对应的数值 |

H
huangjie 已提交
2326 2327
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
2328 2329
**错误码:**

H
huangjie 已提交
2330 2331
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
2332 2333 2334
| 9001001  | If the resId invalid.                       |
| 9001002  | If the resource not found by resId.         |
| 9001006  | If the resource re-ref too much.            |
H
huangjie 已提交
2335

2336
**示例:** 
H
HelloCrease 已提交
2337
  ```ts
2338 2339 2340 2341 2342
  let resource = {
      bundleName: "com.example.myapplication",
      moduleName: "entry",
      id: $r('app.integer.integer_test').id
  };
H
huangjie 已提交
2343 2344 2345 2346 2347
  try {
    this.context.resourceManager.getNumber(resource);
  } catch (error) {
    console.error(`getNumber failed, error code: ${error.code}, message: ${error.message}.`)
  }
2348 2349
  ```

H
huangjie 已提交
2350 2351 2352 2353 2354 2355 2356 2357 2358
### getNumberByName<sup>9+</sup>

getNumberByName(resName: string): number

用户获取指定资源名称对应的integer数值或者float数值,使用同步方式资源对应的数值。

**系统能力**:SystemCapability.Global.ResourceManager

**参数:** 
H
huangjie 已提交
2359

H
HelloCrease 已提交
2360 2361
| 参数名     | 类型     | 必填   | 说明   |
| ------- | ------ | ---- | ---- |
H
huangjie 已提交
2362 2363
| resName | string | 是    | 资源名称 |

H
huangjie 已提交
2364 2365
**返回值:**

H
HelloCrease 已提交
2366 2367
| 类型     | 说明        |
| ------ | --------- |
H
huangjie 已提交
2368 2369
| number | 资源名称对应的数值 |

H
huangjie 已提交
2370 2371
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

H
huangjie 已提交
2372 2373
**错误码:**

H
huangjie 已提交
2374 2375
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
2376 2377 2378
| 9001003  | If the resName invalid.                     |
| 9001004  | If the resource not found by resName.       |
| 9001006  | If the resource re-ref too much.            |
H
huangjie 已提交
2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406

**示例:** 
  ```ts
  try {
    this.context.resourceManager.getNumberByName("integer_test");
  } catch (error) {
    console.error(`getNumberByName failed, error code: ${error.code}, message: ${error.message}.`)
  }

  try {
    this.context.resourceManager.getNumberByName("float_test");
  } catch (error) {
    console.error(`getNumberByName failed, error code: ${error.code}, message: ${error.message}.`)
  }
  ```


### getString<sup>(deprecated)</sup>

getString(resId: number, callback: AsyncCallback&lt;string&gt;): void

用户获取指定资源ID对应的字符串,使用callback形式返回字符串。

从API version 9开始不再维护,建议使用[getStringValue](#getstringvalue9)代替。

**系统能力**:SystemCapability.Global.ResourceManager

**参数:** 
H
huangjie 已提交
2407

H
huangjie 已提交
2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437
| 参数名      | 类型                          | 必填   | 说明              |
| -------- | --------------------------- | ---- | --------------- |
| resId    | number                      | 是    | 资源ID值           |
| callback | AsyncCallback&lt;string&gt; | 是    | 异步回调,用于返回获取的字符串 |

**示例:** 
  ```ts
  resourceManager.getResourceManager((error, mgr) => {
      mgr.getString($r('app.string.test').id, (error, value) => {
          if (error != null) {
              console.log("error is " + error);
          } else {
              let str = value;
          }
      });
  });
  ```


### getString<sup>(deprecated)</sup>

getString(resId: number): Promise&lt;string&gt;

用户获取指定资源ID对应的字符串,使用Promise形式返回字符串。

从API version 9开始不再维护,建议使用[getStringValue](#getstringvalue9-1)代替。

**系统能力**:SystemCapability.Global.ResourceManager

**参数:** 
H
huangjie 已提交
2438

H
huangjie 已提交
2439 2440 2441 2442
| 参数名   | 类型     | 必填   | 说明    |
| ----- | ------ | ---- | ----- |
| resId | number | 是    | 资源ID值 |

H
huangjie 已提交
2443 2444
**返回值:**

H
huangjie 已提交
2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471
| 类型                    | 说明          |
| --------------------- | ----------- |
| Promise&lt;string&gt; | 资源ID值对应的字符串 |

**示例:** 
  ```ts
  resourceManager.getResourceManager((error, mgr) => {
      mgr.getString($r('app.string.test').id).then(value => {
          let str = value;
      }).catch(error => {
          console.log("getstring promise error is " + error);
      });
  });
  ```


### getStringArray<sup>(deprecated)</sup>

getStringArray(resId: number, callback: AsyncCallback&lt;Array&lt;string&gt;&gt;): void

用户获取指定资源ID对应的字符串数组,使用callback形式返回字符串数组。

从API version 9开始不再维护,建议使用[getStringArrayValue](#getstringarrayvalue9)代替。

**系统能力**:SystemCapability.Global.ResourceManager

**参数:** 
H
huangjie 已提交
2472

H
huangjie 已提交
2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502
| 参数名      | 类型                                       | 必填   | 说明                |
| -------- | ---------------------------------------- | ---- | ----------------- |
| resId    | number                                   | 是    | 资源ID值             |
| callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是    | 异步回调,用于返回获取的字符串数组 |

**示例:** 
  ```ts
  resourceManager.getResourceManager((error, mgr) => {
      mgr.getStringArray($r('app.strarray.test').id, (error, value) => {
          if (error != null) {
              console.log("error is " + error);
          } else {
              let strArray = value;
          }
      });
  });
  ```


### getStringArray<sup>(deprecated)</sup>

getStringArray(resId: number): Promise&lt;Array&lt;string&gt;&gt;

用户获取指定资源ID对应的字符串数组,使用Promise形式返回字符串数组。

从API version 9开始不再维护,建议使用[getStringArrayValue](#getstringarrayvalue9-1)代替。

**系统能力**:SystemCapability.Global.ResourceManager

**参数:** 
H
huangjie 已提交
2503

H
huangjie 已提交
2504 2505 2506 2507
| 参数名   | 类型     | 必填   | 说明    |
| ----- | ------ | ---- | ----- |
| resId | number | 是    | 资源ID值 |

H
huangjie 已提交
2508 2509
**返回值:**

H
huangjie 已提交
2510 2511 2512 2513
| 类型                                 | 说明            |
| ---------------------------------- | ------------- |
| Promise&lt;Array&lt;string&gt;&gt; | 资源ID值对应的字符串数组 |

H
huangjie 已提交
2514
**示例:** 
H
HelloCrease 已提交
2515
  ```ts
H
huangjie 已提交
2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531
  resourceManager.getResourceManager((error, mgr) => {
       mgr.getStringArray($r('app.strarray.test').id).then(value => {
          let strArray = value;
      }).catch(error => {
          console.log("getStringArray promise error is " + error);
      });
  });
  ```


### getMedia<sup>(deprecated)</sup>

getMedia(resId: number, callback: AsyncCallback&lt;Uint8Array&gt;): void

用户获取指定资源ID对应的媒体文件内容,使用callback形式返回字节数组。

H
huangjie 已提交
2532
从API version 9开始不再维护,建议使用[getMediaContent](#getmediacontent9)代替。
H
huangjie 已提交
2533 2534 2535 2536

**系统能力**:SystemCapability.Global.ResourceManager

**参数:** 
H
huangjie 已提交
2537

H
huangjie 已提交
2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562
| 参数名      | 类型                              | 必填   | 说明                 |
| -------- | ------------------------------- | ---- | ------------------ |
| resId    | number                          | 是    | 资源ID值              |
| callback | AsyncCallback&lt;Uint8Array&gt; | 是    | 异步回调,用于返回获取的媒体文件内容 |

**示例:** 
  ```ts
  resourceManager.getResourceManager((error, mgr) => {
      mgr.getMedia($r('app.media.test').id, (error, value) => {
          if (error != null) {
              console.log("error is " + error);
          } else {
              let media = value;
          }
      });
  });
  ```


### getMedia<sup>(deprecated)</sup>

getMedia(resId: number): Promise&lt;Uint8Array&gt;

用户获取指定资源ID对应的媒体文件内容,使用Promise形式返回字节数组。

H
huangjie 已提交
2563
从API version 9开始不再维护,建议使用[getMediaContent](#getmediacontent9-1)代替。
H
huangjie 已提交
2564 2565 2566 2567

**系统能力**:SystemCapability.Global.ResourceManager

**参数:** 
H
huangjie 已提交
2568

H
huangjie 已提交
2569 2570 2571 2572
| 参数名   | 类型     | 必填   | 说明    |
| ----- | ------ | ---- | ----- |
| resId | number | 是    | 资源ID值 |

H
huangjie 已提交
2573 2574
**返回值:**

H
huangjie 已提交
2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596
| 类型                        | 说明             |
| ------------------------- | -------------- |
| Promise&lt;Uint8Array&gt; | 资源ID值对应的媒体文件内容 |

**示例:** 
  ```ts
  resourceManager.getResourceManager((error, mgr) => {
      mgr.getMedia($r('app.media.test').id).then(value => {
          let media = value;
      }).catch(error => {
          console.log("getMedia promise error is " + error);
      });
  });
  ```


### getMediaBase64<sup>(deprecated)</sup>

getMediaBase64(resId: number, callback: AsyncCallback&lt;string&gt;): void

用户获取指定资源ID对应的图片资源Base64编码,使用callback形式返回字符串。

H
huangjie 已提交
2597
从API version 9开始不再维护,建议使用[getMediaContentBase64](#getmediacontentbase649)代替。
H
huangjie 已提交
2598 2599 2600 2601

**系统能力**:SystemCapability.Global.ResourceManager

**参数:** 
H
huangjie 已提交
2602

H
huangjie 已提交
2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627
| 参数名      | 类型                          | 必填   | 说明                       |
| -------- | --------------------------- | ---- | ------------------------ |
| resId    | number                      | 是    | 资源ID值                    |
| callback | AsyncCallback&lt;string&gt; | 是    | 异步回调,用于返回获取的图片资源Base64编码 |

**示例:** 
  ```ts
  resourceManager.getResourceManager((error, mgr) => {
      mgr.getMediaBase64($r('app.media.test').id, (error, value) => {
          if (error != null) {
              console.log("error is " + error);
          } else {
              let media = value;
          }
      });
  });
  ```


### getMediaBase64<sup>(deprecated)</sup>

getMediaBase64(resId: number): Promise&lt;string&gt;

用户获取指定资源ID对应的图片资源Base64编码,使用Promise形式返回字符串。

H
huangjie 已提交
2628
从API version 9开始不再维护,建议使用[getMediaContentBase64](#getmediacontentbase649-1)代替。
H
huangjie 已提交
2629 2630 2631 2632

**系统能力**:SystemCapability.Global.ResourceManager

**参数:** 
H
huangjie 已提交
2633

H
huangjie 已提交
2634 2635 2636 2637
| 参数名   | 类型     | 必填   | 说明    |
| ----- | ------ | ---- | ----- |
| resId | number | 是    | 资源ID值 |

H
huangjie 已提交
2638 2639
**返回值:**

H
huangjie 已提交
2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661
| 类型                    | 说明                   |
| --------------------- | -------------------- |
| Promise&lt;string&gt; | 资源ID值对应的图片资源Base64编码 |

**示例:** 
  ```ts
  resourceManager.getResourceManager((error, mgr) => {
      mgr.getMediaBase64($r('app.media.test').id).then(value => {
          let media = value;
      }).catch(error => {
          console.log("getMediaBase64 promise error is " + error);
      });
  });
  ```


### getPluralString<sup>(deprecated)</sup>

getPluralString(resId: number, num: number): Promise&lt;string&gt;

根据指定数量获取对指定ID字符串表示的单复数字符串,使用Promise形式返回字符串。

H
huangjie 已提交
2662
从API version 9开始不再维护,建议使用[getPluralStringValue](#getpluralstringvalue9)代替。
H
huangjie 已提交
2663 2664 2665 2666

**系统能力**:SystemCapability.Global.ResourceManager

**参数:** 
H
huangjie 已提交
2667

H
huangjie 已提交
2668 2669 2670 2671 2672
| 参数名   | 类型     | 必填   | 说明    |
| ----- | ------ | ---- | ----- |
| resId | number | 是    | 资源ID值 |
| num   | number | 是    | 数量值   |

H
huangjie 已提交
2673 2674
**返回值:**

H
huangjie 已提交
2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696
| 类型                    | 说明                        |
| --------------------- | ------------------------- |
| Promise&lt;string&gt; | 根据提供的数量获取对应ID字符串表示的单复数字符串 |

**示例:** 
  ```ts
  resourceManager.getResourceManager((error, mgr) => {
      mgr.getPluralString($r("app.plural.test").id, 1).then(value => {
          let str = value;
      }).catch(error => {
          console.log("getPluralString promise error is " + error);
      });
  });
  ```


### getPluralString<sup>(deprecated)</sup>

getPluralString(resId: number, num: number, callback: AsyncCallback&lt;string&gt;): void

根据指定数量获取指定ID字符串表示的单复数字符串,使用callback形式返回字符串。

H
huangjie 已提交
2697
从API version 9开始不再维护,建议使用[getPluralStringValue](#getpluralstringvalue9-1)代替。
H
huangjie 已提交
2698 2699 2700 2701

**系统能力**:SystemCapability.Global.ResourceManager

**参数:** 
H
huangjie 已提交
2702

H
huangjie 已提交
2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733
| 参数名      | 类型                          | 必填   | 说明                              |
| -------- | --------------------------- | ---- | ------------------------------- |
| resId    | number                      | 是    | 资源ID值                           |
| num      | number                      | 是    | 数量值                             |
| callback | AsyncCallback&lt;string&gt; | 是    | 异步回调,返回根据指定数量获取指定ID字符串表示的单复数字符串 |

**示例:** 
  ```ts
  resourceManager.getResourceManager((error, mgr) => {
      mgr.getPluralString($r("app.plural.test").id, 1, (error, value) => {
          if (error != null) {
              console.log("error is " + error);
          } else {
              let str = value;
          }
      });
  });
  ```


### getRawFile<sup>(deprecated)</sup>

getRawFile(path: string, callback: AsyncCallback&lt;Uint8Array&gt;): void

用户获取resources/rawfile目录下对应的rawfile文件内容,使用callback形式返回字节数组。

从API version 9开始不再维护,建议使用[getRawFileContent](#getrawfilecontent9)代替。

**系统能力**:SystemCapability.Global.ResourceManager

**参数:** 
H
huangjie 已提交
2734

H
huangjie 已提交
2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764
| 参数名      | 类型                              | 必填   | 说明                      |
| -------- | ------------------------------- | ---- | ----------------------- |
| path     | string                          | 是    | rawfile文件路径             |
| callback | AsyncCallback&lt;Uint8Array&gt; | 是    | 异步回调,用于返回获取的rawfile文件内容 |

**示例:** 
  ```ts
  resourceManager.getResourceManager((error, mgr) => {
      mgr.getRawFile("test.xml", (error, value) => {
          if (error != null) {
              console.log("error is " + error);
          } else {
              let rawFile = value;
          }
      });
  });
  ```


### getRawFile<sup>(deprecated)</sup>

getRawFile(path: string): Promise&lt;Uint8Array&gt;

用户获取resources/rawfile目录下对应的rawfile文件内容,使用Promise形式返回字节数组。

从API version 9开始不再维护,建议使用[getRawFileContent](#getrawfilecontent9-1)代替。

**系统能力**:SystemCapability.Global.ResourceManager

**参数:** 
H
huangjie 已提交
2765

H
huangjie 已提交
2766 2767 2768 2769
| 参数名  | 类型     | 必填   | 说明          |
| ---- | ------ | ---- | ----------- |
| path | string | 是    | rawfile文件路径 |

H
huangjie 已提交
2770 2771
**返回值:**

H
huangjie 已提交
2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798
| 类型                        | 说明          |
| ------------------------- | ----------- |
| Promise&lt;Uint8Array&gt; | rawfile文件内容 |

**示例:** 
  ```ts
  resourceManager.getResourceManager((error, mgr) => {
      mgr.getRawFile("test.xml").then(value => {
          let rawFile = value;
      }).catch(error => {
          console.log("getRawFile promise error is " + error);
      });
  });
  ```


### getRawFileDescriptor<sup>(deprecated)</sup>

getRawFileDescriptor(path: string, callback: AsyncCallback&lt;RawFileDescriptor&gt;): void

用户获取resources/rawfile目录下对应rawfile文件的descriptor,使用callback形式返回。

从API version 9开始不再维护,建议使用[getRawFd](#getrawfd9)代替。

**系统能力**:SystemCapability.Global.ResourceManager

**参数:** 
H
huangjie 已提交
2799

H
huangjie 已提交
2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830
| 参数名      | 类型                                       | 必填   | 说明                               |
| -------- | ---------------------------------------- | ---- | -------------------------------- |
| path     | string                                   | 是    | rawfile文件路径                      |
| callback | AsyncCallback&lt;[RawFileDescriptor](#rawfiledescriptor8)&gt; | 是    | 异步回调,用于返回获取的rawfile文件的descriptor |

**示例:** 
  ```ts
  resourceManager.getResourceManager((error, mgr) => {
      mgr.getRawFileDescriptor("test.xml", (error, value) => {
          if (error != null) {
              console.log("error is " + error);
          } else {
              let fd = value.fd;
              let offset = value.offset;
              let length = value.length;
          }
      });
  });
  ```

### getRawFileDescriptor<sup>(deprecated)</sup>

getRawFileDescriptor(path: string): Promise&lt;RawFileDescriptor&gt;

用户获取resources/rawfile目录下对应rawfile文件的descriptor,使用Promise形式返回。

从API version 9开始不再维护,建议使用[getRawFd](#getrawfd9-1)代替。

**系统能力**:SystemCapability.Global.ResourceManager

**参数:** 
H
huangjie 已提交
2831

H
huangjie 已提交
2832 2833 2834 2835
| 参数名  | 类型     | 必填   | 说明          |
| ---- | ------ | ---- | ----------- |
| path | string | 是    | rawfile文件路径 |

H
huangjie 已提交
2836 2837
**返回值:**

H
huangjie 已提交
2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852
| 类型                                       | 说明                  |
| ---------------------------------------- | ------------------- |
| Promise&lt;[RawFileDescriptor](#rawfiledescriptor8)&gt; | rawfile文件descriptor |

**示例:** 
  ```ts
  resourceManager.getResourceManager((error, mgr) => {
      mgr.getRawFileDescriptor("test.xml").then(value => {
          let fd = value.fd;
          let offset = value.offset;
          let length = value.length;
      }).catch(error => {
          console.log("getRawFileDescriptor promise error is " + error);
      });
  });
H
huangjie 已提交
2853
  ```