Resource Management

The resource management module provides APIs to obtain information about the current device configuration (including the language, region, screen direction, and MCC/MNC) and device capability (including the device type and resolution).

NOTE
The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

import resourceManager from '@ohos.resourceManager';

Usage

Since API version 9, the stage model allows an application to obtain a ResourceManager object based on context and call its APIs without first importing the required bundle. This method, however, is not applicable to the FA model.

this.context.resourceManager;

resourceManager.getResourceManager

getResourceManager(callback: AsyncCallback<ResourceManager>): void

Obtains the ResourceManager object of this application. This API uses an asynchronous callback to return the result.

This API is used only in the FA model.

System capability: SystemCapability.Global.ResourceManager

Parameters

Example

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<ResourceManager>): void

Obtains the ResourceManager object of an application based on the specified bundle name. This API uses an asynchronous callback to return the result.

This API is used only in the FA model.

System capability: SystemCapability.Global.ResourceManager

Parameters

Example

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

resourceManager.getResourceManager

getResourceManager(): Promise<ResourceManager>

Obtains the ResourceManager object of this application. This API uses a promise to return the result.

This API is used only in the FA model.

System capability: SystemCapability.Global.ResourceManager

Return value

Example

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<ResourceManager>

Obtains the ResourceManager object of an application based on the specified bundle name. This API uses a promise to return the result.

This API is used only in the FA model.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Example

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

}).catch(error => {

});

Direction

Enumerates the screen directions.

System capability: SystemCapability.Global.ResourceManager

DeviceType

Enumerates the device types.

System capability: SystemCapability.Global.ResourceManager

ScreenDensity

Enumerates the screen density types.

System capability: SystemCapability.Global.ResourceManager

Configuration

Defines the device configuration.

System capability: SystemCapability.Global.ResourceManager

Example

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

DeviceCapability

Defines the device capability.

System capability: SystemCapability.Global.ResourceManager

Example

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

RawFileDescriptor⁸⁺

Defines the descriptor information of the raw file.
System capability: SystemCapability.Global.ResourceManager

ResourceManager

Defines the capability of accessing application resources.

NOTE

• The methods involved in ResourceManager are applicable only to the TypeScript-based declarative development paradigm.

• Resource files are defined in the resources directory of the project. You can obtain the resource ID using $r(resource address).id, for example, $r('app.string.test').id.

getString

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

Obtains the string corresponding to the specified resource ID. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Example

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<string>

Obtains the string corresponding to the specified resource ID. This API uses a promise to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Example

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<Array<string>>): void

Obtains the string array corresponding to the specified resource ID. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Example

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<Array<string>>

Obtains the string array corresponding to the specified resource ID. This API uses a promise to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Example

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<Uint8Array>): void

Obtains the content of the media file corresponding to the specified resource ID. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Example

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<Uint8Array>

Obtains the content of the media file corresponding to the specified resource ID. This API uses a promise to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Example

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<string>): void

Obtains the Base64 code of the image corresponding to the specified resource ID. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Example

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<string>

Obtains the Base64 code of the image corresponding to the specified resource ID. This API uses a promise to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Example

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<Configuration>): void

Obtains the device configuration. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Example

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>

Obtains the device configuration. This API uses a promise to return the result.

System capability: SystemCapability.Global.ResourceManager

Return value

Example

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<DeviceCapability>): void

Obtains the device capability. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Example

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>

Obtains the device capability. This API uses a promise to return the result.

System capability: SystemCapability.Global.ResourceManager

Return value

Example

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<string>): void

Obtains the specified number of singular-plural strings corresponding to the specified resource ID. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Example

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<string>

Obtains the specified number of singular-plural strings corresponding to the specified resource ID. This API uses a promise to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Example

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

getRawFile⁸⁺

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

Obtains the content of the raw file in the resources/rawfile directory. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Example

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

getRawFile⁸⁺

getRawFile(path: string): Promise<Uint8Array>

Obtains the content of the raw file in the resources/rawfile directory. This API uses a promise to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Example

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

getRawFileDescriptor⁸⁺

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

Obtains the descriptor of the raw file in the resources/rawfile directory. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Example

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⁸⁺

getRawFileDescriptor(path: string): Promise<RawFileDescriptor>

Obtains the descriptor of the raw file in the resources/rawfile directory. This API uses a promise to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Example

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

closeRawFileDescriptor⁸⁺

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

Closes the descriptor of the raw file in the resources/rawfile directory. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Example

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

closeRawFileDescriptor⁸⁺

closeRawFileDescriptor(path: string): Promise<void>

Closes the descriptor of the raw file in the resources/rawfile directory. This API uses a promise to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Example

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

release⁷⁺

release()

Releases the created resourceManager.

System capability: SystemCapability.Global.ResourceManager

Example

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

getStringByName⁹⁺

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

Obtains the string corresponding to the specified resource name. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Example

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

getStringByName⁹⁺

getStringByName(resName: string): Promise<string>

Obtains the string corresponding to the specified resource name. This API uses a promise to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Example

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

getStringArrayByName⁹⁺

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

Obtains the string array corresponding to the specified resource name. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Example

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

getStringArrayByName⁹⁺

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

Obtains the string array corresponding to the specified resource name. This API uses a promise to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Example

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

getMediaByName⁹⁺

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

Obtains the content of the media file corresponding to the specified resource name. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Example

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

getMediaByName⁹⁺

getMediaByName(resName: string): Promise<Uint8Array>

Obtains the content of the media file corresponding to the specified resource name. This API uses a promise to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Example

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

getMediaBase64ByName⁹⁺

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

Obtains the Base64 code of the image corresponding to the specified resource name. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Example

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

getMediaBase64ByName⁹⁺

getMediaBase64ByName(resName: string): Promise<string>

Obtains the Base64 code of the image corresponding to the specified resource name. This API uses a promise to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Example

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

getPluralStringByName⁹⁺

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

Obtains the plural string corresponding to the specified resource name. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Example

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

getPluralStringByName⁹⁺

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

Obtains the plural string corresponding to the specified resource name. This API uses a promise to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Example

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

getStringSync⁹⁺

getStringSync(resId: number): string

Obtains the string corresponding to the specified resource ID. This API returns the result synchronously.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Example

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

getStringByNameSync⁹⁺

getStringByNameSync(resName: string): string

Obtains the string corresponding to the specified resource name. This API returns the result synchronously.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Example

resourceManager.getStringByNameSync("test");

getBoolean⁹⁺

getBoolean(resId: number): boolean

Obtains the Boolean result corresponding to the specified resource ID. This API returns the result synchronously.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Example

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

getBooleanByName⁹⁺

getBooleanByName(resName: string): boolean

Obtains the Boolean result corresponding to the specified resource name. This API returns the result synchronously.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Example

resourceManager.getBooleanByName("boolean_test");

getNumber⁹⁺

getNumber(resId: number): number

Obtains the integer or float value corresponding to the specified resource ID. This API returns the result synchronously.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Example

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

getNumberByName⁹⁺

getNumberByName(resName: string): number

Obtains the integer or float value corresponding to the specified resource name. This API returns the result synchronously.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Example

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