js-apis-resource-manager.md 100.8 KB
Newer Older
Z
zengyawen 已提交
1
# @ohos.resourceManager (资源管理)
Z
zengyawen 已提交
2

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

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

Z
zengyawen 已提交
9 10

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

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

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

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

H
HelloCrease 已提交
21
```ts
22 23 24
import UIAbility from '@ohos.app.ability.UIAbility';

export default class EntryAbility extends UIAbility {
F
fangyunzhong 已提交
25 26 27 28 29
    onWindowStageCreate(windowStage) {
        let context = this.context;
        let resourceManager = context.resourceManager;
    }
}
H
huangjie 已提交
30 31
```

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

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

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

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

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

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

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

H
HelloCrease 已提交
48
**示例:** 
H
HelloCrease 已提交
49
  ```js
Z
zengyawen 已提交
50 51
  resourceManager.getResourceManager((error, mgr) => {
      if (error != null) {
W
wplan1 已提交
52
          console.log("error is " + error);
Z
zengyawen 已提交
53 54 55 56
          return; 
      }
      mgr.getString(0x1000000, (error, value) => {
          if (error != null) {
W
wplan1 已提交
57
              console.log("error is " + error);
Z
zengyawen 已提交
58
          } else {
W
wplan1 已提交
59
              let str = value;
Z
zengyawen 已提交
60 61 62 63
          }
      });
  });
  ```
H
huangjie 已提交
64
注:示例代码中的0x1000000表示资源对应的id, 其可在编译后的文件ResourceTable.txt中找到。
Z
zengyawen 已提交
65 66 67 68 69


## resourceManager.getResourceManager

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

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

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

V
VictoriaGuo 已提交
75 76
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
77
**参数:** 
H
huangjie 已提交
78

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

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


## resourceManager.getResourceManager

getResourceManager(): Promise<ResourceManager>
Z
zengyawen 已提交
94 95 96

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

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

V
VictoriaGuo 已提交
99 100
**系统能力**:SystemCapability.Global.ResourceManager

H
huangjie 已提交
101 102
**返回值:**

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

H
HelloCrease 已提交
107
**示例:** 
H
HelloCrease 已提交
108
  ```js
Z
zengyawen 已提交
109 110 111
  resourceManager.getResourceManager().then(mgr => {
      mgr.getString(0x1000000, (error, value) => {
          if (error != null) {
W
wplan1 已提交
112
              console.log("error is " + error);
Z
zengyawen 已提交
113
          } else {
W
wplan1 已提交
114
              let str = value;
Z
zengyawen 已提交
115 116 117
          }
      });
  }).catch(error => {
W
wplan1 已提交
118
      console.log("error is " + error);
Z
zengyawen 已提交
119 120
  });
  ```
H
huangjie 已提交
121
注:示例代码中的0x1000000表示资源对应的id, 其可在编译后的文件ResourceTable.txt中找到。
Z
zengyawen 已提交
122 123 124 125 126


## resourceManager.getResourceManager

getResourceManager(bundleName: string): Promise<ResourceManager>
Z
zengyawen 已提交
127 128 129

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

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

V
VictoriaGuo 已提交
132 133
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
134
**参数:** 
H
huangjie 已提交
135

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

H
huangjie 已提交
140 141
**返回值:**

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

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


## Direction
Z
zengyawen 已提交
155 156 157

用于表示设备屏幕方向。

H
HelloCrease 已提交
158
**系统能力**:SystemCapability.Global.ResourceManager
H
HelloCrease 已提交
159

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


## DeviceType
Z
zengyawen 已提交
167 168 169

用于表示当前设备类型。

H
HelloCrease 已提交
170
**系统能力**:SystemCapability.Global.ResourceManager
H
HelloCrease 已提交
171

H
huangjie 已提交
172
| 名称                   | 值  | 说明   |
H
HelloCrease 已提交
173 174 175 176 177 178 179
| -------------------- | ---- | ---- |
| 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 已提交
180 181 182


## ScreenDensity
Z
zengyawen 已提交
183 184 185

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

H
HelloCrease 已提交
186
**系统能力**:SystemCapability.Global.ResourceManager
H
HelloCrease 已提交
187

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


## Configuration
Z
zengyawen 已提交
199 200 201

表示当前设备的状态。

H
HelloCrease 已提交
202
**系统能力**:SystemCapability.Global.ResourceManager
H
HelloCrease 已提交
203

H
huangjie 已提交
204
**参数:** 
Z
zengyawen 已提交
205

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

211 212
**示例:**

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

## DeviceCapability
Z
zengyawen 已提交
223 224 225

表示设备支持的能力。

H
HelloCrease 已提交
226
**系统能力**:SystemCapability.Global.ResourceManager
H
HelloCrease 已提交
227

H
huangjie 已提交
228
**参数:**
Z
zengyawen 已提交
229

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

235 236
**示例:**

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

W
wplan1 已提交
246 247
## RawFileDescriptor<sup>8+</sup>

H
HelloCrease 已提交
248 249 250
表示rawfile的descriptor信息。

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

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

| 名称     | 类型    | 可读   | 可写  | 说明           |
| ------ | ------  | ---- | ---- | ------------------ |
H
huangjie 已提交
256
| fd     | number  | 是    | 否 | rawfile所在hap的文件描述符 |
H
huangjie 已提交
257 258
| offset | number  | 是    | 否 | rawfile的起始偏移量      |
| length | number  | 是    | 否 | rawfile的文件长度       |
W
wplan1 已提交
259

260
## Resource<sup>9+</sup>
261 262 263 264 265

表示的资源信息。

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

H
huangjie 已提交
266 267 268 269 270 271 272
**参数:**

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

W
wplan1 已提交
274

Z
zengyawen 已提交
275
## ResourceManager
Z
zengyawen 已提交
276 277 278

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

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

H
huangjie 已提交
285
### getStringValue<sup>9+</sup>
Z
zengyawen 已提交
286

H
huangjie 已提交
287
getStringValue(resId: number, callback: AsyncCallback&lt;string&gt;): void
Z
zengyawen 已提交
288 289 290

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

V
VictoriaGuo 已提交
291 292
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
293
**参数:** 
H
huangjie 已提交
294

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

H
huangjie 已提交
300 301 302 303 304 305
**错误码:**

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

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

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


H
huangjie 已提交
326
### getStringValue<sup>9+</sup>
Z
zengyawen 已提交
327

H
huangjie 已提交
328
getStringValue(resId: number): Promise&lt;string&gt;
Z
zengyawen 已提交
329 330 331

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

V
VictoriaGuo 已提交
332 333
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
334
**参数:** 
H
huangjie 已提交
335

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

H
huangjie 已提交
340 341
**返回值:**

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

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

H
huangjie 已提交
348 349
**错误码:**

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

H
HelloCrease 已提交
356
**示例:** 
H
HelloCrease 已提交
357
  ```ts
H
huangjie 已提交
358 359 360 361 362 363 364 365 366
  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 已提交
367 368 369
  ```


H
huangjie 已提交
370
### getStringValue<sup>9+</sup>
371

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

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

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

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

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

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

H
huangjie 已提交
387 388
**错误码:**

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

395
**示例:** 
H
HelloCrease 已提交
396
  ```ts
397 398 399 400 401
  let resource = {
      bundleName: "com.example.myapplication",
      moduleName: "entry",
      id: $r('app.string.test').id
  };
H
huangjie 已提交
402
  try {
H
huangjie 已提交
403 404 405 406 407 408 409 410 411 412 413
    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}.`)
  }
  
414 415 416
  ```


H
huangjie 已提交
417 418 419
### getStringValue<sup>9+</sup>

getStringValue(resource: Resource): Promise&lt;string&gt;
420 421 422 423 424

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

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

H
huangjie 已提交
425 426
**参数:**

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

H
huangjie 已提交
431
**返回值:**
H
huangjie 已提交
432

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

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

H
huangjie 已提交
439 440
**错误码:**

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

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

Z
zengyawen 已提交
465

H
huangjie 已提交
466 467 468
### getStringArrayValue<sup>9+</sup>

getStringArrayValue(resId: number, callback: AsyncCallback&lt;Array&lt;string&gt;&gt;): void
Z
zengyawen 已提交
469 470 471

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

V
VictoriaGuo 已提交
472 473
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
474
**参数:** 
H
huangjie 已提交
475

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

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

H
huangjie 已提交
483 484
**错误码:**

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

H
HelloCrease 已提交
491
**示例:** 
H
HelloCrease 已提交
492
  ```ts
H
huangjie 已提交
493 494 495 496 497 498 499 500 501 502 503
  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 已提交
504 505 506
  ```


H
huangjie 已提交
507
### getStringArrayValue<sup>9+</sup>
Z
zengyawen 已提交
508

H
huangjie 已提交
509
getStringArrayValue(resId: number): Promise&lt;Array&lt;string&gt;&gt;
Z
zengyawen 已提交
510 511 512

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

V
VictoriaGuo 已提交
513 514
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
515
**参数:** 
H
huangjie 已提交
516

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

H
huangjie 已提交
521 522
**返回值:**

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

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

H
huangjie 已提交
529 530
**错误码:**

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

H
HelloCrease 已提交
537
**示例:** 
H
HelloCrease 已提交
538
  ```ts
H
huangjie 已提交
539 540 541 542 543 544 545 546 547
  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 已提交
548 549
  ```

H
huangjie 已提交
550
### getStringArrayValue<sup>9+</sup>
551

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

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

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

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

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

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

H
huangjie 已提交
567 568
**错误码:**

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

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

H
huangjie 已提交
595
### getStringArrayValue<sup>9+</sup>
596

H
huangjie 已提交
597
getStringArrayValue(resource: Resource): Promise&lt;Array&lt;string&gt;&gt;
598 599 600 601 602 603

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

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

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

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

H
huangjie 已提交
609 610
**返回值:**

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

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

H
huangjie 已提交
617 618
**错误码:**

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

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


H
huangjie 已提交
644
### getMediaContent<sup>9+</sup>
H
huangjie 已提交
645 646

getMediaContent(resId: number, callback: AsyncCallback&lt;Uint8Array&gt;): void
Z
zengyawen 已提交
647 648 649

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

V
VictoriaGuo 已提交
650 651
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
652
**参数:** 
H
huangjie 已提交
653

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

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

H
huangjie 已提交
661 662
**错误码:**

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

H
HelloCrease 已提交
668
**示例:** 
H
HelloCrease 已提交
669
  ```ts
H
huangjie 已提交
670 671 672 673 674 675 676 677 678 679 680
  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 已提交
681 682 683
  ```


H
huangjie 已提交
684
### getMediaContent<sup>9+</sup>
Z
zengyawen 已提交
685

H
huangjie 已提交
686
getMediaContent(resId: number): Promise&lt;Uint8Array&gt;
Z
zengyawen 已提交
687 688 689

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

V
VictoriaGuo 已提交
690 691
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
692
**参数:** 
H
huangjie 已提交
693

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

H
huangjie 已提交
698 699
**返回值:**

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

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

H
huangjie 已提交
706 707
**错误码:**

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

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

H
huangjie 已提交
726
### getMediaContent<sup>9+</sup>
727

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

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

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

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

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

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

H
huangjie 已提交
743 744
**错误码:**

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

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

H
huangjie 已提交
770
### getMediaContent<sup>9+</sup>
771

H
huangjie 已提交
772
getMediaContent(resource: Resource): Promise&lt;Uint8Array&gt;
773 774 775 776 777 778

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

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

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

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

H
huangjie 已提交
784 785
**返回值:**

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

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

H
huangjie 已提交
792 793
**错误码:**

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

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


H
huangjie 已提交
818
### getMediaContentBase64<sup>9+</sup>
H
huangjie 已提交
819 820

getMediaContentBase64(resId: number, callback: AsyncCallback&lt;string&gt;): void
Z
zengyawen 已提交
821 822 823

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

V
VictoriaGuo 已提交
824 825
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
826
**参数:** 
H
huangjie 已提交
827

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

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

H
huangjie 已提交
835 836
**错误码:**

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

H
HelloCrease 已提交
842
**示例:** 
H
HelloCrease 已提交
843
  ```ts
H
huangjie 已提交
844
  try {
H
huangjie 已提交
845
    this.context.resourceManager.getMediaContentBase64($r('app.media.test').id, (error, value) => {
H
huangjie 已提交
846 847 848 849 850 851 852 853 854
        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 已提交
855 856 857
  ```


H
huangjie 已提交
858
### getMediaContentBase64<sup>9+</sup>
Z
zengyawen 已提交
859

H
huangjie 已提交
860
getMediaContentBase64(resId: number): Promise&lt;string&gt;
Z
zengyawen 已提交
861 862 863

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

V
VictoriaGuo 已提交
864 865
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
866
**参数:** 
H
huangjie 已提交
867

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

H
huangjie 已提交
872 873
**返回值:**

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

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

H
huangjie 已提交
880 881
**错误码:**

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

H
HelloCrease 已提交
887
**示例:** 
H
HelloCrease 已提交
888
  ```ts
H
huangjie 已提交
889
  try {
H
huangjie 已提交
890
    this.context.resourceManager.getMediaContentBase64($r('app.media.test').id).then(value => {
H
huangjie 已提交
891 892 893 894 895 896 897
        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 已提交
898 899
  ```

H
huangjie 已提交
900
### getMediaContentBase64<sup>9+</sup>
901

H
huangjie 已提交
902
getMediaContentBase64(resource: Resource, callback: AsyncCallback&lt;string&gt;): void
903 904 905 906 907

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

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

H
huangjie 已提交
908 909
**参数:**

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

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

H
huangjie 已提交
917 918
**错误码:**

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

924
**示例:** 
H
HelloCrease 已提交
925
  ```ts
926 927 928 929 930
  let resource = {
      bundleName: "com.example.myapplication",
      moduleName: "entry",
      id: $r('app.media.test').id
  };
H
huangjie 已提交
931 932 933 934 935 936 937 938 939 940 941
  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}.`)
  }
942 943
  ```

H
huangjie 已提交
944
### getMediaContentBase64<sup>9+</sup>
945

H
huangjie 已提交
946
getMediaContentBase64(resource: Resource): Promise&lt;string&gt;
947 948 949 950 951 952

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

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

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

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

H
huangjie 已提交
958 959
**返回值:**

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

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

H
huangjie 已提交
966 967
**错误码:**

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

973
**示例:** 
H
HelloCrease 已提交
974
  ```ts
975 976 977 978 979
  let resource = {
      bundleName: "com.example.myapplication",
      moduleName: "entry",
      id: $r('app.media.test').id
  };
H
huangjie 已提交
980 981 982 983 984 985 986 987 988
  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}.`)
  }
989 990
  ```

Z
zengyawen 已提交
991 992 993 994

### getConfiguration

getConfiguration(callback: AsyncCallback&lt;Configuration&gt;): void
Z
zengyawen 已提交
995 996 997

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

V
VictoriaGuo 已提交
998 999
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
1000
**参数:** 
H
huangjie 已提交
1001

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

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


Z
zengyawen 已提交
1021
### getConfiguration
Z
zengyawen 已提交
1022

Z
zengyawen 已提交
1023 1024 1025
getConfiguration(): Promise&lt;Configuration&gt;

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

V
VictoriaGuo 已提交
1027 1028
**系统能力**:SystemCapability.Global.ResourceManager

H
huangjie 已提交
1029 1030
**返回值:**

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

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


Z
zengyawen 已提交
1048 1049 1050
### getDeviceCapability

getDeviceCapability(callback: AsyncCallback&lt;DeviceCapability&gt;): void
Z
zengyawen 已提交
1051 1052 1053

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

V
VictoriaGuo 已提交
1054 1055
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
1056
**参数:** 
H
huangjie 已提交
1057

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

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


Z
zengyawen 已提交
1077
### getDeviceCapability
Z
zengyawen 已提交
1078

Z
zengyawen 已提交
1079 1080 1081
getDeviceCapability(): Promise&lt;DeviceCapability&gt;

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

V
VictoriaGuo 已提交
1083 1084
**系统能力**:SystemCapability.Global.ResourceManager

H
huangjie 已提交
1085 1086
**返回值:**

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

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


H
huangjie 已提交
1104
### getPluralStringValue<sup>9+</sup>
Z
zengyawen 已提交
1105

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

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

V
VictoriaGuo 已提交
1110 1111
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
1112
**参数:** 
H
huangjie 已提交
1113

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

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

H
huangjie 已提交
1122 1123
**错误码:**

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

H
HelloCrease 已提交
1130
**示例:** 
H
HelloCrease 已提交
1131
  ```ts
H
huangjie 已提交
1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142
  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 已提交
1143
  ```
Z
zengyawen 已提交
1144 1145


H
huangjie 已提交
1146
### getPluralStringValue<sup>9+</sup>
Z
zengyawen 已提交
1147

H
huangjie 已提交
1148
getPluralStringValue(resId: number, num: number): Promise&lt;string&gt;
Z
zengyawen 已提交
1149 1150

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

V
VictoriaGuo 已提交
1152 1153
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
1154
**参数:** 
H
huangjie 已提交
1155

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

H
huangjie 已提交
1161 1162
**返回值:**

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

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

H
huangjie 已提交
1169 1170
**错误码:**

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

H
HelloCrease 已提交
1177
**示例:** 
H
HelloCrease 已提交
1178
  ```ts
H
huangjie 已提交
1179 1180 1181 1182 1183 1184 1185 1186 1187
  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 已提交
1188
  ```
Z
zengyawen 已提交
1189

H
huangjie 已提交
1190
### getPluralStringValue<sup>9+</sup>
1191

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

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

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

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

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

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

H
huangjie 已提交
1208 1209
**错误码:**

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

1216
**示例:** 
H
HelloCrease 已提交
1217
  ```ts
1218 1219 1220 1221 1222
  let resource = {
      bundleName: "com.example.myapplication",
      moduleName: "entry",
      id: $r('app.plural.test').id
  };
H
huangjie 已提交
1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234
  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}.`)
  }  
  
1235 1236
  ```

H
huangjie 已提交
1237
### getPluralStringValue<sup>9+</sup>
1238

H
huangjie 已提交
1239
getPluralStringValue(resource: Resource, num: number): Promise&lt;string&gt;
1240 1241 1242 1243 1244 1245

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

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

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

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

H
huangjie 已提交
1252 1253
**返回值:**

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

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

H
huangjie 已提交
1260 1261
**错误码:**

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

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

Z
zengyawen 已提交
1286

H
huangjie 已提交
1287 1288 1289
### getRawFileContent<sup>9+</sup>

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

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

V
VictoriaGuo 已提交
1293 1294
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
1295
**参数:** 
H
huangjie 已提交
1296

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

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

H
huangjie 已提交
1304 1305
**错误码:**

H
huangjie 已提交
1306 1307
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
1308
| 9001005  | If the resource not found by path.          |
H
huangjie 已提交
1309

H
HelloCrease 已提交
1310
**示例:** 
H
HelloCrease 已提交
1311
  ```ts
H
huangjie 已提交
1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323
  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 已提交
1324 1325
  ```

H
huangjie 已提交
1326
### getRawFileContent<sup>9+</sup>
Z
zengyawen 已提交
1327

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

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

V
VictoriaGuo 已提交
1332 1333
**系统能力**:SystemCapability.Global.ResourceManager

H
HelloCrease 已提交
1334
**参数:** 
H
huangjie 已提交
1335

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

H
huangjie 已提交
1340 1341
**返回值:**

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

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

H
huangjie 已提交
1348 1349
**错误码:**

H
huangjie 已提交
1350 1351
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
1352
| 9001005  | If the resource not found by path.          |
H
huangjie 已提交
1353

H
HelloCrease 已提交
1354
**示例:** 
H
HelloCrease 已提交
1355
  ```ts
H
huangjie 已提交
1356 1357 1358 1359 1360 1361 1362 1363 1364
  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 已提交
1365
  ```
W
wplan1 已提交
1366 1367


H
huangjie 已提交
1368 1369 1370
### getRawFd<sup>9+</sup>

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

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

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

H
HelloCrease 已提交
1376
**参数:** 
H
huangjie 已提交
1377

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

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

H
huangjie 已提交
1385 1386
**错误码:**

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

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

H
huangjie 已提交
1408
### getRawFd<sup>9+</sup>
W
wplan1 已提交
1409

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

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

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

H
HelloCrease 已提交
1416
**参数:** 
H
huangjie 已提交
1417

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

H
huangjie 已提交
1422 1423
**返回值:**

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

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

H
huangjie 已提交
1430 1431
**错误码:**

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

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

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

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

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

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

H
HelloCrease 已提交
1459
**参数:** 
H
huangjie 已提交
1460

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

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

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

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

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

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

H
HelloCrease 已提交
1485
**参数:** 
H
huangjie 已提交
1486

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

H
huangjie 已提交
1491 1492
**返回值:**

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

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


H
huangjie 已提交
1509
### closeRawFd<sup>9+</sup>
W
wplan1 已提交
1510

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

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

H
huangjie 已提交
1515
**系统能力**:SystemCapability.Global.ResourceManager
H
huangjie 已提交
1516

H
huangjie 已提交
1517
**参数:** 
H
huangjie 已提交
1518

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

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

H
huangjie 已提交
1526 1527
**错误码:**

H
huangjie 已提交
1528 1529 1530
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 9001005  | The resource not found by path.          |
H
huangjie 已提交
1531

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

H
huangjie 已提交
1546
### closeRawFd<sup>9+</sup>
H
huangjie 已提交
1547

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

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

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

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

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

H
huangjie 已提交
1560 1561
**返回值:**

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

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

H
huangjie 已提交
1568 1569
**错误码:**

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

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

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

release()

用户释放创建的resourceManager。

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

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

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

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

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

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

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

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

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

H
huangjie 已提交
1619 1620
**错误码:**

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

**示例:**
  ```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 已提交
1648 1649 1650 1651

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

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

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

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

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

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

H
huangjie 已提交
1665 1666
**错误码:**

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

H
huangjie 已提交
1673
**示例:**
H
HelloCrease 已提交
1674
  ```ts
H
huangjie 已提交
1675 1676 1677 1678 1679 1680 1681 1682 1683
  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 已提交
1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694
  ```

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

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

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

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

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

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

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

H
huangjie 已提交
1703 1704
**错误码:**

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

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

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

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

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

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

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

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

H
huangjie 已提交
1740 1741
**返回值:**

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

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

H
huangjie 已提交
1748 1749
**错误码:**

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

H
huangjie 已提交
1756
**示例:** 
H
HelloCrease 已提交
1757
  ```ts
H
huangjie 已提交
1758 1759 1760 1761 1762 1763 1764 1765 1766
  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 已提交
1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777
  ```

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

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

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

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

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

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

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

H
huangjie 已提交
1786 1787
**错误码:**

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

H
huangjie 已提交
1794
**示例:** 
H
HelloCrease 已提交
1795
  ```ts
H
huangjie 已提交
1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806
  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 已提交
1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817
  ```

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

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

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

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

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

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

H
huangjie 已提交
1823 1824
**返回值:**

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

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

H
huangjie 已提交
1831 1832
**错误码:**

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

H
huangjie 已提交
1839
**示例:** 
H
HelloCrease 已提交
1840
  ```ts
H
huangjie 已提交
1841 1842 1843 1844 1845 1846 1847 1848 1849
  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 已提交
1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860
  ```

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

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

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

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

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

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

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

H
huangjie 已提交
1869 1870
**错误码:**

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

H
huangjie 已提交
1877
**示例:** 
H
HelloCrease 已提交
1878
  ```ts
H
huangjie 已提交
1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889
  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 已提交
1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900
  ```

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

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

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

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

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

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

H
huangjie 已提交
1906 1907
**返回值:**

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

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

H
huangjie 已提交
1914 1915
**错误码:**

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

H
huangjie 已提交
1922
**示例:** 
H
HelloCrease 已提交
1923
  ```ts
H
huangjie 已提交
1924 1925 1926 1927 1928 1929 1930 1931 1932
  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 已提交
1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943
  ```

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

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

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

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

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

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

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

H
huangjie 已提交
1953 1954
**错误码:**

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

H
huangjie 已提交
1961
**示例:** 
H
HelloCrease 已提交
1962
  ```ts
H
huangjie 已提交
1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974
  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 已提交
1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985
  ```

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

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

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

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

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

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

H
huangjie 已提交
1992 1993
**返回值:**

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

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

H
huangjie 已提交
2000 2001
**错误码:**

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

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

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

getStringSync(resId: number): string

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

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

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

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

H
huangjie 已提交
2035 2036
**返回值:**

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

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

**错误码:**

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

H
huangjie 已提交
2051
**示例:** 
H
HelloCrease 已提交
2052
  ```ts
H
huangjie 已提交
2053 2054 2055 2056 2057
  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 已提交
2058 2059
  ```

Z
zt147369 已提交
2060 2061
### getStringSync<sup>10+</sup>

Z
zt147369 已提交
2062
getStringSync(resId: number, ...args: Array<string | number>): string
Z
zt147369 已提交
2063

Z
zt147369 已提交
2064
用户获取指定资源ID对应的字符串,根据args参数进行格式化,使用同步方式返回相应字符串。
Z
zt147369 已提交
2065 2066 2067 2068 2069 2070 2071 2072

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

**参数:** 

| 参数名   | 类型     | 必填   | 说明    |
| ----- | ------ | ---- | ----- |
| resId | number | 是    | 资源ID值 |
Z
zt147369 已提交
2073
| args | Array<string \| number> | 否    | 格式化字符串资源参数 <br> 支持参数类型:<br /> -%d、%f、%s、%% <br> 说明:%%转译符,转译%<br>举例:%%d格式化后为%d字符串|
Z
zt147369 已提交
2074 2075 2076

**返回值:**

Z
zt147369 已提交
2077 2078 2079
| 类型     | 说明          |
| ------ | ---------------------------- |
| string | 资源ID值对应的格式化字符串|
Z
zt147369 已提交
2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100

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

**错误码:**

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

**示例:** 
  ```ts
  try {
    this.context.resourceManager.getStringSync($r('app.string.test').id, "format string", 10, 98.78);
  } catch (error) {
    console.error(`getStringSync failed, error code: ${error.code}, message: ${error.message}.`)
  }
  ```

2101 2102 2103 2104 2105 2106 2107 2108 2109
### getStringSync<sup>9+</sup>

getStringSync(resource: Resource): string

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

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

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

H
HelloCrease 已提交
2111 2112
| 参数名      | 类型                     | 必填   | 说明   |
| -------- | ---------------------- | ---- | ---- |
2113
| resource | [Resource](#resource9) | 是    | 资源信息 |
2114

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

H
HelloCrease 已提交
2117 2118
| 类型     | 说明               |
| ------ | ---------------- |
2119 2120
| string | resource对象对应的字符串 |

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

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

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

2131
**示例:** 
H
HelloCrease 已提交
2132
  ```ts
2133 2134 2135 2136 2137
  let resource = {
      bundleName: "com.example.myapplication",
      moduleName: "entry",
      id: $r('app.string.test').id
  };
H
huangjie 已提交
2138 2139 2140 2141 2142
  try {
    this.context.resourceManager.getStringSync(resource);
  } catch (error) {
    console.error(`getStringSync failed, error code: ${error.code}, message: ${error.message}.`)
  }
2143 2144
  ```

Z
zt147369 已提交
2145 2146
### getStringSync<sup>10+</sup>

Z
zt147369 已提交
2147
getStringSync(resource: Resource, ...args: Array<string | number>): string
Z
zt147369 已提交
2148

Z
zt147369 已提交
2149
用户获取指定resource对象对应的字符串,根据args参数进行格式化,使用同步方式返回相应字符串。
Z
zt147369 已提交
2150 2151 2152 2153 2154 2155 2156 2157

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

**参数:** 

| 参数名      | 类型                     | 必填   | 说明   |
| -------- | ---------------------- | ---- | ---- |
| resource | [Resource](#resource9) | 是    | 资源信息 |
Z
zt147369 已提交
2158
| args | Array<string \| number> | 否    | 格式化字符串资源参数 <br> 支持参数类型:<br /> -%d、%f、%s、%% <br> 说明:%%转译符,转译%<br>举例:%%d格式化后为%d字符串|
Z
zt147369 已提交
2159 2160 2161

**返回值:**

Z
zt147369 已提交
2162 2163 2164
| 类型     | 说明          |
| ------ | ---------------------------- |
| string | resource对象对应的格式化字符串|
Z
zt147369 已提交
2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190

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

**错误码:**

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

**示例:** 
  ```ts
  let resource = {
      bundleName: "com.example.myapplication",
      moduleName: "entry",
      id: $r('app.string.test').id
  };
  try {
    this.context.resourceManager.getStringSync(resource, "format string", 10, 98.78);
  } catch (error) {
    console.error(`getStringSync failed, error code: ${error.code}, message: ${error.message}.`)
  }
 ```

H
huangjie 已提交
2191 2192 2193 2194 2195 2196 2197 2198 2199
### getStringByNameSync<sup>9+</sup>

getStringByNameSync(resName: string): string

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

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

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

H
HelloCrease 已提交
2201 2202
| 参数名     | 类型     | 必填   | 说明   |
| ------- | ------ | ---- | ---- |
H
huangjie 已提交
2203 2204
| resName | string | 是    | 资源名称 |

H
huangjie 已提交
2205 2206
**返回值:**

H
HelloCrease 已提交
2207 2208
| 类型     | 说明         |
| ------ | ---------- |
H
huangjie 已提交
2209 2210
| string | 资源名称对应的字符串 |

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

H
huangjie 已提交
2213 2214
**错误码:**

H
huangjie 已提交
2215 2216
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
2217 2218 2219
| 9001003  | If the resName invalid.                     |
| 9001004  | If the resource not found by resName.       |
| 9001006  | If the resource re-ref too much.            |
H
huangjie 已提交
2220

H
huangjie 已提交
2221
**示例:** 
H
HelloCrease 已提交
2222
  ```ts
H
huangjie 已提交
2223 2224 2225 2226 2227
  try {
    this.context.resourceManager.getStringByNameSync("test");
  } catch (error) {
    console.error(`getStringByNameSync failed, error code: ${error.code}, message: ${error.message}.`)
  }
H
huangjie 已提交
2228 2229
  ```

Z
zt147369 已提交
2230 2231
### getStringByNameSync<sup>10+</sup>

Z
zt147369 已提交
2232
getStringByNameSync(resName: string, ...args: Array<string | number>): string
Z
zt147369 已提交
2233

Z
zt147369 已提交
2234
用户获取指定资源名称对应的字符串,根据args参数进行格式化,使用同步方式返回相应字符串。
Z
zt147369 已提交
2235 2236 2237 2238 2239 2240 2241 2242

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

**参数:** 

| 参数名     | 类型     | 必填   | 说明   |
| ------- | ------ | ---- | ---- |
| resName | string | 是    | 资源名称 |
Z
zt147369 已提交
2243
| args | Array<string \| number> | 否    | 格式化字符串资源参数 <br> 支持参数类型:<br /> -%d、%f、%s、%% <br> 说明:%%转译符,转译%<br>举例:%%d格式化后为%d字符串|
Z
zt147369 已提交
2244 2245 2246

**返回值:**

Z
zt147369 已提交
2247 2248 2249
| 类型     | 说明          |
| ------ | ---------------------------- |
| string | 资源名称对应的格式化字符串|
Z
zt147369 已提交
2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266

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

**错误码:**

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 9001003  | If the resName invalid.                     |
| 9001004  | If the resource not found by resName.       |
| 9001006  | If the resource re-ref too much.            |
| 9001008  | If the resource obtained by resName formatting error. |

**示例:** 
  ```ts
  try {
    this.context.resourceManager.getStringByNameSync("test", "format string", 10, 98.78);
  } catch (error) {
Z
zt147369 已提交
2267
    console.error(`getStringByNameSync failed, error code: ${error.code}, message: ${error.message}.`)
Z
zt147369 已提交
2268 2269 2270
  }
 ```

H
huangjie 已提交
2271
### getBoolean<sup>9+</sup>
H
huangjie 已提交
2272 2273 2274 2275 2276 2277 2278 2279

getBoolean(resId: number): boolean

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

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

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

H
huangjie 已提交
2281 2282 2283 2284
| 参数名   | 类型     | 必填   | 说明    |
| ----- | ------ | ---- | ----- |
| resId | number | 是    | 资源ID值 |

H
huangjie 已提交
2285 2286
**返回值:**

H
HelloCrease 已提交
2287 2288
| 类型      | 说明           |
| ------- | ------------ |
H
huangjie 已提交
2289 2290
| boolean | 资源ID值对应的布尔结果 |

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

H
huangjie 已提交
2293 2294
**错误码:**

H
huangjie 已提交
2295 2296
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
2297 2298 2299
| 9001001  | If the resId invalid.                       |
| 9001002  | If the resource not found by resId.         |
| 9001006  | If the resource re-ref too much.            |
H
huangjie 已提交
2300

H
huangjie 已提交
2301
**示例:** 
H
HelloCrease 已提交
2302
  ```ts
H
huangjie 已提交
2303 2304 2305 2306 2307
  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 已提交
2308
  ```
2309 2310 2311 2312 2313 2314 2315 2316 2317
### getBoolean<sup>9+</sup>

getBoolean(resource: Resource): boolean

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

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

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

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

H
huangjie 已提交
2323 2324
**返回值:**

H
HelloCrease 已提交
2325 2326
| 类型      | 说明                |
| ------- | ----------------- |
2327 2328
| boolean | resource对象对应的布尔结果 |

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

H
huangjie 已提交
2331 2332
**错误码:**

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

2339
**示例:** 
H
HelloCrease 已提交
2340
  ```ts
2341 2342 2343 2344 2345
  let resource = {
      bundleName: "com.example.myapplication",
      moduleName: "entry",
      id: $r('app.boolean.boolean_test').id
  };
H
huangjie 已提交
2346 2347 2348 2349 2350
  try {
    this.context.resourceManager.getBoolean(resource);
  } catch (error) {
    console.error(`getBoolean failed, error code: ${error.code}, message: ${error.message}.`)
  }
2351
  ```
H
huangjie 已提交
2352 2353 2354 2355 2356 2357 2358 2359 2360 2361

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

getBooleanByName(resName: string): boolean

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

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

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

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

H
huangjie 已提交
2367 2368
**返回值:**

H
HelloCrease 已提交
2369 2370
| 类型      | 说明          |
| ------- | ----------- |
H
huangjie 已提交
2371 2372
| boolean | 资源名称对应的布尔结果 |

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

H
huangjie 已提交
2375 2376
**错误码:**

H
huangjie 已提交
2377 2378
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
2379 2380 2381
| 9001003  | If the resName invalid.                     |
| 9001004  | If the resource not found by resName.       |
| 9001006  | If the resource re-ref too much.            |
H
huangjie 已提交
2382

H
huangjie 已提交
2383
**示例:** 
H
HelloCrease 已提交
2384
  ```ts
H
huangjie 已提交
2385 2386 2387 2388 2389
  try {
    this.context.resourceManager.getBooleanByName("boolean_test");
  } catch (error) {
    console.error(`getBooleanByName failed, error code: ${error.code}, message: ${error.message}.`)
  }
H
huangjie 已提交
2390 2391
  ```

H
huangjie 已提交
2392
### getNumber<sup>9+</sup>
H
huangjie 已提交
2393 2394 2395 2396 2397 2398 2399 2400

getNumber(resId: number): number

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

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

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

H
huangjie 已提交
2402 2403 2404 2405
| 参数名   | 类型     | 必填   | 说明    |
| ----- | ------ | ---- | ----- |
| resId | number | 是    | 资源ID值 |

H
huangjie 已提交
2406 2407
**返回值:**

H
HelloCrease 已提交
2408
| 类型     | 说明         |
H
huangjie 已提交
2409
| ------ | ---------- | 
H
huangjie 已提交
2410
| number | 资源ID值对应的数值。Integer对应的是原数值,float对应的是真实像素点值,具体参考示例代码 |
H
huangjie 已提交
2411

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

H
huangjie 已提交
2414 2415
**错误码:**

H
huangjie 已提交
2416 2417
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
2418 2419 2420
| 9001001  | If the resId invalid.                       |
| 9001002  | If the resource not found by resId.         |
| 9001006  | If the resource re-ref too much.            |
H
huangjie 已提交
2421

H
huangjie 已提交
2422
**示例:** 
H
HelloCrease 已提交
2423
  ```ts
H
huangjie 已提交
2424
  try {
H
huangjie 已提交
2425
    this.context.resourceManager.getNumber($r('app.integer.integer_test').id); // integer对应返回的是原数值
H
huangjie 已提交
2426 2427 2428 2429 2430
  } catch (error) {
    console.error(`getNumber failed, error code: ${error.code}, message: ${error.message}.`)
  }

  try {
H
huangjie 已提交
2431
    this.context.resourceManager.getNumber($r('app.float.float_test').id); // float对应返回的是真实像素点值
H
huangjie 已提交
2432 2433 2434
  } catch (error) {
    console.error(`getNumber failed, error code: ${error.code}, message: ${error.message}.`)
  }
H
huangjie 已提交
2435 2436
  ```

2437 2438 2439 2440 2441 2442 2443 2444 2445
### getNumber<sup>9+</sup>

getNumber(resource: Resource): number

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

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

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

H
HelloCrease 已提交
2447 2448
| 参数名      | 类型                     | 必填   | 说明   |
| -------- | ---------------------- | ---- | ---- |
2449
| resource | [Resource](#resource9) | 是    | 资源信息 |
2450

H
huangjie 已提交
2451 2452
**返回值:**

H
HelloCrease 已提交
2453 2454
| 类型     | 说明              |
| ------ | --------------- |
H
huangjie 已提交
2455
| number | resource对象对应的数值。Integer对应的是原数值,float对应的是真实像素点值, 具体参考示例代码 |
2456

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

H
huangjie 已提交
2459 2460
**错误码:**

H
huangjie 已提交
2461 2462
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
2463 2464 2465
| 9001001  | If the resId invalid.                       |
| 9001002  | If the resource not found by resId.         |
| 9001006  | If the resource re-ref too much.            |
H
huangjie 已提交
2466

2467
**示例:** 
H
HelloCrease 已提交
2468
  ```ts
2469 2470 2471 2472 2473
  let resource = {
      bundleName: "com.example.myapplication",
      moduleName: "entry",
      id: $r('app.integer.integer_test').id
  };
H
huangjie 已提交
2474
  try {
H
huangjie 已提交
2475
    this.context.resourceManager.getNumber(resource);// integer对应返回的是原数值, float对应返回的是真实像素点值
H
huangjie 已提交
2476 2477 2478
  } catch (error) {
    console.error(`getNumber failed, error code: ${error.code}, message: ${error.message}.`)
  }
2479 2480
  ```

H
huangjie 已提交
2481 2482 2483 2484 2485 2486 2487 2488 2489
### getNumberByName<sup>9+</sup>

getNumberByName(resName: string): number

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

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

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

H
HelloCrease 已提交
2491 2492
| 参数名     | 类型     | 必填   | 说明   |
| ------- | ------ | ---- | ---- |
H
huangjie 已提交
2493 2494
| resName | string | 是    | 资源名称 |

H
huangjie 已提交
2495 2496
**返回值:**

H
HelloCrease 已提交
2497 2498
| 类型     | 说明        |
| ------ | --------- |
H
huangjie 已提交
2499 2500
| number | 资源名称对应的数值 |

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

H
huangjie 已提交
2503 2504
**错误码:**

H
huangjie 已提交
2505 2506
| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
H
huangjie 已提交
2507 2508 2509
| 9001003  | If the resName invalid.                     |
| 9001004  | If the resource not found by resName.       |
| 9001006  | If the resource re-ref too much.            |
H
huangjie 已提交
2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525

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

H
huangjie 已提交
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 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661
### getDrawableDescriptor<sup>10+</sup>

getDrawableDescriptor(resId: number, density?: number): DrawableDescriptor;

用户获取指定资源ID对应的DrawableDescriptor对象,使用同步方式返回资源对应的DrawableDescriptor,用于图标的显示。

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

**参数:**

| 参数名   | 类型     | 必填   | 说明    |
| ----- | ------ | ---- | ----- |
| resId | number | 是    | 资源ID值 |
| [density](#screendensity) | number | 否    | 资源获取需要的屏幕密度,默认为0 |

**返回值:**

| 类型     | 说明         |
| ------ | ---------- |
| DrawableDescriptor | 资源ID值对应的DrawableDescriptor对象 |

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

**错误码:**

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

**示例:**
  ```ts
  try {
    this.context.resourceManager.getDrawableDescriptor($r('app.media.icon').id);
  } catch (error) {
    console.error(`getDrawableDescriptor failed, error code: ${error.code}, message: ${error.message}.`)
  }
  try {
    this.context.resourceManager.getDrawableDescriptor($r('app.media.icon').id, 120);
  } catch (error) {
    console.error(`getDrawableDescriptor failed, error code: ${error.code}, message: ${error.message}.`)
  }
  ```

### getDrawableDescriptor<sup>10+</sup>

getDrawableDescriptor(resource: Resource, density?: number): DrawableDescriptor;

用户获取指定resource对应的DrawableDescriptor对象,使用同步方式返回资源对应的DrawableDescriptor,用于图标的显示。

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

**参数:**

| 参数名      | 类型                     | 必填   | 说明   |
| -------- | ---------------------- | ---- | ---- |
| resource | [Resource](#resource9) | 是    | 资源信息 |
| [density](#screendensity) | number | 否    | 资源获取需要的屏幕密度,默认为0 |

**返回值:**

| 类型      | 说明                |
| ------- | ----------------- |
| DrawableDescriptor | 资源ID值对应的DrawableDescriptor对象 |

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

**错误码:**

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

**示例:**
  ```ts
  let resource = {
      bundleName: "com.example.myapplication",
      moduleName: "entry",
      id: $r('app.media.icon').id
  };
  try {
    this.context.resourceManager.getDrawableDescriptor(resource);
  } catch (error) {
    console.error(`getDrawableDescriptor failed, error code: ${error.code}, message: ${error.message}.`)
  }
  try {
    this.context.resourceManager.getDrawableDescriptor(resource, 120);
  } catch (error) {
    console.error(`getDrawableDescriptor failed, error code: ${error.code}, message: ${error.message}.`)
  }
  ```

### getDrawableDescriptorByName<sup>10+</sup>

getDrawableDescriptorByName(resName: string, density?: number): DrawableDescriptor;

用户获取指定资源名称对应的DrawableDescriptor对象,使用同步方式返回资源对应的DrawableDescriptor,用于图标的显示。

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

**参数:**

| 参数名     | 类型     | 必填   | 说明   |
| ------- | ------ | ---- | ---- |
| resName | string | 是    | 资源名称 |
| [density](#screendensity) | number | 否    | 资源获取需要的屏幕密度,默认为0 |

**返回值:**

| 类型     | 说明        |
| ------ | --------- |
| DrawableDescriptor | 资源ID值对应的DrawableDescriptor对象 |

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

**错误码:**

| 错误码ID | 错误信息 |
| -------- | ---------------------------------------- |
| 9001003  | If the resName invalid.                     |
| 9001004  | If the resource not found by resName.       |

**示例:**
  ```ts
  try {
    this.context.resourceManager.getDrawableDescriptorByName('icon');
  } catch (error) {
    console.error(`getDrawableDescriptor failed, error code: ${error.code}, message: ${error.message}.`)
  }
  try {
    this.context.resourceManager.getDrawableDescriptorByName('icon', 120);
  } catch (error) {
    console.error(`getDrawableDescriptor failed, error code: ${error.code}, message: ${error.message}.`)
  }
  ```
H
huangjie 已提交
2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673

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

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

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

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

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

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

H
huangjie 已提交
2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704
| 参数名      | 类型                          | 必填   | 说明              |
| -------- | --------------------------- | ---- | --------------- |
| resId    | number                      | 是    | 资源ID值           |
| callback | AsyncCallback&lt;string&gt; | 是    | 异步回调,用于返回获取的字符串 |

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


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

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

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

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

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

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

H
huangjie 已提交
2706 2707 2708 2709
| 参数名   | 类型     | 必填   | 说明    |
| ----- | ------ | ---- | ----- |
| resId | number | 是    | 资源ID值 |

H
huangjie 已提交
2710 2711
**返回值:**

H
huangjie 已提交
2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738
| 类型                    | 说明          |
| --------------------- | ----------- |
| Promise&lt;string&gt; | 资源ID值对应的字符串 |

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


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

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

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

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

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

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

H
huangjie 已提交
2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769
| 参数名      | 类型                                       | 必填   | 说明                |
| -------- | ---------------------------------------- | ---- | ----------------- |
| resId    | number                                   | 是    | 资源ID值             |
| callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是    | 异步回调,用于返回获取的字符串数组 |

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


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

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

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

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

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

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

H
huangjie 已提交
2771 2772 2773 2774
| 参数名   | 类型     | 必填   | 说明    |
| ----- | ------ | ---- | ----- |
| resId | number | 是    | 资源ID值 |

H
huangjie 已提交
2775 2776
**返回值:**

H
huangjie 已提交
2777 2778 2779 2780
| 类型                                 | 说明            |
| ---------------------------------- | ------------- |
| Promise&lt;Array&lt;string&gt;&gt; | 资源ID值对应的字符串数组 |

H
huangjie 已提交
2781
**示例:** 
H
HelloCrease 已提交
2782
  ```ts
H
huangjie 已提交
2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798
  resourceManager.getResourceManager((error, mgr) => {
       mgr.getStringArray($r('app.strarray.test').id).then(value => {
          let strArray = value;
      }).catch(error => {
          console.log("getStringArray promise error is " + error);
      });
  });
  ```


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

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

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

H
huangjie 已提交
2799
从API version 9开始不再维护,建议使用[getMediaContent](#getmediacontent9)代替。
H
huangjie 已提交
2800 2801 2802 2803

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

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

H
huangjie 已提交
2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829
| 参数名      | 类型                              | 必填   | 说明                 |
| -------- | ------------------------------- | ---- | ------------------ |
| resId    | number                          | 是    | 资源ID值              |
| callback | AsyncCallback&lt;Uint8Array&gt; | 是    | 异步回调,用于返回获取的媒体文件内容 |

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


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

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

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

H
huangjie 已提交
2830
从API version 9开始不再维护,建议使用[getMediaContent](#getmediacontent9-1)代替。
H
huangjie 已提交
2831 2832 2833 2834

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

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

H
huangjie 已提交
2836 2837 2838 2839
| 参数名   | 类型     | 必填   | 说明    |
| ----- | ------ | ---- | ----- |
| resId | number | 是    | 资源ID值 |

H
huangjie 已提交
2840 2841
**返回值:**

H
huangjie 已提交
2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863
| 类型                        | 说明             |
| ------------------------- | -------------- |
| Promise&lt;Uint8Array&gt; | 资源ID值对应的媒体文件内容 |

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


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

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

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

H
huangjie 已提交
2864
从API version 9开始不再维护,建议使用[getMediaContentBase64](#getmediacontentbase649)代替。
H
huangjie 已提交
2865 2866 2867 2868

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

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

H
huangjie 已提交
2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894
| 参数名      | 类型                          | 必填   | 说明                       |
| -------- | --------------------------- | ---- | ------------------------ |
| resId    | number                      | 是    | 资源ID值                    |
| callback | AsyncCallback&lt;string&gt; | 是    | 异步回调,用于返回获取的图片资源Base64编码 |

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


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

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

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

H
huangjie 已提交
2895
从API version 9开始不再维护,建议使用[getMediaContentBase64](#getmediacontentbase649-1)代替。
H
huangjie 已提交
2896 2897 2898 2899

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

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

H
huangjie 已提交
2901 2902 2903 2904
| 参数名   | 类型     | 必填   | 说明    |
| ----- | ------ | ---- | ----- |
| resId | number | 是    | 资源ID值 |

H
huangjie 已提交
2905 2906
**返回值:**

H
huangjie 已提交
2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928
| 类型                    | 说明                   |
| --------------------- | -------------------- |
| Promise&lt;string&gt; | 资源ID值对应的图片资源Base64编码 |

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


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

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

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

H
huangjie 已提交
2929
从API version 9开始不再维护,建议使用[getPluralStringValue](#getpluralstringvalue9)代替。
H
huangjie 已提交
2930 2931 2932 2933

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

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

H
huangjie 已提交
2935 2936 2937 2938 2939
| 参数名   | 类型     | 必填   | 说明    |
| ----- | ------ | ---- | ----- |
| resId | number | 是    | 资源ID值 |
| num   | number | 是    | 数量值   |

H
huangjie 已提交
2940 2941
**返回值:**

H
huangjie 已提交
2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963
| 类型                    | 说明                        |
| --------------------- | ------------------------- |
| Promise&lt;string&gt; | 根据提供的数量获取对应ID字符串表示的单复数字符串 |

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


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

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

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

H
huangjie 已提交
2964
从API version 9开始不再维护,建议使用[getPluralStringValue](#getpluralstringvalue9-1)代替。
H
huangjie 已提交
2965 2966 2967 2968

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

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

H
huangjie 已提交
2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000
| 参数名      | 类型                          | 必填   | 说明                              |
| -------- | --------------------------- | ---- | ------------------------------- |
| resId    | number                      | 是    | 资源ID值                           |
| num      | number                      | 是    | 数量值                             |
| callback | AsyncCallback&lt;string&gt; | 是    | 异步回调,返回根据指定数量获取指定ID字符串表示的单复数字符串 |

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


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

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

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

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

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

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

H
huangjie 已提交
3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031
| 参数名      | 类型                              | 必填   | 说明                      |
| -------- | ------------------------------- | ---- | ----------------------- |
| path     | string                          | 是    | rawfile文件路径             |
| callback | AsyncCallback&lt;Uint8Array&gt; | 是    | 异步回调,用于返回获取的rawfile文件内容 |

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


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

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

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

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

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

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

H
huangjie 已提交
3033 3034 3035 3036
| 参数名  | 类型     | 必填   | 说明          |
| ---- | ------ | ---- | ----------- |
| path | string | 是    | rawfile文件路径 |

H
huangjie 已提交
3037 3038
**返回值:**

H
huangjie 已提交
3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065
| 类型                        | 说明          |
| ------------------------- | ----------- |
| Promise&lt;Uint8Array&gt; | rawfile文件内容 |

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


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

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

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

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

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

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

H
huangjie 已提交
3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097
| 参数名      | 类型                                       | 必填   | 说明                               |
| -------- | ---------------------------------------- | ---- | -------------------------------- |
| path     | string                                   | 是    | rawfile文件路径                      |
| callback | AsyncCallback&lt;[RawFileDescriptor](#rawfiledescriptor8)&gt; | 是    | 异步回调,用于返回获取的rawfile文件的descriptor |

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

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

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

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

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

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

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

H
huangjie 已提交
3099 3100 3101 3102
| 参数名  | 类型     | 必填   | 说明          |
| ---- | ------ | ---- | ----------- |
| path | string | 是    | rawfile文件路径 |

H
huangjie 已提交
3103 3104
**返回值:**

H
huangjie 已提交
3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119
| 类型                                       | 说明                  |
| ---------------------------------------- | ------------------- |
| 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 已提交
3120
  ```