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';

resourceManager.getResourceManager

getResourceManager(callback: AsyncCallback<ResourceManager>): void

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

System capability: SystemCapability.Global.ResourceManager

Parameters

Example

resourceManager.getResourceManager((error, mgr) => {
    if (error != null) {
        console.log("error occurs" + error);
        return; 
    }
    mgr.getString(0x1000000, (error, value) => {
        if (error != null) {
            console.log(value);
        } else {
            console.log(value);
        }
    });
});

resourceManager.getResourceManager

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

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

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.

System capability: SystemCapability.Global.ResourceManager

Return value

Example

resourceManager.getResourceManager().then(mgr => {
    mgr.getString(0x1000000, (error, value) => {
        if (error != null) {
            console.log(value);
        } else {
            console.log(value);
        }
    });
}).catch(error => {
    console.log(error);
});

resourceManager.getResourceManager

getResourceManager(bundleName: string): Promise<ResourceManager>

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

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) => {
        console.log(value.direction);
        console.log(value.locale);
    });
});

DeviceCapability

Defines the device capability.

System capability: SystemCapability.Global.ResourceManager

Example

resourceManager.getResourceManager((error, mgr) => {
    mgr.getDeviceCapability((error, value) => {
        console.log(value.screenDensity);
        console.log(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(value);
        } else {
            console.log(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 => {
        console.log(value);
    }).catch(error => {
        console.log("getstring promise " + error);
    });
});

getStringArray

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

Obtains the array of 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.getStringArray($r('app.strarray.test').id, (error, value) => {
        if (error != null) {
            console.log(value);
        } else {
            console.log(value);
        }
    });
});

getStringArray

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

Obtains the array of 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.getStringArray($r('app.strarray.test').id).then(value => {
        console.log(value);
    }).catch(error => {
        console.log("getstring promise " + 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(value);
        } else {
            console.log(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 => {
        console.log(value);
    }).catch(error => {
        console.log("getstring promise " + 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(value);
        } else {
            console.log(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 => {
        console.log(value);
    }).catch(error => {
        console.log("getstring promise " + 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(value);
        } else {
            console.log(value);
        }
    });
});

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 => {
        console.log(value);
    }).catch(error => {
        console.log("getstring promise " + 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(value);
        } else {
            console.log(value);
        }
    });
});

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 => {
        console.log(value);
    }).catch(error => {
        console.log("getstring promise " + 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(value);
        } else {
            console.log(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 => {
        console.log(value);
    }).catch(error => {
        console.log("getstring promise " + error);
    });
});

getRawFile⁸⁺

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

Obtains the content of rawfile in the specified path. 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(value);
        } else {
            console.log(value);
        }
    });
});

getRawFile⁸⁺

getRawFile(path: string): Promise<Uint8Array>

Obtains the content of the raw file in the specified path. 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 => {
        console.log(value);
    }).catch(error => {
        console.log("getrawfile promise " + error);
    });
});

getRawFileDescriptor⁸⁺

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

Obtains the descriptor of the raw file in the specified path. 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(value);
        } 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 specified path. 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);
    });
});

closeRawFileDescriptor⁸⁺

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

Closes the descriptor of the raw file in the specified path. 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(value);
        }
    });
});

closeRawFileDescriptor⁸⁺

closeRawFileDescriptor(path: string): Promise<void>

Closes the descriptor of the raw file in the specified path. 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 => {
        console.log(value);
    }).catch(error => {
        console.log("closeRawFileDescriptor promise " + error);
    });
});

release⁷⁺

release()

Releases the created resourceManager.

System capability: SystemCapability.Global.ResourceManager

Example

resourceManager.getResourceManager((error, mgr) => {
    mgr.release((error, value) => {
        if (error != null) {
            console.log(value);
        }
    });
});