资源管理

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

说明： 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 开发前请熟悉鸿蒙开发指导文档 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]

导入模块

import resourceManager from '@ohos.resourceManager';

使用说明

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

this.context.resourceManager;

resourceManager.getResourceManager

getResourceManager(callback: AsyncCallback): void

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

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

系统能力 ：SystemCapability.Global.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;
        }
    });
});

resourceManager.getResourceManager

getResourceManager(bundleName: string, callback: AsyncCallback): void

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

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

系统能力 ：SystemCapability.Global.ResourceManager

参数：

示例：

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

resourceManager.getResourceManager

getResourceManager(): Promise

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

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

系统能力 ：SystemCapability.Global.ResourceManager

返回值：

示例：

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);
});

resourceManager.getResourceManager

getResourceManager(bundleName: string): Promise

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

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

系统能力 ：SystemCapability.Global.ResourceManager

参数：

返回值：

示例：

resourceManager.getResourceManager("com.example.myapplication").then(mgr = > {

}).catch(error = > {

});

Direction

用于表示设备屏幕方向。

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

DeviceType

用于表示当前设备类型。

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

ScreenDensity

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

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

Configuration

表示当前设备的状态。

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

示例：

resourceManager.getResourceManager((error, mgr) = > {
    mgr.getConfiguration((error, value) = > {
        let direction = value.direction;
        let locale = value.locale;
    });
});

DeviceCapability

表示设备支持的能力。

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

示例：

resourceManager.getResourceManager((error, mgr) = > {
    mgr.getDeviceCapability((error, value) = > {
        let screenDensity = value.screenDensity;
        let deviceType = value.deviceType;
    });
});

RawFileDescriptor8+

表示rawfile的descriptor信息。
系统能力： 以下各项对应的系统能力均为SystemCapability.Global.ResourceManager

ResourceManager

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

说明：

• ResourceManager涉及到的方法，仅限基于TS扩展的声明式开发范式使用。
• 资源文件在工程的resources目录中定义，id可通过r(资源地址).id的方式获取，例如r(资源地址).id的方式获取，例如r('app.string.test').id。

getString

getString(resId: number, callback: AsyncCallback): void

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

系统能力 ：SystemCapability.Global.ResourceManager

参数：

示例：

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

getString(resId: number): Promise

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

系统能力 ：SystemCapability.Global.ResourceManager

参数：

返回值：

示例：

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

getStringArray(resId: number, callback: AsyncCallback>): void

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

系统能力 ：SystemCapability.Global.ResourceManager

参数：

示例：

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

getStringArray(resId: number): Promise>

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

系统能力 ：SystemCapability.Global.ResourceManager

参数：

返回值：

示例：

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

getMedia(resId: number, callback: AsyncCallback): void

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

系统能力 ：SystemCapability.Global.ResourceManager

参数：

示例：

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

getMedia(resId: number): Promise

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

系统能力 ：SystemCapability.Global.ResourceManager

参数：

返回值：

示例：

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

getMediaBase64(resId: number, callback: AsyncCallback): void

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

系统能力 ：SystemCapability.Global.ResourceManager

参数：

示例：

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

getMediaBase64(resId: number): Promise

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

系统能力 ：SystemCapability.Global.ResourceManager

参数：

返回值：

示例：

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);
    });
});

getConfiguration

getConfiguration(callback: AsyncCallback): void

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

系统能力 ：SystemCapability.Global.ResourceManager

参数：

示例：

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;
        }
    });
});

getConfiguration

getConfiguration(): Promise

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

系统能力 ：SystemCapability.Global.ResourceManager

返回值：

示例：

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);
    });
});

getDeviceCapability

getDeviceCapability(callback: AsyncCallback): void

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

系统能力 ：SystemCapability.Global.ResourceManager

参数：

示例：

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;
        }
    });
});

getDeviceCapability

getDeviceCapability(): Promise

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

系统能力 ：SystemCapability.Global.ResourceManager

返回值：

示例：

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);
    });
});

getPluralString

getPluralString(resId: number, num: number, callback: AsyncCallback): void

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

系统能力 ：SystemCapability.Global.ResourceManager

参数：

示例：

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;
        }
    });
});

getPluralString

getPluralString(resId: number, num: number): Promise

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

系统能力 ：SystemCapability.Global.ResourceManager

参数：

返回值：

示例：

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);
    });
});

getRawFile8+

getRawFile(path: string, callback: AsyncCallback): void

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

系统能力 ：SystemCapability.Global.ResourceManager

参数：

示例：

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

getRawFile8+

getRawFile(path: string): Promise

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

系统能力 ：SystemCapability.Global.ResourceManager

参数：

返回值：

示例：

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

getRawFileDescriptor8+

getRawFileDescriptor(path: string, callback: AsyncCallback): void

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

系统能力 ：SystemCapability.Global.ResourceManager

参数：

示例：

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;
        }
    });
});

getRawFileDescriptor8+

getRawFileDescriptor(path: string): Promise

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

系统能力 ：SystemCapability.Global.ResourceManager

参数：

返回值：

示例：

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);
    });
});

closeRawFileDescriptor8+

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

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

系统能力 ：SystemCapability.Global.ResourceManager

参数：

示例：

resourceManager.getResourceManager((error, mgr) = > {
    mgr.closeRawFileDescriptor("test.xml", (error, value) = > {
        if (error != null) {
            console.log("error is " + error);
        }
    });
});

closeRawFileDescriptor8+

closeRawFileDescriptor(path: string): Promise

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

系统能力 ：SystemCapability.Global.ResourceManager

参数：

返回值：

示例：

resourceManager.getResourceManager((error, mgr) = > {
    mgr.closeRawFileDescriptor("test.xml").then(value = > {
        let result = value;
    }).catch(error = > {
        console.log("closeRawFileDescriptor promise error is " + error);
    });
});

release7+

release()

用户释放创建的resourceManager。

系统能力 ：SystemCapability.Global.ResourceManager

示例：

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

getStringByName9+

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

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

系统能力 ：SystemCapability.Global.ResourceManager

参数：

示例：

resourceManager.getStringByName("test", (error, value) = > {
    if (error != null) {
        console.log("error is " + error);
    } else {
        let string = value;
    }
});

getStringByName9+

getStringByName(resName: string): Promise

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

系统能力 ：SystemCapability.Global.ResourceManager

参数：

返回值：

示例：

resourceManager.getStringByName("test").then(value = > {
    let string = value;
}).catch(error = > {
    console.log("getStringByName promise error is " + error);
});

getStringArrayByName9+

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

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

系统能力 ：SystemCapability.Global.ResourceManager

参数：

示例：

resourceManager.getStringArrayByName("test", (error, value) = > {
    if (error != null) {
        console.log("error is " + error);
    } else {
        let strArray = value;
    }
});

getStringArrayByName9+

getStringArrayByName(resName: string): Promise>

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

系统能力 ：SystemCapability.Global.ResourceManager

参数：

返回值：

示例：

resourceManager.getStringArrayByName("test").then(value = > {
    let strArray = value;
}).catch(error = > {
    console.log("getStringArrayByName promise error is " + error);
});

getMediaByName9+

getMediaByName(resName: string, callback: AsyncCallback): void

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

系统能力 ：SystemCapability.Global.ResourceManager

参数：

示例：

resourceManager.getMediaByName("test", (error, value) = > {
    if (error != null) {
        console.log("error is " + error);
    } else {
        let media = value;
    }
});

getMediaByName9+

getMediaByName(resName: string): Promise

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

系统能力 ：SystemCapability.Global.ResourceManager

参数：

返回值：

示例：

resourceManager.getMediaByName("test").then(value = > {
    let media = value;
}).catch(error = > {
    console.log("getMediaByName promise error is " + error);
});

getMediaBase64ByName9+

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

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

系统能力 ：SystemCapability.Global.ResourceManager

参数：

示例：

resourceManager.getMediaBase64ByName("test", (error, value) = > {
    if (error != null) {
        console.log("error is " + error);
    } else {
        let media = value;
    }
});

getMediaBase64ByName9+

getMediaBase64ByName(resName: string): Promise

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

系统能力 ：SystemCapability.Global.ResourceManager

参数：

返回值：

示例：

resourceManager.getMediaByName("test").then(value = > {
    let media = value;
}).catch(error = > {
    console.log("getMediaBase64ByName promise error is " + error);
});

getPluralStringByName9+

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

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

系统能力 ：SystemCapability.Global.ResourceManager

参数：

示例：

resourceManager.getPluralStringByName("test", 1, (error, value) = > {
    if (error != null) {
        console.log("error is " + error);
    } else {
        let str = value;
    }
});

getPluralStringByName9+

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

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

系统能力 ：SystemCapability.Global.ResourceManager

参数：

返回值：

示例：

resourceManager.getPluralStringByName("test", 1).then(value = > {
    let str = value;
}).catch(error = > {
    console.log("getPluralStringByName promise error is " + error);
});

getStringSync9+

getStringSync(resId: number): string

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

系统能力 ：SystemCapability.Global.ResourceManager

参数：

返回值：

示例：

resourceManager.getStringSync($r('app.string.test').id);

getStringByNameSync9+

getStringByNameSync(resName: string): string

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

系统能力 ：SystemCapability.Global.ResourceManager

参数：

返回值：

示例：

resourceManager.getStringByNameSync("test");

getBoolean9+

getBoolean(resId: number): boolean

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

系统能力 ：SystemCapability.Global.ResourceManager

参数：

返回值：

示例：

resourceManager.getBoolean($r('app.boolean.boolean_test').id);

getBooleanByName9+

getBooleanByName(resName: string): boolean

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

系统能力 ：SystemCapability.Global.ResourceManager

参数：

返回值：

示例：

resourceManager.getBooleanByName("boolean_test");

getNumber9+

getNumber(resId: number): number

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

系统能力 ：SystemCapability.Global.ResourceManager

参数：

返回值：

示例：

resourceManager.getNumber($r('app.integer.integer_test').id);
resourceManager.getNumber($r('app.float.float_test').id);

getNumberByName9+

getNumberByName(resName: string): number

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

系统能力 ：SystemCapability.Global.ResourceManager

参数：

返回值：

示例：

resourceManager.getNumberByName("integer_test");
resourceManager.getNumberByName("float_test");

审核编辑 黄宇