js-apis-resource-manager.md 88.6 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模型不适用。
F
fangyunzhong 已提交
19
Stage模型下Context的引用方法请参考[Stage模型的Context详细介绍](../../ability/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 42 43 44
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                            |
| -------- | ---------------------------------------- | ---- | ----------------------------- |
| callback | AsyncCallback<[ResourceManager](#resourcemanager)> | 是    | callback方式返回ResourceManager对象 |
Z
zengyawen 已提交
45

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


## resourceManager.getResourceManager

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

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

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

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

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

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


## resourceManager.getResourceManager

getResourceManager(): Promise<ResourceManager>
Z
zengyawen 已提交
90 91 92

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

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

V
VictoriaGuo 已提交
95 96
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
97 98 99 100
**返回值:** 
| 类型                                       | 说明                |
| ---------------------------------------- | ----------------- |
| Promise<[ResourceManager](#resourcemanager)> | Promise方式返回资源管理对象 |
Z
zengyawen 已提交
101

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


## resourceManager.getResourceManager

getResourceManager(bundleName: string): Promise<ResourceManager>
Z
zengyawen 已提交
121 122 123

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

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

V
VictoriaGuo 已提交
126 127
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
128 129 130 131
**参数:** 
| 参数名        | 类型     | 必填   | 说明            |
| ---------- | ------ | ---- | ------------- |
| bundleName | string | 是    | 指定应用的Bundle名称 |
Z
zengyawen 已提交
132

H
HelloCrease 已提交
133 134 135 136
**返回值:** 
| 类型                                       | 说明                 |
| ---------------------------------------- | ------------------ |
| Promise<[ResourceManager](#resourcemanager)> | Promise方式返回的资源管理对象 |
Z
zengyawen 已提交
137

H
HelloCrease 已提交
138
**示例:** 
H
HelloCrease 已提交
139
  ```js
Z
zengyawen 已提交
140 141 142 143 144 145 146
  resourceManager.getResourceManager("com.example.myapplication").then(mgr => {
  }).catch(error => {
  });
  ```


## Direction
Z
zengyawen 已提交
147 148 149

用于表示设备屏幕方向。

H
HelloCrease 已提交
150
**系统能力**:SystemCapability.Global.ResourceManager
H
HelloCrease 已提交
151 152 153 154 155

| 名称                   | 默认值  | 说明   |
| -------------------- | ---- | ---- |
| DIRECTION_VERTICAL   | 0    | 竖屏   |
| DIRECTION_HORIZONTAL | 1    | 横屏   |
Z
zengyawen 已提交
156 157 158


## DeviceType
Z
zengyawen 已提交
159 160 161

用于表示当前设备类型。

H
HelloCrease 已提交
162
**系统能力**:SystemCapability.Global.ResourceManager
H
HelloCrease 已提交
163 164 165 166 167 168 169 170 171

| 名称                   | 默认值  | 说明   |
| -------------------- | ---- | ---- |
| 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 已提交
172 173 174


## ScreenDensity
Z
zengyawen 已提交
175 176 177

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

H
HelloCrease 已提交
178
**系统能力**:SystemCapability.Global.ResourceManager
H
HelloCrease 已提交
179 180 181 182 183 184 185 186 187

| 名称             | 默认值  | 说明         |
| -------------- | ---- | ---------- |
| SCREEN_SDPI    | 120  | 小规模的屏幕密度   |
| SCREEN_MDPI    | 160  | 中规模的屏幕密度   |
| SCREEN_LDPI    | 240  | 大规模的屏幕密度   |
| SCREEN_XLDPI   | 320  | 特大规模的屏幕密度  |
| SCREEN_XXLDPI  | 480  | 超大规模的屏幕密度  |
| SCREEN_XXXLDPI | 640  | 超特大规模的屏幕密度 |
Z
zengyawen 已提交
188 189 190


## Configuration
Z
zengyawen 已提交
191 192 193

表示当前设备的状态。

H
HelloCrease 已提交
194
**系统能力**:SystemCapability.Global.ResourceManager
H
HelloCrease 已提交
195

Z
zengyawen 已提交
196

H
HelloCrease 已提交
197 198 199 200
| 名称        | 参数类型                    | 可读   | 可写   | 说明       |
| --------- | ----------------------- | ---- | ---- | -------- |
| direction | [Direction](#direction) | 是    | 否    | 当前设备屏幕方向 |
| locale    | string                  | 是    | 否    | 当前系统语言   |
Z
zengyawen 已提交
201

202 203
**示例:**

H
HelloCrease 已提交
204
  ```js
205 206
resourceManager.getResourceManager((error, mgr) => {
      mgr.getConfiguration((error, value) => {
W
wplan1 已提交
207 208
          let direction = value.direction;
          let locale = value.locale;
209 210 211
      });
  });
  ```
Z
zengyawen 已提交
212 213

## DeviceCapability
Z
zengyawen 已提交
214 215 216

表示设备支持的能力。

H
HelloCrease 已提交
217
**系统能力**:SystemCapability.Global.ResourceManager
H
HelloCrease 已提交
218

Z
zengyawen 已提交
219

H
HelloCrease 已提交
220 221 222 223
| 名称            | 参数类型                            | 可读   | 可写   | 说明       |
| ------------- | ------------------------------- | ---- | ---- | -------- |
| screenDensity | [ScreenDensity](#screendensity) | 是    | 否    | 当前设备屏幕密度 |
| deviceType    | [DeviceType](#devicetype)       | 是    | 否    | 当前设备类型   |
Z
zengyawen 已提交
224

225 226
**示例:**

H
HelloCrease 已提交
227
  ```js
228 229
resourceManager.getResourceManager((error, mgr) => {
      mgr.getDeviceCapability((error, value) => {
W
wplan1 已提交
230 231
          let screenDensity = value.screenDensity;
          let deviceType = value.deviceType;
232 233 234
      });
  });
  ```
Z
zengyawen 已提交
235

W
wplan1 已提交
236 237
## RawFileDescriptor<sup>8+</sup>

H
HelloCrease 已提交
238 239 240
表示rawfile的descriptor信息。

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

H
HelloCrease 已提交
242 243 244 245 246
| 名称     | 类型     | 说明                 |
| ------ | ------ | ------------------ |
| fd     | number | rawfile的descriptor |
| offset | number | rawfile的起始偏移量      |
| length | number | rawfile的文件长度       |
W
wplan1 已提交
247

248
## Resource<sup>9+</sup>
249 250 251 252 253

表示的资源信息。

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

H
HelloCrease 已提交
254 255
| 名称         | 类型     | 说明          |
| ---------- | ------ | ----------- |
256
| bundleName | string | 应用的bundle名称 |
H
HelloCrease 已提交
257 258
| moduleName | string | 应用的module名称 |
| id         | number | 资源的id值      |
259

W
wplan1 已提交
260

Z
zengyawen 已提交
261
## ResourceManager
Z
zengyawen 已提交
262 263 264

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

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

H
huangjie 已提交
271
### getStringValue<sup>9+</sup>
Z
zengyawen 已提交
272

H
huangjie 已提交
273
getStringValue(resId: number, callback: AsyncCallback&lt;string&gt;): void
Z
zengyawen 已提交
274 275 276

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

V
VictoriaGuo 已提交
277 278
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
279 280 281 282 283
**参数:** 
| 参数名      | 类型                          | 必填   | 说明              |
| -------- | --------------------------- | ---- | --------------- |
| resId    | number                      | 是    | 资源ID值           |
| callback | AsyncCallback&lt;string&gt; | 是    | 异步回调,用于返回获取的字符串 |
Z
zengyawen 已提交
284

H
huangjie 已提交
285 286 287 288 289 290 291 292 293 294 295
**错误码:**

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

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

**示例Stage:** 
H
HelloCrease 已提交
296
  ```ts
H
huangjie 已提交
297 298
    try {
        this.context.getStringValue($r('app.string.test').id, (error, value) => {
Z
zengyawen 已提交
299
          if (error != null) {
W
wplan1 已提交
300
              console.log("error is " + error);
Z
zengyawen 已提交
301
          } else {
W
wplan1 已提交
302
              let str = value;
Z
zengyawen 已提交
303 304
          }
      });
H
huangjie 已提交
305 306 307
    } catch (error) {
        console.error(`callback getStringValue failed, error code: ${error.code}, message: ${error.message}.`)
    }
Z
zengyawen 已提交
308 309 310
  ```


H
huangjie 已提交
311
### getStringValue<sup>9+</sup>
Z
zengyawen 已提交
312

H
huangjie 已提交
313
getStringValue(resId: number): Promise&lt;string&gt;
Z
zengyawen 已提交
314 315 316

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

V
VictoriaGuo 已提交
317 318
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
319 320 321 322
**参数:** 
| 参数名   | 类型     | 必填   | 说明    |
| ----- | ------ | ---- | ----- |
| resId | number | 是    | 资源ID值 |
Z
zengyawen 已提交
323

H
HelloCrease 已提交
324 325 326 327
**返回值:** 
| 类型                    | 说明          |
| --------------------- | ----------- |
| Promise&lt;string&gt; | 资源ID值对应的字符串 |
Z
zengyawen 已提交
328

H
huangjie 已提交
329 330 331 332 333 334 335 336
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

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

H
HelloCrease 已提交
337
**示例:** 
H
HelloCrease 已提交
338
  ```ts
H
huangjie 已提交
339 340 341 342 343 344 345 346 347
  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 已提交
348 349 350
  ```


H
huangjie 已提交
351
### getStringValue<sup>9+</sup>
352

H
huangjie 已提交
353
getStringValue(resource: Resource, callback: AsyncCallback&lt;string&gt;): void
354 355 356 357 358 359 360 361

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

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

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

H
huangjie 已提交
365 366 367 368 369 370 371 372
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

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

373
**示例:** 
H
HelloCrease 已提交
374
  ```ts
375 376 377 378 379
  let resource = {
      bundleName: "com.example.myapplication",
      moduleName: "entry",
      id: $r('app.string.test').id
  };
H
huangjie 已提交
380 381 382 383 384 385 386 387 388 389 390 391
  tyr {
    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}.`)
  }
  
392 393 394
  ```


H
huangjie 已提交
395 396 397
### getStringValue<sup>9+</sup>

getStringValue(resource: Resource): Promise&lt;string&gt;
398 399 400 401 402 403

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

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

**参数:** 
H
HelloCrease 已提交
404 405
| 参数名      | 类型                     | 必填   | 说明   |
| -------- | ---------------------- | ---- | ---- |
406
| resource | [Resource](#resource9) | 是    | 资源信息 |
407 408

**返回值:** 
H
HelloCrease 已提交
409 410
| 类型                    | 说明               |
| --------------------- | ---------------- |
411 412
| Promise&lt;string&gt; | resource对象对应的字符串 |

H
huangjie 已提交
413 414 415 416 417 418 419 420
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

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

421
**示例:** 
H
HelloCrease 已提交
422
  ```ts
423 424 425 426 427
  let resource = {
      bundleName: "com.example.myapplication",
      moduleName: "entry",
      id: $r('app.string.test').id
  };
H
huangjie 已提交
428 429
  try {
    this.context.resourceManager.getStringValue(resource).then(value => {
430
      let str = value;
H
huangjie 已提交
431 432 433 434 435 436
    }).catch(error => {
      console.log("getStringValue promise error is " + error);
    });
  } catch (error) {
    console.error(`callback getStringValue failed, error code: ${error.code}, message: ${error.message}.`)
  }
437 438
  ```

Z
zengyawen 已提交
439

H
huangjie 已提交
440 441 442
### getStringArrayValue<sup>9+</sup>

getStringArrayValue(resId: number, callback: AsyncCallback&lt;Array&lt;string&gt;&gt;): void
Z
zengyawen 已提交
443 444 445

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

V
VictoriaGuo 已提交
446 447
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
448 449 450 451 452
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                |
| -------- | ---------------------------------------- | ---- | ----------------- |
| resId    | number                                   | 是    | 资源ID值             |
| callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是    | 异步回调,用于返回获取的字符串数组 |
Z
zengyawen 已提交
453

H
huangjie 已提交
454 455 456 457 458 459 460 461
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

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

H
HelloCrease 已提交
462
**示例:** 
H
HelloCrease 已提交
463
  ```ts
H
huangjie 已提交
464 465 466 467 468 469 470 471 472 473 474
  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 已提交
475 476 477
  ```


H
huangjie 已提交
478
### getStringArrayValue<sup>9+</sup>
Z
zengyawen 已提交
479

H
huangjie 已提交
480
getStringArrayValue(resId: number): Promise&lt;Array&lt;string&gt;&gt;
Z
zengyawen 已提交
481 482 483

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

V
VictoriaGuo 已提交
484 485
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
486 487 488 489
**参数:** 
| 参数名   | 类型     | 必填   | 说明    |
| ----- | ------ | ---- | ----- |
| resId | number | 是    | 资源ID值 |
Z
zengyawen 已提交
490

H
HelloCrease 已提交
491 492 493 494
**返回值:** 
| 类型                                 | 说明            |
| ---------------------------------- | ------------- |
| Promise&lt;Array&lt;string&gt;&gt; | 资源ID值对应的字符串数组 |
Z
zengyawen 已提交
495

H
huangjie 已提交
496 497 498 499 500 501 502 503
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

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

H
HelloCrease 已提交
504
**示例:** 
H
HelloCrease 已提交
505
  ```ts
H
huangjie 已提交
506 507 508 509 510 511 512 513 514
  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 已提交
515 516
  ```

H
huangjie 已提交
517
### getStringArrayValue<sup>9+</sup>
518

H
huangjie 已提交
519
getStringArrayValue(resource: Resource, callback: AsyncCallback&lt;Array&lt;string&gt;&gt;): void
520 521 522 523 524 525

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

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

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

H
huangjie 已提交
531 532 533 534 535 536 537 538
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

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

539
**示例:** 
H
HelloCrease 已提交
540
  ```ts
541 542 543 544 545
  let resource = {
      bundleName: "com.example.myapplication",
      moduleName: "entry",
      id: $r('app.strarray.test').id
  };
H
huangjie 已提交
546 547
  try {
    this.context.resourceManager.getStringArrayValue(resource, (error, value) => {
548 549 550 551 552
      if (error != null) {
          console.log("error is " + error);
      } else {
          let strArray = value;
      }
H
huangjie 已提交
553 554 555 556
    });
  } catch (error) {
    console.error(`callback getStringArrayValue failed, error code: ${error.code}, message: ${error.message}.`)
  }
557 558
  ```

H
huangjie 已提交
559
### getStringArrayValue<sup>9+</sup>
560

H
huangjie 已提交
561
getStringArrayValue(resource: Resource): Promise&lt;Array&lt;string&gt;&gt;
562 563 564 565 566 567

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

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

**参数:** 
H
HelloCrease 已提交
568 569
| 参数名      | 类型                     | 必填   | 说明   |
| -------- | ---------------------- | ---- | ---- |
570
| resource | [Resource](#resource9) | 是    | 资源信息 |
571 572

**返回值:** 
H
HelloCrease 已提交
573 574
| 类型                                 | 说明                 |
| ---------------------------------- | ------------------ |
575 576
| Promise&lt;Array&lt;string&gt;&gt; | resource对象对应的字符串数组 |

H
huangjie 已提交
577 578 579 580 581 582 583 584
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

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

585
**示例:** 
H
HelloCrease 已提交
586
  ```ts
587 588 589 590 591
  let resource = {
      bundleName: "com.example.myapplication",
      moduleName: "entry",
      id: $r('app.strarray.test').id
  };
H
huangjie 已提交
592 593
  try {
    this.context.resourceManager.getStringArrayValue(resource).then(value => {
594
      let strArray = value;
H
huangjie 已提交
595 596 597 598 599 600
    }).catch(error => {
        console.log("getStringArray promise error is " + error);
    });
  } catch (error) {
    console.error(`promise getStringArrayValue failed, error code: ${error.code}, message: ${error.message}.`)
  }
601
  ```
Z
zengyawen 已提交
602 603


H
huangjie 已提交
604 605 606
### getMediaContent

getMediaContent(resId: number, callback: AsyncCallback&lt;Uint8Array&gt;): void
Z
zengyawen 已提交
607 608 609

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

V
VictoriaGuo 已提交
610 611
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
612 613 614 615 616
**参数:** 
| 参数名      | 类型                              | 必填   | 说明                 |
| -------- | ------------------------------- | ---- | ------------------ |
| resId    | number                          | 是    | 资源ID值              |
| callback | AsyncCallback&lt;Uint8Array&gt; | 是    | 异步回调,用于返回获取的媒体文件内容 |
Z
zengyawen 已提交
617

H
huangjie 已提交
618 619 620 621 622 623 624
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 9001001  | The resId invalid.                       |
| 9001002  | The resource not found by resId.         |

H
HelloCrease 已提交
625
**示例:** 
H
HelloCrease 已提交
626
  ```ts
H
huangjie 已提交
627 628 629 630 631 632 633 634 635 636 637
  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 已提交
638 639 640
  ```


H
huangjie 已提交
641
### getMediaContent
Z
zengyawen 已提交
642

H
huangjie 已提交
643
getMediaContent(resId: number): Promise&lt;Uint8Array&gt;
Z
zengyawen 已提交
644 645 646

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

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

H
HelloCrease 已提交
649 650 651 652
**参数:** 
| 参数名   | 类型     | 必填   | 说明    |
| ----- | ------ | ---- | ----- |
| resId | number | 是    | 资源ID值 |
Z
zengyawen 已提交
653

H
HelloCrease 已提交
654 655 656 657
**返回值:** 
| 类型                        | 说明             |
| ------------------------- | -------------- |
| Promise&lt;Uint8Array&gt; | 资源ID值对应的媒体文件内容 |
Z
zengyawen 已提交
658

H
huangjie 已提交
659 660 661 662 663 664 665
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 9001001  | The resId invalid.                       |
| 9001002  | The resource not found by resId.         |

H
HelloCrease 已提交
666
**示例:** 
H
HelloCrease 已提交
667
  ```ts
H
huangjie 已提交
668 669
  try {
      mgr.getMediaContent($r('app.media.test').id).then(value => {
W
wplan1 已提交
670
          let media = value;
Z
zengyawen 已提交
671
      }).catch(error => {
H
huangjie 已提交
672
          console.log("getMediaContent promise error is " + error);
Z
zengyawen 已提交
673
      });
H
huangjie 已提交
674 675 676
  } catch (error) {
    console.error(`promise getMediaContent failed, error code: ${error.code}, message: ${error.message}.`)
  }
Z
zengyawen 已提交
677 678
  ```

H
huangjie 已提交
679
### getMediaContent<sup>9+</sup>
680

H
huangjie 已提交
681
getMediaContent(resource: Resource, callback: AsyncCallback&lt;Uint8Array&gt;): void
682 683 684 685 686 687

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

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

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

H
huangjie 已提交
693 694 695 696 697 698 699
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 9001001  | The resId invalid.                       |
| 9001002  | The resource not found by resId.         |

700
**示例:** 
H
HelloCrease 已提交
701
  ```ts
702 703 704 705 706
  let resource = {
      bundleName: "com.example.myapplication",
      moduleName: "entry",
      id: $r('app.media.test').id
  };
H
huangjie 已提交
707 708 709
  try {
    this.context.resourceManager.getMediaContent(resource, (error, value) => {
        if (error != null) {
710
          console.log("error is " + error);
H
huangjie 已提交
711
        } else {
712
          let media = value;
H
huangjie 已提交
713 714 715 716 717
        }
    });
  } catch (error) {
    console.error(`callback getMediaContent failed, error code: ${error.code}, message: ${error.message}.`)
  }
718 719
  ```

H
huangjie 已提交
720
### getMediaContent<sup>9+</sup>
721

H
huangjie 已提交
722
getMediaContent(resource: Resource): Promise&lt;Uint8Array&gt;
723 724 725 726 727 728

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

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

**参数:** 
H
HelloCrease 已提交
729 730
| 参数名      | 类型                     | 必填   | 说明   |
| -------- | ---------------------- | ---- | ---- |
731
| resource | [Resource](#resource9) | 是    | 资源信息 |
732 733

**返回值:** 
H
HelloCrease 已提交
734 735
| 类型                        | 说明                  |
| ------------------------- | ------------------- |
736 737
| Promise&lt;Uint8Array&gt; | resource对象对应的媒体文件内容 |

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

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 9001001  | The resId invalid.                       |
| 9001002  | The resource not found by resId.         |

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


H
huangjie 已提交
764 765 766
### getMediaContentBase64

getMediaContentBase64(resId: number, callback: AsyncCallback&lt;string&gt;): void
Z
zengyawen 已提交
767 768 769

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

V
VictoriaGuo 已提交
770 771
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
772 773 774 775 776
**参数:** 
| 参数名      | 类型                          | 必填   | 说明                       |
| -------- | --------------------------- | ---- | ------------------------ |
| resId    | number                      | 是    | 资源ID值                    |
| callback | AsyncCallback&lt;string&gt; | 是    | 异步回调,用于返回获取的图片资源Base64编码 |
Z
zengyawen 已提交
777

H
huangjie 已提交
778 779 780 781 782 783 784
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 9001001  | The resId invalid.                       |
| 9001002  | The resource not found by resId.         |

H
HelloCrease 已提交
785
**示例:** 
H
HelloCrease 已提交
786
  ```ts
H
huangjie 已提交
787 788 789 790 791 792 793 794 795 796 797
  try {
    mgr.getMediaContentBase64($r('app.media.test').id, (error, value) => {
        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 已提交
798 799 800
  ```


H
huangjie 已提交
801
### getMediaContentBase64
Z
zengyawen 已提交
802

H
huangjie 已提交
803
getMediaContentBase64(resId: number): Promise&lt;string&gt;
Z
zengyawen 已提交
804 805 806

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

V
VictoriaGuo 已提交
807 808
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
809 810 811 812
**参数:** 
| 参数名   | 类型     | 必填   | 说明    |
| ----- | ------ | ---- | ----- |
| resId | number | 是    | 资源ID值 |
Z
zengyawen 已提交
813

H
HelloCrease 已提交
814 815 816 817
**返回值:** 
| 类型                    | 说明                   |
| --------------------- | -------------------- |
| Promise&lt;string&gt; | 资源ID值对应的图片资源Base64编码 |
Z
zengyawen 已提交
818

H
huangjie 已提交
819 820 821 822 823 824 825
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 9001001  | The resId invalid.                       |
| 9001002  | The resource not found by resId.         |

H
HelloCrease 已提交
826
**示例:** 
H
HelloCrease 已提交
827
  ```ts
H
huangjie 已提交
828 829 830 831 832 833 834 835 836
  try {
    mgr.getMediaContentBase64($r('app.media.test').id).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}.`)
  } 
Z
zengyawen 已提交
837 838
  ```

H
huangjie 已提交
839
### getMediaContentBase64<sup>9+</sup>
840

H
huangjie 已提交
841
getMediaContentBase64(resource: Resource, callback: AsyncCallback&lt;string&gt;): void
842 843 844 845 846 847 848 849

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

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

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

H
huangjie 已提交
853 854 855 856 857 858 859
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 9001001  | The resId invalid.                       |
| 9001002  | The resource not found by resId.         |

860
**示例:** 
H
HelloCrease 已提交
861
  ```ts
862 863 864 865 866
  let resource = {
      bundleName: "com.example.myapplication",
      moduleName: "entry",
      id: $r('app.media.test').id
  };
H
huangjie 已提交
867 868 869 870 871 872 873 874 875 876 877
  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}.`)
  }
878 879
  ```

H
huangjie 已提交
880
### getMediaContentBase64<sup>9+</sup>
881

H
huangjie 已提交
882
getMediaContentBase64(resource: Resource): Promise&lt;string&gt;
883 884 885 886 887 888

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

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

**参数:** 
H
HelloCrease 已提交
889 890
| 参数名      | 类型                     | 必填   | 说明   |
| -------- | ---------------------- | ---- | ---- |
891
| resource | [Resource](#resource9) | 是    | 资源信息 |
892 893

**返回值:** 
H
HelloCrease 已提交
894 895
| 类型                    | 说明                        |
| --------------------- | ------------------------- |
896 897
| Promise&lt;string&gt; | resource对象对应的图片资源Base64编码 |

H
huangjie 已提交
898 899 900 901 902 903 904
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 9001001  | The resId invalid.                       |
| 9001002  | The resource not found by resId.         |

905
**示例:** 
H
HelloCrease 已提交
906
  ```ts
907 908 909 910 911
  let resource = {
      bundleName: "com.example.myapplication",
      moduleName: "entry",
      id: $r('app.media.test').id
  };
H
huangjie 已提交
912 913 914 915 916 917 918 919 920
  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}.`)
  }
921 922
  ```

Z
zengyawen 已提交
923 924 925 926

### getConfiguration

getConfiguration(callback: AsyncCallback&lt;Configuration&gt;): void
Z
zengyawen 已提交
927 928 929

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

V
VictoriaGuo 已提交
930 931
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
932 933 934 935
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                        |
| -------- | ---------------------------------------- | ---- | ------------------------- |
| callback | AsyncCallback&lt;[Configuration](#configuration)&gt; | 是    | 异步回调,用于返回设备的Configuration |
Z
zengyawen 已提交
936

H
HelloCrease 已提交
937
**示例:** 
H
HelloCrease 已提交
938
  ```ts
Z
zengyawen 已提交
939 940 941
  resourceManager.getResourceManager((error, mgr) => {
      mgr.getConfiguration((error, value) => {
          if (error != null) {
W
wplan1 已提交
942
              console.log("error is " + error);
Z
zengyawen 已提交
943
          } else {
W
wplan1 已提交
944 945
              let direction = value.direction;
              let locale = value.locale;
Z
zengyawen 已提交
946 947 948 949
          }
      });
  });
  ```
Z
zengyawen 已提交
950 951


Z
zengyawen 已提交
952
### getConfiguration
Z
zengyawen 已提交
953

Z
zengyawen 已提交
954 955 956
getConfiguration(): Promise&lt;Configuration&gt;

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

V
VictoriaGuo 已提交
958 959
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
960 961 962 963
**返回值:** 
| 类型                                       | 说明               |
| ---------------------------------------- | ---------------- |
| Promise&lt;[Configuration](#configuration)&gt; | 设备的Configuration |
Z
zengyawen 已提交
964

H
HelloCrease 已提交
965
**示例:** 
H
HelloCrease 已提交
966
  ```ts
Z
zengyawen 已提交
967 968
  resourceManager.getResourceManager((error, mgr) => {
      mgr.getConfiguration().then(value => {
W
wplan1 已提交
969 970
          let direction = value.direction;
          let locale = value.locale;
Z
zengyawen 已提交
971
      }).catch(error => {
W
wplan1 已提交
972
          console.log("getConfiguration promise error is " + error);
Z
zengyawen 已提交
973 974 975
      });
  });
  ```
Z
zengyawen 已提交
976 977


Z
zengyawen 已提交
978 979 980
### getDeviceCapability

getDeviceCapability(callback: AsyncCallback&lt;DeviceCapability&gt;): void
Z
zengyawen 已提交
981 982 983

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

V
VictoriaGuo 已提交
984 985
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
986 987 988 989
**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                           |
| -------- | ---------------------------------------- | ---- | ---------------------------- |
| callback | AsyncCallback&lt;[DeviceCapability](#devicecapability)&gt; | 是    | 异步回调,用于返回设备的DeviceCapability |
Z
zengyawen 已提交
990

H
HelloCrease 已提交
991
**示例:** 
H
HelloCrease 已提交
992
  ```ts
Z
zengyawen 已提交
993 994 995
  resourceManager.getResourceManager((error, mgr) => {
      mgr.getDeviceCapability((error, value) => {
          if (error != null) {
W
wplan1 已提交
996
              console.log("error is " + error);
Z
zengyawen 已提交
997
          } else {
W
wplan1 已提交
998 999
              let screenDensity = value.screenDensity;
              let deviceType = value.deviceType;
Z
zengyawen 已提交
1000 1001 1002 1003
          }
      });
  });
  ```
Z
zengyawen 已提交
1004 1005


Z
zengyawen 已提交
1006
### getDeviceCapability
Z
zengyawen 已提交
1007

Z
zengyawen 已提交
1008 1009 1010
getDeviceCapability(): Promise&lt;DeviceCapability&gt;

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

V
VictoriaGuo 已提交
1012 1013
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
1014 1015 1016 1017
**返回值:** 
| 类型                                       | 说明                  |
| ---------------------------------------- | ------------------- |
| Promise&lt;[DeviceCapability](#devicecapability)&gt; | 设备的DeviceCapability |
Z
zengyawen 已提交
1018

H
HelloCrease 已提交
1019
**示例:** 
H
HelloCrease 已提交
1020
  ```ts
Z
zengyawen 已提交
1021 1022
  resourceManager.getResourceManager((error, mgr) => {
      mgr.getDeviceCapability().then(value => {
W
wplan1 已提交
1023 1024
          let screenDensity = value.screenDensity;
          let deviceType = value.deviceType;
Z
zengyawen 已提交
1025
      }).catch(error => {
W
wplan1 已提交
1026
          console.log("getDeviceCapability promise error is " + error);
Z
zengyawen 已提交
1027 1028 1029
      });
  });
  ```
Z
zengyawen 已提交
1030 1031


H
huangjie 已提交
1032
### getPluralStringValue
Z
zengyawen 已提交
1033

H
huangjie 已提交
1034
getPluralStringValue(resId: number, num: number, callback: AsyncCallback&lt;string&gt;): void
Z
zengyawen 已提交
1035 1036 1037

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

V
VictoriaGuo 已提交
1038 1039
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
1040 1041 1042 1043 1044 1045
**参数:** 
| 参数名      | 类型                          | 必填   | 说明                              |
| -------- | --------------------------- | ---- | ------------------------------- |
| resId    | number                      | 是    | 资源ID值                           |
| num      | number                      | 是    | 数量值                             |
| callback | AsyncCallback&lt;string&gt; | 是    | 异步回调,返回根据指定数量获取指定ID字符串表示的单复数字符串 |
Z
zengyawen 已提交
1046

H
huangjie 已提交
1047 1048 1049 1050 1051 1052 1053 1054
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

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

H
HelloCrease 已提交
1055
**示例:** 
H
HelloCrease 已提交
1056
  ```ts
H
huangjie 已提交
1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067
  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 已提交
1068
  ```
Z
zengyawen 已提交
1069 1070


H
huangjie 已提交
1071
### getPluralStringValue
Z
zengyawen 已提交
1072

H
huangjie 已提交
1073
getPluralStringValue(resId: number, num: number): Promise&lt;string&gt;
Z
zengyawen 已提交
1074 1075

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

V
VictoriaGuo 已提交
1077 1078
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
1079 1080 1081 1082 1083
**参数:** 
| 参数名   | 类型     | 必填   | 说明    |
| ----- | ------ | ---- | ----- |
| resId | number | 是    | 资源ID值 |
| num   | number | 是    | 数量值   |
Z
zengyawen 已提交
1084

H
HelloCrease 已提交
1085 1086 1087 1088
**返回值:** 
| 类型                    | 说明                        |
| --------------------- | ------------------------- |
| Promise&lt;string&gt; | 根据提供的数量获取对应ID字符串表示的单复数字符串 |
Z
zengyawen 已提交
1089

H
huangjie 已提交
1090 1091 1092 1093 1094 1095 1096 1097
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

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

H
HelloCrease 已提交
1098
**示例:** 
H
HelloCrease 已提交
1099
  ```ts
H
huangjie 已提交
1100 1101 1102 1103 1104 1105 1106 1107 1108
  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 已提交
1109
  ```
Z
zengyawen 已提交
1110

H
huangjie 已提交
1111
### getPluralStringValue<sup>9+</sup>
1112

H
huangjie 已提交
1113
getPluralStringValue(resource: Resource, num: number, callback: AsyncCallback&lt;string&gt;): void
1114 1115 1116 1117 1118 1119

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

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

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

H
huangjie 已提交
1126 1127 1128 1129 1130 1131 1132 1133
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

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

1134
**示例:** 
H
HelloCrease 已提交
1135
  ```ts
1136 1137 1138 1139 1140
  let resource = {
      bundleName: "com.example.myapplication",
      moduleName: "entry",
      id: $r('app.plural.test').id
  };
H
huangjie 已提交
1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152
  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}.`)
  }  
  
1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163
  ```

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

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

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

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

**参数:** 
H
HelloCrease 已提交
1164 1165
| 参数名      | 类型                     | 必填   | 说明   |
| -------- | ---------------------- | ---- | ---- |
1166
| resource | [Resource](#resource9) | 是    | 资源信息 |
H
HelloCrease 已提交
1167
| num      | number                 | 是    | 数量值  |
1168 1169

**返回值:** 
H
HelloCrease 已提交
1170 1171
| 类型                    | 说明                             |
| --------------------- | ------------------------------ |
1172 1173
| Promise&lt;string&gt; | 根据提供的数量获取对应resource对象表示的单复数字符串 |

H
huangjie 已提交
1174 1175 1176 1177 1178 1179 1180 1181
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

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

1182
**示例:** 
H
HelloCrease 已提交
1183
  ```ts
1184 1185 1186 1187 1188
  let resource = {
      bundleName: "com.example.myapplication",
      moduleName: "entry",
      id: $r('app.plural.test').id
  };
H
huangjie 已提交
1189 1190 1191 1192 1193 1194 1195 1196 1197
  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}.`)
  }
1198 1199
  ```

Z
zengyawen 已提交
1200

H
huangjie 已提交
1201 1202 1203
### getRawFileContent<sup>9+</sup>

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

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

V
VictoriaGuo 已提交
1207 1208
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
1209 1210 1211 1212 1213
**参数:** 
| 参数名      | 类型                              | 必填   | 说明                      |
| -------- | ------------------------------- | ---- | ----------------------- |
| path     | string                          | 是    | rawfile文件路径             |
| callback | AsyncCallback&lt;Uint8Array&gt; | 是    | 异步回调,用于返回获取的rawfile文件内容 |
Z
zengyawen 已提交
1214

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

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 9001005  | The resource not found by path.          |

H
HelloCrease 已提交
1221
**示例:** 
H
HelloCrease 已提交
1222
  ```ts
H
huangjie 已提交
1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234
  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 已提交
1235 1236
  ```

H
huangjie 已提交
1237
### getRawFileContent<sup>9+</sup>
Z
zengyawen 已提交
1238

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

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

V
VictoriaGuo 已提交
1243 1244
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
1245 1246 1247 1248
**参数:** 
| 参数名  | 类型     | 必填   | 说明          |
| ---- | ------ | ---- | ----------- |
| path | string | 是    | rawfile文件路径 |
Z
zengyawen 已提交
1249

H
HelloCrease 已提交
1250 1251 1252 1253
**返回值:** 
| 类型                        | 说明          |
| ------------------------- | ----------- |
| Promise&lt;Uint8Array&gt; | rawfile文件内容 |
Z
zengyawen 已提交
1254

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

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 9001005  | The resource not found by path.          |

H
HelloCrease 已提交
1261
**示例:** 
H
HelloCrease 已提交
1262
  ```ts
H
huangjie 已提交
1263 1264 1265 1266 1267 1268 1269 1270 1271
  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 已提交
1272
  ```
W
wplan1 已提交
1273 1274


H
huangjie 已提交
1275 1276 1277
### getRawFd<sup>9+</sup>

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

H
huangjie 已提交
1279
用户获取resources/rawfile目录下对应rawfile文件的descriptor,使用callback形式返回。
W
wplan1 已提交
1280 1281 1282

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

H
HelloCrease 已提交
1283
**参数:** 
H
HelloCrease 已提交
1284 1285 1286
| 参数名      | 类型                                       | 必填   | 说明                               |
| -------- | ---------------------------------------- | ---- | -------------------------------- |
| path     | string                                   | 是    | rawfile文件路径                      |
H
huangjie 已提交
1287 1288 1289 1290 1291 1292 1293
| callback | AsyncCallback&lt;[getRawFd](#getrawfd9)&gt; | 是    | 异步回调,用于返回获取的rawfile文件的descriptor |

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

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 9001005  | The resource not found by path.          |
W
wplan1 已提交
1294

H
HelloCrease 已提交
1295
**示例:** 
H
HelloCrease 已提交
1296
  ```ts
H
huangjie 已提交
1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308
  try {
    this.context.resourceManager.getRawFd("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;
        }
    });
  } catch(error => {
    console.log("getRawFd callback error is " + error);
W
wplan1 已提交
1309 1310 1311
  });
  ```

H
huangjie 已提交
1312
### getRawFd<sup>9+</sup>
W
wplan1 已提交
1313

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

H
huangjie 已提交
1316
用户获取resources/rawfile目录下对应rawfile文件的descriptor,使用Promise形式返回。
W
wplan1 已提交
1317 1318 1319

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

H
HelloCrease 已提交
1320 1321 1322 1323
**参数:** 
| 参数名  | 类型     | 必填   | 说明          |
| ---- | ------ | ---- | ----------- |
| path | string | 是    | rawfile文件路径 |
W
wplan1 已提交
1324

H
HelloCrease 已提交
1325 1326 1327
**返回值:** 
| 类型                                       | 说明                  |
| ---------------------------------------- | ------------------- |
H
huangjie 已提交
1328 1329 1330 1331 1332 1333 1334
| Promise&lt;[getRawFd](#getrawfd9-1)&gt; | rawfile文件descriptor |

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

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 9001005  | The resource not found by path.          |
W
wplan1 已提交
1335

H
HelloCrease 已提交
1336
**示例:** 
H
HelloCrease 已提交
1337
  ```ts
H
huangjie 已提交
1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348
  try {
    this.context.resourceManager.getRawFd("test.xml").then(value => {
        let fd = value.fd;
        let offset = value.offset;
        let length = value.length;
    }).catch(error => {
        console.log("getRawFd promise error is " + error);
    });
  } catch (error) {
    console.log("getRawFd promise error is " + error);
  };
W
wplan1 已提交
1349 1350 1351 1352 1353 1354
  ```

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

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

H
huangjie 已提交
1355
用户关闭resources/rawfile目录下rawfile文件的descriptor,使用callback形式返回。
W
wplan1 已提交
1356 1357 1358

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

H
HelloCrease 已提交
1359 1360 1361 1362 1363
**参数:** 
| 参数名      | 类型                        | 必填   | 说明          |
| -------- | ------------------------- | ---- | ----------- |
| path     | string                    | 是    | rawfile文件路径 |
| callback | AsyncCallback&lt;void&gt; | 是    | 异步回调        |
W
wplan1 已提交
1364

H
HelloCrease 已提交
1365
**示例:** 
H
HelloCrease 已提交
1366
  ```ts
W
wplan1 已提交
1367 1368 1369
  resourceManager.getResourceManager((error, mgr) => {
      mgr.closeRawFileDescriptor("test.xml", (error, value) => {
          if (error != null) {
W
wplan1 已提交
1370
              console.log("error is " + error);
W
wplan1 已提交
1371 1372 1373 1374 1375 1376 1377 1378 1379
          }
      });
  });
  ```

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

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

H
huangjie 已提交
1380
用户关闭resources/rawfile目录下rawfile文件的descriptor,使用Promise形式返回。
W
wplan1 已提交
1381 1382 1383

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

H
HelloCrease 已提交
1384 1385 1386 1387
**参数:** 
| 参数名  | 类型     | 必填   | 说明          |
| ---- | ------ | ---- | ----------- |
| path | string | 是    | rawfile文件路径 |
W
wplan1 已提交
1388

H
HelloCrease 已提交
1389 1390 1391 1392
**返回值:** 
| 类型                  | 说明   |
| ------------------- | ---- |
| Promise&lt;void&gt; | 无返回值 |
W
wplan1 已提交
1393

H
HelloCrease 已提交
1394
**示例:** 
H
HelloCrease 已提交
1395
  ```ts
W
wplan1 已提交
1396 1397
  resourceManager.getResourceManager((error, mgr) => {
      mgr.closeRawFileDescriptor("test.xml").then(value => {
W
wplan1 已提交
1398
          let result = value;
W
wplan1 已提交
1399
      }).catch(error => {
W
wplan1 已提交
1400
          console.log("closeRawFileDescriptor promise error is " + error);
W
wplan1 已提交
1401 1402 1403 1404 1405
      });
  });
  ```


H
huangjie 已提交
1406
### closeRawFd<sup>9+</sup>
W
wplan1 已提交
1407

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

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

H
huangjie 已提交
1412
**系统能力**:SystemCapability.Global.ResourceManager
H
huangjie 已提交
1413

H
huangjie 已提交
1414 1415 1416 1417 1418
**参数:** 
| 参数名      | 类型                        | 必填   | 说明          |
| -------- | ------------------------- | ---- | ----------- |
| path     | string                    | 是    | rawfile文件路径 |
| callback | AsyncCallback&lt;void&gt; | 是    | 异步回调        |
H
huangjie 已提交
1419

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

H
huangjie 已提交
1422 1423 1424
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 9001005  | The resource not found by path.          |
H
huangjie 已提交
1425

H
huangjie 已提交
1426
**示例:** 
H
HelloCrease 已提交
1427
  ```ts
H
huangjie 已提交
1428 1429 1430 1431 1432 1433 1434 1435 1436 1437
  try {
    mgr.closeRawFd("test.xml", (error, value) => {
        if (error != null) {
            console.log("error is " + error);
        }
    });
  } catch (error) {
    console.error(`callback closeRawFd failed, error code: ${error.code}, message: ${error.message}.`)
  }
      
H
huangjie 已提交
1438 1439
  ```

H
huangjie 已提交
1440
### closeRawFd<sup>8+</sup>
H
huangjie 已提交
1441

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

H
huangjie 已提交
1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534
用户关闭resources/rawfile目录下rawfile文件的descriptor,使用Promise形式返回。

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

**参数:** 
| 参数名  | 类型     | 必填   | 说明          |
| ---- | ------ | ---- | ----------- |
| path | string | 是    | rawfile文件路径 |

**返回值:** 
| 类型                  | 说明   |
| ------------------- | ---- |
| Promise&lt;void&gt; | 无返回值 |

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

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 9001005  | The resource not found by path.          |

**示例:** 
  ```ts
  try {
    mgr.closeRawFd("test.xml").then(value => {
        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

**参数:**
| 参数名      | 类型                          | 必填   | 说明              |
| -------- | --------------------------- | ---- | --------------- |
| resName  | string                      | 是    | 资源名称            |
| callback | AsyncCallback&lt;string&gt; | 是    | 异步回调,用于返回获取的字符串 |

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

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 9001003  | The resName invalid.                     |
| 9001004  | The resource not found by resName.       |
| 9001006  | The resource re-ref too much.            |

**示例:**
  ```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 已提交
1535 1536 1537 1538

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

**参数:**
H
HelloCrease 已提交
1539
| 参数名     | 类型     | 必填   | 说明   |
H
huangjie 已提交
1540
| ------- | ------ | ---- | ---- |
H
HelloCrease 已提交
1541
| resName | string | 是    | 资源名称 |
H
huangjie 已提交
1542 1543

**返回值:**
H
HelloCrease 已提交
1544 1545
| 类型                    | 说明         |
| --------------------- | ---------- |
H
huangjie 已提交
1546 1547
| Promise&lt;string&gt; | 资源名称对应的字符串 |

H
huangjie 已提交
1548 1549 1550 1551 1552 1553 1554 1555
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 9001003  | The resName invalid.                     |
| 9001004  | The resource not found by resName.       |
| 9001006  | The resource re-ref too much.            |

H
huangjie 已提交
1556
**示例:**
H
HelloCrease 已提交
1557
  ```ts
H
huangjie 已提交
1558 1559 1560 1561 1562 1563 1564 1565 1566
  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 已提交
1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579
  ```

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

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

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

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

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

H
huangjie 已提交
1583 1584 1585 1586 1587 1588 1589 1590
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 9001003  | The resName invalid.                     |
| 9001004  | The resource not found by resName.       |
| 9001006  | The resource re-ref too much.            |

H
huangjie 已提交
1591
**示例:** 
H
HelloCrease 已提交
1592
  ```ts
H
huangjie 已提交
1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603
  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 已提交
1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614
  ```

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

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

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

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

**参数:** 
H
HelloCrease 已提交
1615 1616 1617
| 参数名     | 类型     | 必填   | 说明   |
| ------- | ------ | ---- | ---- |
| resName | string | 是    | 资源名称 |
H
huangjie 已提交
1618 1619

**返回值:** 
H
HelloCrease 已提交
1620 1621
| 类型                                 | 说明           |
| ---------------------------------- | ------------ |
H
huangjie 已提交
1622 1623
| Promise&lt;Array&lt;string&gt;&gt; | 资源名称对应的字符串数组 |

H
huangjie 已提交
1624 1625 1626 1627 1628 1629 1630 1631
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 9001003  | The resName invalid.                     |
| 9001004  | The resource not found by resName.       |
| 9001006  | The resource re-ref too much.            |

H
huangjie 已提交
1632
**示例:** 
H
HelloCrease 已提交
1633
  ```ts
H
huangjie 已提交
1634 1635 1636 1637 1638 1639 1640 1641 1642
  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 已提交
1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655
  ```

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

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

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

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

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

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

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 9001003  | The resName invalid.                     |
| 9001004  | The resource not found by resName.       |
| 9001006  | The resource re-ref too much.            |

H
huangjie 已提交
1667
**示例:** 
H
HelloCrease 已提交
1668
  ```ts
H
huangjie 已提交
1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679
  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 已提交
1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690
  ```

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

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

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

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

**参数:** 
H
HelloCrease 已提交
1691 1692
| 参数名     | 类型     | 必填   | 说明   |
| ------- | ------ | ---- | ---- |
H
huangjie 已提交
1693 1694 1695
| resName | string | 是    | 资源名称 |

**返回值:** 
H
HelloCrease 已提交
1696 1697
| 类型                        | 说明            |
| ------------------------- | ------------- |
H
huangjie 已提交
1698 1699
| Promise&lt;Uint8Array&gt; | 资源名称对应的媒体文件内容 |

H
huangjie 已提交
1700 1701 1702 1703 1704 1705 1706 1707
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 9001003  | The resName invalid.                     |
| 9001004  | The resource not found by resName.       |
| 9001006  | The resource re-ref too much.            |

H
huangjie 已提交
1708
**示例:** 
H
HelloCrease 已提交
1709
  ```ts
H
huangjie 已提交
1710 1711 1712 1713 1714 1715 1716 1717 1718
  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 已提交
1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731
  ```

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

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

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

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

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

H
huangjie 已提交
1735 1736 1737 1738 1739 1740 1741 1742
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 9001003  | The resName invalid.                     |
| 9001004  | The resource not found by resName.       |
| 9001006  | The resource re-ref too much.            |

H
huangjie 已提交
1743
**示例:** 
H
HelloCrease 已提交
1744
  ```ts
H
huangjie 已提交
1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755
  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 已提交
1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766
  ```

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

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

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

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

**参数:** 
H
HelloCrease 已提交
1767 1768 1769
| 参数名     | 类型     | 必填   | 说明   |
| ------- | ------ | ---- | ---- |
| resName | string | 是    | 资源名称 |
H
huangjie 已提交
1770 1771

**返回值:** 
H
HelloCrease 已提交
1772 1773
| 类型                    | 说明                  |
| --------------------- | ------------------- |
H
huangjie 已提交
1774 1775
| Promise&lt;string&gt; | 资源名称对应的图片资源Base64编码 |

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

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 9001003  | The resName invalid.                     |
| 9001004  | The resource not found by resName.       |
| 9001006  | The resource re-ref too much.            |

H
huangjie 已提交
1784
**示例:** 
H
HelloCrease 已提交
1785
  ```ts
H
huangjie 已提交
1786 1787 1788 1789 1790 1791 1792 1793 1794
  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 已提交
1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805
  ```

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

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

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

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

**参数:** 
H
HelloCrease 已提交
1806 1807 1808 1809
| 参数名      | 类型                          | 必填   | 说明                            |
| -------- | --------------------------- | ---- | ----------------------------- |
| resName  | string                      | 是    | 资源名称                          |
| num      | number                      | 是    | 数量值                           |
H
huangjie 已提交
1810 1811
| callback | AsyncCallback&lt;string&gt; | 是    | 异步回调,返回根据传入的数量值获取资源名称对应的字符串资源 |

H
huangjie 已提交
1812 1813 1814 1815 1816 1817 1818 1819
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 9001003  | The resName invalid.                     |
| 9001004  | The resource not found by resName.       |
| 9001006  | The resource re-ref too much.            |

H
huangjie 已提交
1820
**示例:** 
H
HelloCrease 已提交
1821
  ```ts
H
huangjie 已提交
1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833
  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 已提交
1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844
  ```

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

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

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

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

**参数:** 
H
HelloCrease 已提交
1845 1846
| 参数名     | 类型     | 必填   | 说明   |
| ------- | ------ | ---- | ---- |
H
huangjie 已提交
1847
| resName | string | 是    | 资源名称 |
H
HelloCrease 已提交
1848
| num     | number | 是    | 数量值  |
H
huangjie 已提交
1849 1850

**返回值:** 
H
HelloCrease 已提交
1851 1852
| 类型                    | 说明                     |
| --------------------- | ---------------------- |
H
huangjie 已提交
1853 1854
| Promise&lt;string&gt; | 根据传入的数量值获取资源名称对应的字符串资源 |

H
huangjie 已提交
1855 1856 1857 1858 1859 1860 1861 1862
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 9001003  | The resName invalid.                     |
| 9001004  | The resource not found by resName.       |
| 9001006  | The resource re-ref too much.            |

H
huangjie 已提交
1863
**示例:** 
H
HelloCrease 已提交
1864
  ```ts
H
huangjie 已提交
1865 1866
  try {
    this.context.resourceManager.getPluralStringByName("test", 1).then(value => {
H
huangjie 已提交
1867
      let str = value;
H
huangjie 已提交
1868
    }).catch(error => {
H
huangjie 已提交
1869
      console.log("getPluralStringByName promise error is " + error);
H
huangjie 已提交
1870 1871 1872 1873
    });
  } catch (error) {
    console.error(`promise getPluralStringByName failed, error code: ${error.code}, message: ${error.message}.`)
  }
H
huangjie 已提交
1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889
  ```

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

getStringSync(resId: number): string

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

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

**参数:** 
| 参数名   | 类型     | 必填   | 说明    |
| ----- | ------ | ---- | ----- |
| resId | number | 是    | 资源ID值 |

**返回值:** 
H
HelloCrease 已提交
1890 1891
| 类型     | 说明          |
| ------ | ----------- |
H
huangjie 已提交
1892 1893 1894
| string | 资源ID值对应的字符串 |

**示例:** 
H
HelloCrease 已提交
1895
  ```ts
H
huangjie 已提交
1896 1897 1898 1899 1900
  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 已提交
1901 1902
  ```

1903 1904 1905 1906 1907 1908 1909 1910 1911
### getStringSync<sup>9+</sup>

getStringSync(resource: Resource): string

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

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

**参数:** 
H
HelloCrease 已提交
1912 1913
| 参数名      | 类型                     | 必填   | 说明   |
| -------- | ---------------------- | ---- | ---- |
1914
| resource | [Resource](#resource9) | 是    | 资源信息 |
1915 1916

**返回值:** 
H
HelloCrease 已提交
1917 1918
| 类型     | 说明               |
| ------ | ---------------- |
1919 1920
| string | resource对象对应的字符串 |

H
huangjie 已提交
1921 1922 1923 1924 1925 1926 1927 1928
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

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

1929
**示例:** 
H
HelloCrease 已提交
1930
  ```ts
1931 1932 1933 1934 1935
  let resource = {
      bundleName: "com.example.myapplication",
      moduleName: "entry",
      id: $r('app.string.test').id
  };
H
huangjie 已提交
1936 1937 1938 1939 1940
  try {
    this.context.resourceManager.getStringSync(resource);
  } catch (error) {
    console.error(`getStringSync failed, error code: ${error.code}, message: ${error.message}.`)
  }
1941 1942
  ```

H
huangjie 已提交
1943 1944 1945 1946 1947 1948 1949 1950 1951
### getStringByNameSync<sup>9+</sup>

getStringByNameSync(resName: string): string

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

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

**参数:** 
H
HelloCrease 已提交
1952 1953
| 参数名     | 类型     | 必填   | 说明   |
| ------- | ------ | ---- | ---- |
H
huangjie 已提交
1954 1955 1956
| resName | string | 是    | 资源名称 |

**返回值:** 
H
HelloCrease 已提交
1957 1958
| 类型     | 说明         |
| ------ | ---------- |
H
huangjie 已提交
1959 1960
| string | 资源名称对应的字符串 |

H
huangjie 已提交
1961 1962 1963 1964 1965 1966 1967 1968
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 9001003  | The resName invalid.                     |
| 9001004  | The resource not found by resName.       |
| 9001006  | The resource re-ref too much.            |

H
huangjie 已提交
1969
**示例:** 
H
HelloCrease 已提交
1970
  ```ts
H
huangjie 已提交
1971 1972 1973 1974 1975
  try {
    this.context.resourceManager.getStringByNameSync("test");
  } catch (error) {
    console.error(`getStringByNameSync failed, error code: ${error.code}, message: ${error.message}.`)
  }
H
huangjie 已提交
1976 1977
  ```

H
huangjie 已提交
1978
### getBoolean<sup>9+</sup>
H
huangjie 已提交
1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991

getBoolean(resId: number): boolean

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

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

**参数:** 
| 参数名   | 类型     | 必填   | 说明    |
| ----- | ------ | ---- | ----- |
| resId | number | 是    | 资源ID值 |

**返回值:** 
H
HelloCrease 已提交
1992 1993
| 类型      | 说明           |
| ------- | ------------ |
H
huangjie 已提交
1994 1995
| boolean | 资源ID值对应的布尔结果 |

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

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

H
huangjie 已提交
2004
**示例:** 
H
HelloCrease 已提交
2005
  ```ts
H
huangjie 已提交
2006 2007 2008 2009 2010
  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 已提交
2011
  ```
2012 2013 2014 2015 2016 2017 2018 2019 2020
### getBoolean<sup>9+</sup>

getBoolean(resource: Resource): boolean

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

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

**参数:** 
H
HelloCrease 已提交
2021 2022
| 参数名      | 类型                     | 必填   | 说明   |
| -------- | ---------------------- | ---- | ---- |
2023
| resource | [Resource](#resource9) | 是    | 资源信息 |
2024 2025

**返回值:** 
H
HelloCrease 已提交
2026 2027
| 类型      | 说明                |
| ------- | ----------------- |
2028 2029
| boolean | resource对象对应的布尔结果 |

H
huangjie 已提交
2030 2031 2032 2033 2034 2035 2036 2037
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

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

2038
**示例:** 
H
HelloCrease 已提交
2039
  ```ts
2040 2041 2042 2043 2044
  let resource = {
      bundleName: "com.example.myapplication",
      moduleName: "entry",
      id: $r('app.boolean.boolean_test').id
  };
H
huangjie 已提交
2045 2046 2047 2048 2049
  try {
    this.context.resourceManager.getBoolean(resource);
  } catch (error) {
    console.error(`getBoolean failed, error code: ${error.code}, message: ${error.message}.`)
  }
2050
  ```
H
huangjie 已提交
2051 2052 2053 2054 2055 2056 2057 2058 2059 2060

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

getBooleanByName(resName: string): boolean

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

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

**参数:** 
H
HelloCrease 已提交
2061 2062 2063
| 参数名     | 类型     | 必填   | 说明   |
| ------- | ------ | ---- | ---- |
| resName | string | 是    | 资源名称 |
H
huangjie 已提交
2064 2065

**返回值:** 
H
HelloCrease 已提交
2066 2067
| 类型      | 说明          |
| ------- | ----------- |
H
huangjie 已提交
2068 2069
| boolean | 资源名称对应的布尔结果 |

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

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 9001003  | The resName invalid.                     |
| 9001004  | The resource not found by resName.       |
| 9001006  | The resource re-ref too much.            |

H
huangjie 已提交
2078
**示例:** 
H
HelloCrease 已提交
2079
  ```ts
H
huangjie 已提交
2080 2081 2082 2083 2084
  try {
    this.context.resourceManager.getBooleanByName("boolean_test");
  } catch (error) {
    console.error(`getBooleanByName failed, error code: ${error.code}, message: ${error.message}.`)
  }
H
huangjie 已提交
2085 2086
  ```

H
huangjie 已提交
2087
### getNumber<sup>9+</sup>
H
huangjie 已提交
2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100

getNumber(resId: number): number

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

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

**参数:** 
| 参数名   | 类型     | 必填   | 说明    |
| ----- | ------ | ---- | ----- |
| resId | number | 是    | 资源ID值 |

**返回值:** 
H
HelloCrease 已提交
2101 2102
| 类型     | 说明         |
| ------ | ---------- |
H
huangjie 已提交
2103 2104
| number | 资源ID值对应的数值 |

H
huangjie 已提交
2105 2106 2107 2108 2109 2110 2111 2112
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

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

H
huangjie 已提交
2113
**示例:** 
H
HelloCrease 已提交
2114
  ```ts
H
huangjie 已提交
2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125
  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 已提交
2126 2127
  ```

2128 2129 2130 2131 2132 2133 2134 2135 2136
### getNumber<sup>9+</sup>

getNumber(resource: Resource): number

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

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

**参数:** 
H
HelloCrease 已提交
2137 2138
| 参数名      | 类型                     | 必填   | 说明   |
| -------- | ---------------------- | ---- | ---- |
2139
| resource | [Resource](#resource9) | 是    | 资源信息 |
2140 2141

**返回值:** 
H
HelloCrease 已提交
2142 2143
| 类型     | 说明              |
| ------ | --------------- |
2144 2145
| number | resource对象对应的数值 |

H
huangjie 已提交
2146 2147 2148 2149 2150 2151 2152 2153
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

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

2154
**示例:** 
H
HelloCrease 已提交
2155
  ```ts
2156 2157 2158 2159 2160
  let resource = {
      bundleName: "com.example.myapplication",
      moduleName: "entry",
      id: $r('app.integer.integer_test').id
  };
H
huangjie 已提交
2161 2162 2163 2164 2165
  try {
    this.context.resourceManager.getNumber(resource);
  } catch (error) {
    console.error(`getNumber failed, error code: ${error.code}, message: ${error.message}.`)
  }
2166 2167
  ```

H
huangjie 已提交
2168 2169 2170 2171 2172 2173 2174 2175 2176
### getNumberByName<sup>9+</sup>

getNumberByName(resName: string): number

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

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

**参数:** 
H
HelloCrease 已提交
2177 2178
| 参数名     | 类型     | 必填   | 说明   |
| ------- | ------ | ---- | ---- |
H
huangjie 已提交
2179 2180 2181
| resName | string | 是    | 资源名称 |

**返回值:** 
H
HelloCrease 已提交
2182 2183
| 类型     | 说明        |
| ------ | --------- |
H
huangjie 已提交
2184 2185
| number | 资源名称对应的数值 |

H
huangjie 已提交
2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321
以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 9001003  | The resName invalid.                     |
| 9001004  | The resource not found by resName.       |
| 9001006  | The resource re-ref too much.            |

**示例:** 
  ```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

**参数:** 
| 参数名      | 类型                          | 必填   | 说明              |
| -------- | --------------------------- | ---- | --------------- |
| 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

**参数:** 
| 参数名   | 类型     | 必填   | 说明    |
| ----- | ------ | ---- | ----- |
| resId | number | 是    | 资源ID值 |

**返回值:** 
| 类型                    | 说明          |
| --------------------- | ----------- |
| 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

**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                |
| -------- | ---------------------------------------- | ---- | ----------------- |
| 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

**参数:** 
| 参数名   | 类型     | 必填   | 说明    |
| ----- | ------ | ---- | ----- |
| resId | number | 是    | 资源ID值 |

**返回值:** 
| 类型                                 | 说明            |
| ---------------------------------- | ------------- |
| Promise&lt;Array&lt;string&gt;&gt; | 资源ID值对应的字符串数组 |

H
huangjie 已提交
2322
**示例:** 
H
HelloCrease 已提交
2323
  ```ts
H
huangjie 已提交
2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 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 2407 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 2438 2439 2440 2441 2442 2443 2444 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 2472 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 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 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 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 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 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645
  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形式返回字节数组。

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

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

**参数:** 
| 参数名      | 类型                              | 必填   | 说明                 |
| -------- | ------------------------------- | ---- | ------------------ |
| 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形式返回字节数组。

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

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

**参数:** 
| 参数名   | 类型     | 必填   | 说明    |
| ----- | ------ | ---- | ----- |
| resId | number | 是    | 资源ID值 |

**返回值:** 
| 类型                        | 说明             |
| ------------------------- | -------------- |
| 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形式返回字符串。

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

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

**参数:** 
| 参数名      | 类型                          | 必填   | 说明                       |
| -------- | --------------------------- | ---- | ------------------------ |
| 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形式返回字符串。

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

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

**参数:** 
| 参数名   | 类型     | 必填   | 说明    |
| ----- | ------ | ---- | ----- |
| resId | number | 是    | 资源ID值 |

**返回值:** 
| 类型                    | 说明                   |
| --------------------- | -------------------- |
| 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形式返回字符串。

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

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

**参数:** 
| 参数名   | 类型     | 必填   | 说明    |
| ----- | ------ | ---- | ----- |
| resId | number | 是    | 资源ID值 |
| num   | number | 是    | 数量值   |

**返回值:** 
| 类型                    | 说明                        |
| --------------------- | ------------------------- |
| 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形式返回字符串。

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

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

**参数:** 
| 参数名      | 类型                          | 必填   | 说明                              |
| -------- | --------------------------- | ---- | ------------------------------- |
| 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

**参数:** 
| 参数名      | 类型                              | 必填   | 说明                      |
| -------- | ------------------------------- | ---- | ----------------------- |
| 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

**参数:** 
| 参数名  | 类型     | 必填   | 说明          |
| ---- | ------ | ---- | ----------- |
| path | string | 是    | rawfile文件路径 |

**返回值:** 
| 类型                        | 说明          |
| ------------------------- | ----------- |
| 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

**参数:** 
| 参数名      | 类型                                       | 必填   | 说明                               |
| -------- | ---------------------------------------- | ---- | -------------------------------- |
| 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

**参数:** 
| 参数名  | 类型     | 必填   | 说明          |
| ---- | ------ | ---- | ----------- |
| path | string | 是    | rawfile文件路径 |

**返回值:** 
| 类型                                       | 说明                  |
| ---------------------------------------- | ------------------- |
| 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 已提交
2646
  ```