MiniX自绘渲染跨平台框架

# @ohos.resourceManager (资源管理)

资源管理模块，根据当前 configuration（语言，区域，横竖屏，mccmnc）和 device capability（设备类型，分辨率）提供获取应用资源信息读取接口。

说明：

本模块首批接口从 API version 6 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

# 导入模块

import resourceManager from "@ohos.resourceManager";
1

# 使用说明

从 API Version9 开始，Stage 模型支持了通过 context 获取 resourceManager 对象的方式，再调用其内部获取资源的接口，无需再导入包，此方式 FA 模型不适用。

this.context.resourceManager;
1

# resourceManager.getResourceManager

getResourceManager(callback: AsyncCallback<ResourceManager>): void

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

此接口仅可在 FA 模型下使用。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名 类型 必填 说明
callback AsyncCallback<ResourceManager> 是 callback 方式返回 ResourceManager 对象

示例：

resourceManager.getResourceManager((error, mgr) => {
  if (error != null) {
    console.log("error is " + error);
    return;
  }
  mgr.getString(0x1000000, (error, value) => {
    if (error != null) {
      console.log("error is " + error);
    } else {
      let str = value;
    }
  });
});
1
2
3
4
5
6
7
8
9
10
11
12
13

# resourceManager.getResourceManager

getResourceManager(bundleName: string, callback: AsyncCallback<ResourceManager>): void

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

此接口仅可在 FA 模型下使用。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名 类型 必填 说明
bundleName string 是 指定应用的 Bundle 名称
callback AsyncCallback<ResourceManager> 是 callback 方式返回 ResourceManager 对象

示例：

resourceManager.getResourceManager(
  "com.example.myapplication",
  (error, mgr) => {}
);
1
2
3
4

# resourceManager.getResourceManager

getResourceManager(): Promise<ResourceManager>

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

此接口仅可在 FA 模型下使用。

系统能力：SystemCapability.Global.ResourceManager

返回值：

类型 说明
Promise<ResourceManager> Promise 方式返回资源管理对象

示例：

resourceManager
  .getResourceManager()
  .then((mgr) => {
    mgr.getString(0x1000000, (error, value) => {
      if (error != null) {
        console.log("error is " + error);
      } else {
        let str = value;
      }
    });
  })
  .catch((error) => {
    console.log("error is " + error);
  });
1
2
3
4
5
6
7
8
9
10
11
12
13
14

# resourceManager.getResourceManager

getResourceManager(bundleName: string): Promise<ResourceManager>

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

此接口仅可在 FA 模型下使用。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名 类型 必填 说明
bundleName string 是 指定应用的 Bundle 名称

返回值：

类型 说明
Promise<ResourceManager> Promise 方式返回的资源管理对象

示例：

resourceManager
  .getResourceManager("com.example.myapplication")
  .then((mgr) => {})
  .catch((error) => {});
1
2
3
4

# Direction

用于表示设备屏幕方向。

系统能力：SystemCapability.Global.ResourceManager

名称 默认值 说明
DIRECTION_VERTICAL 0 竖屏
DIRECTION_HORIZONTAL 1 横屏

# DeviceType

用于表示当前设备类型。

系统能力：SystemCapability.Global.ResourceManager

名称 默认值 说明
DEVICE_TYPE_PHONE 0x00 手机
DEVICE_TYPE_TABLET 0x01 平板
DEVICE_TYPE_CAR 0x02 汽车
DEVICE_TYPE_PC 0x03 电脑
DEVICE_TYPE_TV 0x04 电视
DEVICE_TYPE_WEARABLE 0x06 穿戴

# ScreenDensity

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

系统能力：SystemCapability.Global.ResourceManager

名称 默认值 说明
SCREEN_SDPI 120 小规模的屏幕密度
SCREEN_MDPI 160 中规模的屏幕密度
SCREEN_LDPI 240 大规模的屏幕密度
SCREEN_XLDPI 320 特大规模的屏幕密度
SCREEN_XXLDPI 480 超大规模的屏幕密度
SCREEN_XXXLDPI 640 超特大规模的屏幕密度

# Configuration

表示当前设备的状态。

系统能力：SystemCapability.Global.ResourceManager

名称 参数类型 可读 可写 说明
direction Direction 是 否 当前设备屏幕方向
locale string 是 否 当前系统语言

示例：

resourceManager.getResourceManager((error, mgr) => {
  mgr.getConfiguration((error, value) => {
    let direction = value.direction;
    let locale = value.locale;
  });
});
1
2
3
4
5
6

# DeviceCapability

表示设备支持的能力。

系统能力：SystemCapability.Global.ResourceManager

名称 参数类型 可读 可写 说明
screenDensity ScreenDensity 是 否 当前设备屏幕密度
deviceType DeviceType 是 否 当前设备类型

示例：

resourceManager.getResourceManager((error, mgr) => {
  mgr.getDeviceCapability((error, value) => {
    let screenDensity = value.screenDensity;
    let deviceType = value.deviceType;
  });
});
1
2
3
4
5
6

# RawFileDescriptor8+

表示 rawfile 的 descriptor 信息。

系统能力： SystemCapability.Global.ResourceManager

名称 类型 说明
fd number rawfile 的 descriptor
offset number rawfile 的起始偏移量
length number rawfile 的文件长度

# Resource9+

表示的资源信息。

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

名称 类型 说明
bundleName string 应用的 bundle 名称
moduleName string 应用的 module 名称
id number 资源的 id 值

# ResourceManager

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

说明：

  • ResourceManager 涉及到的方法，仅限基于 TS 扩展的声明式开发范式使用。

  • 资源文件在工程的 resources 目录中定义，id 可通过$r(资源地址).id的方式获取，例如$r('app.string.test').id。

# getString

getString(resId: number, callback: AsyncCallback<string>): void

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

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名 类型 必填 说明
resId number 是 资源 ID 值
callback AsyncCallback<string> 是 异步回调，用于返回获取的字符串

示例：

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;
    }
  });
});
1
2
3
4
5
6
7
8
9

# getString

getString(resId: number): Promise<string>

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

系统能力：SystemCapability.Global.ResourceManager

参数：

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

返回值：

类型 说明
Promise<string> 资源 ID 值对应的字符串

示例：

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);
    });
});
1
2
3
4
5
6
7
8
9
10

# getString9+

getString(resource: Resource, callback: AsyncCallback<string>): void

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

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名 类型 必填 说明
resource Resource 是 资源信息
callback AsyncCallback<string> 是 异步回调，用于返回获取的字符串

示例：

let resource = {
  bundleName: "com.example.myapplication",
  moduleName: "entry",
  id: $r("app.string.test").id,
};
this.context.resourceManager.getString(resource, (error, value) => {
  if (error != null) {
    console.log("error is " + error);
  } else {
    let str = value;
  }
});
1
2
3
4
5
6
7
8
9
10
11
12

# getString9+

getString(resource: Resource): Promise<string>

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

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名 类型 必填 说明
resource Resource 是 资源信息

返回值：

类型 说明
Promise<string> resource 对象对应的字符串

示例：

let resource = {
  bundleName: "com.example.myapplication",
  moduleName: "entry",
  id: $r("app.string.test").id,
};
this.context.resourceManager
  .getString(resource)
  .then((value) => {
    let str = value;
  })
  .catch((error) => {
    console.log("getstring promise error is " + error);
  });
1
2
3
4
5
6
7
8
9
10
11
12
13

# getStringArray

getStringArray(resId: number, callback: AsyncCallback<Array<string>>): void

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

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名 类型 必填 说明
resId number 是 资源 ID 值
callback AsyncCallback<Array<string>> 是 异步回调，用于返回获取的字符串数组

示例：

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;
    }
  });
});
1
2
3
4
5
6
7
8
9

# getStringArray

getStringArray(resId: number): Promise<Array<string>>

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

系统能力：SystemCapability.Global.ResourceManager

参数：

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

返回值：

类型 说明
Promise<Array<string>> 资源 ID 值对应的字符串数组

示例：

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);
    });
});
1
2
3
4
5
6
7
8
9
10

# getStringArray9+

getStringArray(resource: Resource, callback: AsyncCallback<Array<string>>): void

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

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名 类型 必填 说明
resource Resource 是 资源信息
callback AsyncCallback<Array<string>> 是 异步回调，用于返回获取的字符串数组

示例：

let resource = {
  bundleName: "com.example.myapplication",
  moduleName: "entry",
  id: $r("app.strarray.test").id,
};
this.context.resourceManager.getStringArray(resource, (error, value) => {
  if (error != null) {
    console.log("error is " + error);
  } else {
    let strArray = value;
  }
});
1
2
3
4
5
6
7
8
9
10
11
12

# getStringArray9+

getStringArray(resource: Resource): Promise<Array<string>>

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

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名 类型 必填 说明
resource Resource 是 资源信息

返回值：

类型 说明
Promise<Array<string>> resource 对象对应的字符串数组

示例：

let resource = {
  bundleName: "com.example.myapplication",
  moduleName: "entry",
  id: $r("app.strarray.test").id,
};
this.context.resourceManager
  .getStringArray(resource)
  .then((value) => {
    let strArray = value;
  })
  .catch((error) => {
    console.log("getStringArray promise error is " + error);
  });
1
2
3
4
5
6
7
8
9
10
11
12
13

# getMedia

getMedia(resId: number, callback: AsyncCallback<Uint8Array>): void

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

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名 类型 必填 说明
resId number 是 资源 ID 值
callback AsyncCallback<Uint8Array> 是 异步回调，用于返回获取的媒体文件内容

示例：

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;
    }
  });
});
1
2
3
4
5
6
7
8
9

# getMedia

getMedia(resId: number): Promise<Uint8Array>

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

系统能力：SystemCapability.Global.ResourceManager

参数：

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

返回值：

类型 说明
Promise<Uint8Array> 资源 ID 值对应的媒体文件内容

示例：

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);
    });
});
1
2
3
4
5
6
7
8
9
10

# getMedia9+

getMedia(resource: Resource, callback: AsyncCallback<Uint8Array>): void

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

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名 类型 必填 说明
resource Resource 是 资源信息
callback AsyncCallback<Uint8Array> 是 异步回调，用于返回获取的媒体文件内容

示例：

let resource = {
  bundleName: "com.example.myapplication",
  moduleName: "entry",
  id: $r("app.media.test").id,
};
this.context.resourceManager.getMedia(resource, (error, value) => {
  if (error != null) {
    console.log("error is " + error);
  } else {
    let media = value;
  }
});
1
2
3
4
5
6
7
8
9
10
11
12

# getMedia9+

getMedia(resource: Resource): Promise<Uint8Array>

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

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名 类型 必填 说明
resource Resource 是 资源信息

返回值：

类型 说明
Promise<Uint8Array> resource 对象对应的媒体文件内容

示例：

let resource = {
  bundleName: "com.example.myapplication",
  moduleName: "entry",
  id: $r("app.media.test").id,
};
this.context.resourceManager
  .getMedia(resource)
  .then((value) => {
    let media = value;
  })
  .catch((error) => {
    console.log("getMedia promise error is " + error);
  });
1
2
3
4
5
6
7
8
9
10
11
12
13

# getMediaBase64

getMediaBase64(resId: number, callback: AsyncCallback<string>): void

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

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名 类型 必填 说明
resId number 是 资源 ID 值
callback AsyncCallback<string> 是 异步回调，用于返回获取的图片资源 Base64 编码

示例：

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;
    }
  });
});
1
2
3
4
5
6
7
8
9

# getMediaBase64

getMediaBase64(resId: number): Promise<string>

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

系统能力：SystemCapability.Global.ResourceManager

参数：

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

返回值：

类型 说明
Promise<string> 资源 ID 值对应的图片资源 Base64 编码

示例：

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);
    });
});
1
2
3
4
5
6
7
8
9
10

# getMediaBase649+

getMediaBase64(resource: Resource, callback: AsyncCallback<string>): void

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

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名 类型 必填 说明
resource Resource 是 资源信息
callback AsyncCallback<string> 是 异步回调，用于返回获取的图片资源 Base64 编码

示例：

let resource = {
  bundleName: "com.example.myapplication",
  moduleName: "entry",
  id: $r("app.media.test").id,
};
this.context.resourceManager.getMediaBase64(resource, (error, value) => {
  if (error != null) {
    console.log("error is " + error);
  } else {
    let media = value;
  }
});
1
2
3
4
5
6
7
8
9
10
11
12

# getMediaBase649+

getMediaBase64(resource: Resource): Promise<string>

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

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名 类型 必填 说明
resource Resource 是 资源信息

返回值：

类型 说明
Promise<string> resource 对象对应的图片资源 Base64 编码

示例：

let resource = {
  bundleName: "com.example.myapplication",
  moduleName: "entry",
  id: $r("app.media.test").id,
};
this.context.resourceManager
  .getMediaBase64(resource)
  .then((value) => {
    let media = value;
  })
  .catch((error) => {
    console.log("getMediaBase64 promise error is " + error);
  });
1
2
3
4
5
6
7
8
9
10
11
12
13

# getConfiguration

getConfiguration(callback: AsyncCallback<Configuration>): void

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

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名 类型 必填 说明
callback AsyncCallback<Configuration> 是 异步回调，用于返回设备的 Configuration

示例：

resourceManager.getResourceManager((error, mgr) => {
  mgr.getConfiguration((error, value) => {
    if (error != null) {
      console.log("error is " + error);
    } else {
      let direction = value.direction;
      let locale = value.locale;
    }
  });
});
1
2
3
4
5
6
7
8
9
10

# getConfiguration

getConfiguration(): Promise<Configuration>

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

系统能力：SystemCapability.Global.ResourceManager

返回值：

类型 说明
Promise<Configuration> 设备的 Configuration

示例：

resourceManager.getResourceManager((error, mgr) => {
  mgr
    .getConfiguration()
    .then((value) => {
      let direction = value.direction;
      let locale = value.locale;
    })
    .catch((error) => {
      console.log("getConfiguration promise error is " + error);
    });
});
1
2
3
4
5
6
7
8
9
10
11

# getDeviceCapability

getDeviceCapability(callback: AsyncCallback<DeviceCapability>): void

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

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名 类型 必填 说明
callback AsyncCallback<DeviceCapability> 是 异步回调，用于返回设备的 DeviceCapability

示例：

resourceManager.getResourceManager((error, mgr) => {
  mgr.getDeviceCapability((error, value) => {
    if (error != null) {
      console.log("error is " + error);
    } else {
      let screenDensity = value.screenDensity;
      let deviceType = value.deviceType;
    }
  });
});
1
2
3
4
5
6
7
8
9
10

# getDeviceCapability

getDeviceCapability(): Promise<DeviceCapability>

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

系统能力：SystemCapability.Global.ResourceManager

返回值：

类型 说明
Promise<DeviceCapability> 设备的 DeviceCapability

示例：

resourceManager.getResourceManager((error, mgr) => {
  mgr
    .getDeviceCapability()
    .then((value) => {
      let screenDensity = value.screenDensity;
      let deviceType = value.deviceType;
    })
    .catch((error) => {
      console.log("getDeviceCapability promise error is " + error);
    });
});
1
2
3
4
5
6
7
8
9
10
11

# getPluralString

getPluralString(resId: number, num: number, callback: AsyncCallback<string>): void

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

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名 类型 必填 说明
resId number 是 资源 ID 值
num number 是 数量值
callback AsyncCallback<string> 是 异步回调，返回根据指定数量获取指定 ID 字符串表示的单复数字符串

示例：

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;
    }
  });
});
1
2
3
4
5
6
7
8
9

# getPluralString

getPluralString(resId: number, num: number): Promise<string>

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

系统能力：SystemCapability.Global.ResourceManager

参数：

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

返回值：

类型 说明
Promise<string> 根据提供的数量获取对应 ID 字符串表示的单复数字符串

示例：

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);
    });
});
1
2
3
4
5
6
7
8
9
10

# getPluralString9+

getPluralString(resource: Resource, num: number, callback: AsyncCallback<string>): void

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

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名 类型 必填 说明
resource Resource 是 资源信息
num number 是 数量值
callback AsyncCallback<string> 是 异步回调，返回根据指定数量获取指定 resource 对象表示的单复数字符串

示例：

let resource = {
  bundleName: "com.example.myapplication",
  moduleName: "entry",
  id: $r("app.plural.test").id,
};
this.context.resourceManager.getPluralString(resource, 1, (error, value) => {
  if (error != null) {
    console.log("error is " + error);
  } else {
    let str = value;
  }
});
1
2
3
4
5
6
7
8
9
10
11
12

# getPluralString9+

getPluralString(resource: Resource, num: number): Promise<string>

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

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名 类型 必填 说明
resource Resource 是 资源信息
num number 是 数量值

返回值：

类型 说明
Promise<string> 根据提供的数量获取对应 resource 对象表示的单复数字符串

示例：

let resource = {
  bundleName: "com.example.myapplication",
  moduleName: "entry",
  id: $r("app.plural.test").id,
};
this.context.resourceManager
  .getPluralString(resource, 1)
  .then((value) => {
    let str = value;
  })
  .catch((error) => {
    console.log("getPluralString promise error is " + error);
  });
1
2
3
4
5
6
7
8
9
10
11
12
13

# getRawFile8+

getRawFile(path: string, callback: AsyncCallback<Uint8Array>): void

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

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名 类型 必填 说明
path string 是 rawfile 文件路径
callback AsyncCallback<Uint8Array> 是 异步回调，用于返回获取的 rawfile 文件内容

示例：

resourceManager.getResourceManager((error, mgr) => {
  mgr.getRawFile("test.xml", (error, value) => {
    if (error != null) {
      console.log("error is " + error);
    } else {
      let rawFile = value;
    }
  });
});
1
2
3
4
5
6
7
8
9

# getRawFile8+

getRawFile(path: string): Promise<Uint8Array>

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

系统能力：SystemCapability.Global.ResourceManager

参数：

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

返回值：

类型 说明
Promise<Uint8Array> rawfile 文件内容

示例：

resourceManager.getResourceManager((error, mgr) => {
  mgr
    .getRawFile("test.xml")
    .then((value) => {
      let rawFile = value;
    })
    .catch((error) => {
      console.log("getRawFile promise error is " + error);
    });
});
1
2
3
4
5
6
7
8
9
10

# getRawFileDescriptor8+

getRawFileDescriptor(path: string, callback: AsyncCallback<RawFileDescriptor>): void

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

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名 类型 必填 说明
path string 是 rawfile 文件路径
callback AsyncCallback<RawFileDescriptor> 是 异步回调，用于返回获取的 rawfile 文件的 descriptor

示例：

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;
    }
  });
});
1
2
3
4
5
6
7
8
9
10
11

# getRawFileDescriptor8+

getRawFileDescriptor(path: string): Promise<RawFileDescriptor>

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

系统能力：SystemCapability.Global.ResourceManager

参数：

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

返回值：

类型 说明
Promise<RawFileDescriptor> rawfile 文件 descriptor

示例：

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);
    });
});
1
2
3
4
5
6
7
8
9
10
11
12

# closeRawFileDescriptor8+

closeRawFileDescriptor(path: string, callback: AsyncCallback<void>): void

用户关闭 resources/rawfile 目录下 rawfile 文件的 descriptor，使用 callback 形式返回。

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名 类型 必填 说明
path string 是 rawfile 文件路径
callback AsyncCallback<void> 是 异步回调

示例：

resourceManager.getResourceManager((error, mgr) => {
  mgr.closeRawFileDescriptor("test.xml", (error, value) => {
    if (error != null) {
      console.log("error is " + error);
    }
  });
});
1
2
3
4
5
6
7

# closeRawFileDescriptor8+

closeRawFileDescriptor(path: string): Promise<void>

用户关闭 resources/rawfile 目录下 rawfile 文件的 descriptor，使用 Promise 形式返回。

系统能力：SystemCapability.Global.ResourceManager

参数：

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

返回值：

类型 说明
Promise<void> 无返回值

示例：

resourceManager.getResourceManager((error, mgr) => {
  mgr
    .closeRawFileDescriptor("test.xml")
    .then((value) => {
      let result = value;
    })
    .catch((error) => {
      console.log("closeRawFileDescriptor promise error is " + error);
    });
});
1
2
3
4
5
6
7
8
9
10

# release7+

release()

用户释放创建的 resourceManager。

系统能力：SystemCapability.Global.ResourceManager

示例：

resourceManager.getResourceManager((error, mgr) => {
  mgr.release();
});
1
2
3

# getStringByName9+

getStringByName(resName: string, callback: AsyncCallback<string>): void

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

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名 类型 必填 说明
resName string 是 资源名称
callback AsyncCallback<string> 是 异步回调，用于返回获取的字符串

示例：

this.context.resourceManager.getStringByName("test", (error, value) => {
  if (error != null) {
    console.log("error is " + error);
  } else {
    let string = value;
  }
});
1
2
3
4
5
6
7

# getStringByName9+

getStringByName(resName: string): Promise<string>

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

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名 类型 必填 说明
resName string 是 资源名称

返回值：

类型 说明
Promise<string> 资源名称对应的字符串

示例：

this.context.resourceManager
  .getStringByName("test")
  .then((value) => {
    let string = value;
  })
  .catch((error) => {
    console.log("getStringByName promise error is " + error);
  });
1
2
3
4
5
6
7
8

# getStringArrayByName9+

getStringArrayByName(resName: string, callback: AsyncCallback<Array<string>>): void

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

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名 类型 必填 说明
resName string 是 资源名称
callback AsyncCallback<Array<string>> 是 异步回调，用于返回获取的字符串数组

示例：

this.context.resourceManager.getStringArrayByName("test", (error, value) => {
  if (error != null) {
    console.log("error is " + error);
  } else {
    let strArray = value;
  }
});
1
2
3
4
5
6
7

# getStringArrayByName9+

getStringArrayByName(resName: string): Promise<Array<string>>

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

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名 类型 必填 说明
resName string 是 资源名称

返回值：

类型 说明
Promise<Array<string>> 资源名称对应的字符串数组

示例：

this.context.resourceManager
  .getStringArrayByName("test")
  .then((value) => {
    let strArray = value;
  })
  .catch((error) => {
    console.log("getStringArrayByName promise error is " + error);
  });
1
2
3
4
5
6
7
8

# getMediaByName9+

getMediaByName(resName: string, callback: AsyncCallback<Uint8Array>): void

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

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名 类型 必填 说明
resName string 是 资源名称
callback AsyncCallback<Uint8Array> 是 异步回调，用于返回获取的媒体文件内容

示例：

this.context.resourceManager.getMediaByName("test", (error, value) => {
  if (error != null) {
    console.log("error is " + error);
  } else {
    let media = value;
  }
});
1
2
3
4
5
6
7

# getMediaByName9+

getMediaByName(resName: string): Promise<Uint8Array>

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

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名 类型 必填 说明
resName string 是 资源名称

返回值：

类型 说明
Promise<Uint8Array> 资源名称对应的媒体文件内容

示例：

this.context.resourceManager
  .getMediaByName("test")
  .then((value) => {
    let media = value;
  })
  .catch((error) => {
    console.log("getMediaByName promise error is " + error);
  });
1
2
3
4
5
6
7
8

# getMediaBase64ByName9+

getMediaBase64ByName(resName: string, callback: AsyncCallback<string>): void

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

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名 类型 必填 说明
resName string 是 资源名称
callback AsyncCallback<string> 是 异步回调，用于返回获取的图片资源 Base64 编码

示例：

this.context.resourceManager.getMediaBase64ByName("test", (error, value) => {
  if (error != null) {
    console.log("error is " + error);
  } else {
    let media = value;
  }
});
1
2
3
4
5
6
7

# getMediaBase64ByName9+

getMediaBase64ByName(resName: string): Promise<string>

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

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名 类型 必填 说明
resName string 是 资源名称

返回值：

类型 说明
Promise<string> 资源名称对应的图片资源 Base64 编码

示例：

this.context.resourceManager
  .getMediaBase64ByName("test")
  .then((value) => {
    let media = value;
  })
  .catch((error) => {
    console.log("getMediaBase64ByName promise error is " + error);
  });
1
2
3
4
5
6
7
8

# getPluralStringByName9+

getPluralStringByName(resName: string, num: number, callback: AsyncCallback<string>): void

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

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名 类型 必填 说明
resName string 是 资源名称
num number 是 数量值
callback AsyncCallback<string> 是 异步回调，返回根据传入的数量值获取资源名称对应的字符串资源

示例：

this.context.resourceManager.getPluralStringByName(
  "test",
  1,
  (error, value) => {
    if (error != null) {
      console.log("error is " + error);
    } else {
      let str = value;
    }
  }
);
1
2
3
4
5
6
7
8
9
10
11

# getPluralStringByName9+

getPluralStringByName(resName: string, num: number): Promise<string>

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

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名 类型 必填 说明
resName string 是 资源名称
num number 是 数量值

返回值：

类型 说明
Promise<string> 根据传入的数量值获取资源名称对应的字符串资源

示例：

this.context.resourceManager
  .getPluralStringByName("test", 1)
  .then((value) => {
    let str = value;
  })
  .catch((error) => {
    console.log("getPluralStringByName promise error is " + error);
  });
1
2
3
4
5
6
7
8

# getStringSync9+

getStringSync(resId: number): string

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

系统能力：SystemCapability.Global.ResourceManager

参数：

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

返回值：

类型 说明
string 资源 ID 值对应的字符串

示例：

this.context.resourceManager.getStringSync($r("app.string.test").id);
1

# getStringSync9+

getStringSync(resource: Resource): string

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

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名 类型 必填 说明
resource Resource 是 资源信息

返回值：

类型 说明
string resource 对象对应的字符串

示例：

let resource = {
  bundleName: "com.example.myapplication",
  moduleName: "entry",
  id: $r("app.string.test").id,
};
this.context.resourceManager.getStringSync(resource);
1
2
3
4
5
6

# getStringByNameSync9+

getStringByNameSync(resName: string): string

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

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名 类型 必填 说明
resName string 是 资源名称

返回值：

类型 说明
string 资源名称对应的字符串

示例：

this.context.resourceManager.getStringByNameSync("test");
1

# getBoolean9+

getBoolean(resId: number): boolean

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

系统能力：SystemCapability.Global.ResourceManager

参数：

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

返回值：

类型 说明
boolean 资源 ID 值对应的布尔结果

示例：

this.context.resourceManager.getBoolean($r("app.boolean.boolean_test").id);
1

# getBoolean9+

getBoolean(resource: Resource): boolean

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

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名 类型 必填 说明
resource Resource 是 资源信息

返回值：

类型 说明
boolean resource 对象对应的布尔结果

示例：

let resource = {
  bundleName: "com.example.myapplication",
  moduleName: "entry",
  id: $r("app.boolean.boolean_test").id,
};
this.context.resourceManager.getBoolean(resource);
1
2
3
4
5
6

# getBooleanByName9+

getBooleanByName(resName: string): boolean

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

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名 类型 必填 说明
resName string 是 资源名称

返回值：

类型 说明
boolean 资源名称对应的布尔结果

示例：

this.context.resourceManager.getBooleanByName("boolean_test");
1

# getNumber9+

getNumber(resId: number): number

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

系统能力：SystemCapability.Global.ResourceManager

参数：

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

返回值：

类型 说明
number 资源 ID 值对应的数值

示例：

this.context.resourceManager.getNumber($r("app.integer.integer_test").id);
this.context.resourceManager.getNumber($r("app.float.float_test").id);
1
2

# getNumber9+

getNumber(resource: Resource): number

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

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名 类型 必填 说明
resource Resource 是 资源信息

返回值：

类型 说明
number resource 对象对应的数值

示例：

let resource = {
  bundleName: "com.example.myapplication",
  moduleName: "entry",
  id: $r("app.integer.integer_test").id,
};
this.context.resourceManager.getNumber(resource);
1
2
3
4
5
6

# getNumberByName9+

getNumberByName(resName: string): number

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

系统能力：SystemCapability.Global.ResourceManager

参数：

参数名 类型 必填 说明
resName string 是 资源名称

返回值：

类型 说明
number 资源名称对应的数值

示例：

this.context.resourceManager.getNumberByName("integer_test");
this.context.resourceManager.getNumberByName("float_test");
1
2