@ohos.resourceManager (Resource Management)

The resourceManager module provides APIs to obtain information about application resources based on the current configuration, including the language, region, screen direction, MCC/MNC, as well as device capability and density.

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

How to Use

Since API version 9, the stage model allows an application to obtain a ResourceManager object based on context and call its resource management APIs without first importing the required bundle. This approach, however, is not applicable to the FA model. For the FA model, you need to import the required bundle and then call the getResourceManager API to obtain a ResourceManager object. For details about how to reference context in the stage model, see Context in the Stage Model.

import UIAbility from '@ohos.app.ability.UIAbility';
import window from '@ohos.window';

export default class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage: window.WindowStage) {
    let context = this.context;
    let resourceManager = 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.

System capability: SystemCapability.Global.ResourceManager

Model restriction: This API can be used only in the FA model.

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<ResourceManager>	Yes	Callback used to return the result.

Example

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

NOTE
In the sample code, 0x1000000 indicates the resource ID, which can be found in the compiled ResourceTable.txt file.

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.

System capability: SystemCapability.Global.ResourceManager

Model restriction: This API can be used only in the FA model.

Parameters

Name	Type	Mandatory	Description
bundleName	string	Yes	Bundle name of the application.
callback	AsyncCallback<ResourceManager>	Yes	Callback used to return the result.

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

Model restriction: This API can be used only in the FA model.

Return value

Type	Description
Promise<ResourceManager>	Promise used to return the result.

Example

import resourceManager from '@ohos.resourceManager';
import { BusinessError } from '@ohos.base';

resourceManager.getResourceManager().then((mgr: resourceManager.ResourceManager) => {
  mgr.getStringValue(0x1000000, (error, value) => {
    if (error != null) {
      console.log("error is " + error);
    } else {
      let str = value;
    }
  });
}).catch((error: BusinessError) => {
  console.log("error is " + error);
});

NOTE
In the sample code, 0x1000000 indicates the resource ID, which can be found in the compiled ResourceTable.txt file.

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.

System capability: SystemCapability.Global.ResourceManager

Model restriction: This API can be used only in the FA model.

Parameters

Name	Type	Mandatory	Description
bundleName	string	Yes	Bundle name of the application.

Return value

Type	Description
Promise<ResourceManager>	Promise used to return the result.

Example

import resourceManager from '@ohos.resourceManager';
import { BusinessError } from '@ohos.base';

resourceManager.getResourceManager("com.example.myapplication").then((mgr: resourceManager.ResourceManager) => {
}).catch((error: BusinessError) => {
});

resourceManager.getSystemResourceManager¹⁰⁺

getSystemResourceManager(): ResourceManager

Obtains a ResourceManager object.

System capability: SystemCapability.Global.ResourceManager

Return value

Type	Description
Resourcemanager	ResourceManager object.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001009	If application can't access system resource.

Example

import resourceManager from '@ohos.resourceManager';
import { BusinessError } from '@ohos.base';

try {
  let systemResourceManager = resourceManager.getSystemResourceManager();
  systemResourceManager.getStringValue($r('sys.string.ohos_lab_vibrate').id).then((value: string) => {
    let str = value;
  }).catch((error: BusinessError) => {
    console.log("systemResourceManager getStringValue promise error is " + error);
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`systemResourceManager getStringValue failed, error code: ${code}, message: ${message}.`);
}

Direction

Enumerates the screen directions.

System capability: SystemCapability.Global.ResourceManager

Name	Value	Description
DIRECTION_VERTICAL	0	Portrait.
DIRECTION_HORIZONTAL	1	Landscape.

DeviceType

Enumerates the device types.

System capability: SystemCapability.Global.ResourceManager

Name	Value	Description
DEVICE_TYPE_TABLET	0x01	Tablet.
DEVICE_TYPE_CAR	0x02	Head unit.
DEVICE_TYPE_TV	0x04	TV.
DEVICE_TYPE_WEARABLE	0x06	Wearable.

ScreenDensity

Enumerates the screen density types.

System capability: SystemCapability.Global.ResourceManager

Name	Value	Description
SCREEN_SDPI	120	Screen density with small-scale dots per inch (SDPI).
SCREEN_MDPI	160	Screen density with medium-scale dots per inch (MDPI).
SCREEN_LDPI	240	Screen density with large-scale dots per inch (LDPI).
SCREEN_XLDPI	320	Screen density with extra-large-scale dots per inch (XLDPI).
SCREEN_XXLDPI	480	Screen density with extra-extra-large-scale dots per inch (XXLDPI).
SCREEN_XXXLDPI	640	Screen density with extra-extra-extra-large-scale dots per inch (XXXLDPI).

Configuration

Defines the device configuration.

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Readable	Writable	Description
direction	Direction	Yes	No	Screen direction of the device.
locale	string	Yes	No	Current system language.

DeviceCapability

Defines the device capability.

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Readable	Writable	Description
screenDensity	ScreenDensity	Yes	No	Screen density of the device.
deviceType	DeviceType	Yes	No	Device type.

RawFileDescriptor⁸⁺

Defines the descriptor of the raw file.

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Readable	Writable	Description
fd	number	Yes	No	File descriptor of the HAP where the raw file is located.
offset	number	Yes	No	Start offset of the raw file.
length	number	Yes	No	Length of the raw file.

Resource⁹⁺

Defines the resource information of an application.

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Readable	Writable	Description
bundleName	string	Yes	No	Bundle name of the application.
moduleName	string	Yes	No	Module name of the application.
id	number	Yes	No	Resource ID.
params	any[]	Yes	No	Other resource parameters, which are optional.
type	number	Yes	No	Resource type, which is optional.

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.

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

Name	Type	Mandatory	Description
resId	number	Yes	Resource ID.

Return value

Type	Description
string	String corresponding to the specified resource ID.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.
9001006	If the resource re-ref too much.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getStringSync($r('app.string.test').id);
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getStringSync failed, error code: ${code}, message: ${message}.`);
}

getStringSync¹⁰⁺

getStringSync(resId: number, ...args: Array<string|number>): string

Obtains the string corresponding to the specified resource ID and formats the string based on args. This API returns the result synchronously.

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resId	number	Yes	Resource ID.
args	Array<string |number>	No	Arguments for formatting strings. Supported arguments: %d, %f, %s, and %% Note: %% is used to translate %. Example: %%d is translated into the %d string.

Return value

Type	Description
string	Formatted string.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
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.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getStringSync($r('app.string.test').id, "format string", 10, 98.78);
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getStringSync failed, error code: ${code}, message: ${message}.`);
}

getStringSync⁹⁺

getStringSync(resource: Resource): string

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

System capability: SystemCapability.Global.ResourceManager

Model restriction: This API can be used only in the stage model.

Parameters

Name	Type	Mandatory	Description
resource	Resource	Yes	Resource object.

Return value

Type	Description
string	String corresponding to the specified resource object.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.
9001006	If the resource re-ref too much.

Example

import resourceManager from '@ohos.resourceManager';
import { BusinessError } from '@ohos.base';

let resource: resourceManager.Resource = {
  bundleName: "com.example.myapplication",
  moduleName: "entry",
  id: $r('app.string.test').id
};
try {
  this.context.resourceManager.getStringSync(resource);
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getStringSync failed, error code: ${code}, message: ${message}.`);
}

getStringSync¹⁰⁺

getStringSync(resource: Resource, ...args: Array<string|number>): string

Obtains the string corresponding to the specified resource object and formats the string based on args. This API returns the result synchronously.

System capability: SystemCapability.Global.ResourceManager

Model restriction: This API can be used only in the stage model.

Parameters

Name	Type	Mandatory	Description
resource	Resource	Yes	Resource object.
args	Array<string |number>	No	Arguments for formatting strings. Supported arguments: %d, %f, %s, and %% Note: %% is used to translate %. Example: %%d is translated into the %d string.

Return value

Type	Description
string	Formatted string.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
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.

Example

import resourceManager from '@ohos.resourceManager';
import { BusinessError } from '@ohos.base';

let resource: resourceManager.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) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getStringSync failed, error code: ${code}, message: ${message}.`);
}

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

Name	Type	Mandatory	Description
resName	string	Yes	Resource name.

Return value

Type	Description
string	String corresponding to the specified resource name.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001003	If the resName invalid.
9001004	If the resource not found by resName.
9001006	If the resource re-ref too much.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getStringByNameSync("test");
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getStringByNameSync failed, error code: ${code}, message: ${message}.`);
}

getStringByNameSync¹⁰⁺

getStringByNameSync(resName: string, ...args: Array<string|number>): string

Obtains the string corresponding to the specified resource name and formats the string based on args. This API returns the result synchronously.

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resName	string	Yes	Resource name.
args	Array<string |number>	No	Arguments for formatting strings. Supported arguments: %d, %f, %s, and %% Note: %% is used to translate %. Example: %%d is translated into the %d string.

Return value

Type	Description
string	Formatted string.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
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.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getStringByNameSync("test", "format string", 10, 98.78);
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getStringByNameSync failed, error code: ${code}, message: ${message}.`);
}

getStringValue⁹⁺

getStringValue(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

Name	Type	Mandatory	Description
resId	number	Yes	Resource ID.
callback	AsyncCallback<string>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the module resId invalid.
9001002	If the resource not found by resId.
9001006	If the resource re-ref too much.

Example (stage)

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getStringValue($r('app.string.test').id, (error, value) => {
    if (error != null) {
      console.log("error is " + error);
    } else {
      let str = value;
    }
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`callback getStringValue failed, error code: ${code}, message: ${message}.`);
}

getStringValue⁹⁺

getStringValue(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

Name	Type	Mandatory	Description
resId	number	Yes	Resource ID.

Return value

Type	Description
Promise<string>	Promise used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.
9001006	If the resource re-ref too much.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getStringValue($r('app.string.test').id).then((value: string) => {
    let str = value;
  }).catch((error: BusinessError) => {
    console.log("getStringValue promise error is " + error);
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`promise getStringValue failed, error code: ${code}, message: ${message}.`);
}

getStringValue⁹⁺

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

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

System capability: SystemCapability.Global.ResourceManager

Model restriction: This API can be used only in the stage model.

Parameters

Name	Type	Mandatory	Description
resource	Resource	Yes	Resource object.
callback	AsyncCallback<string>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.
9001006	If the resource re-ref too much.

Example

import resourceManager from '@ohos.resourceManager';
import { BusinessError } from '@ohos.base';

let resource: resourceManager.Resource = {
  bundleName: "com.example.myapplication",
  moduleName: "entry",
  id: $r('app.string.test').id
};
try {
  this.context.resourceManager.getStringValue(resource, (error, value) => {
    if (error != null) {
      console.log("error is " + error);
    } else {
      let str = value;
    }
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`callback getStringValue failed, error code: ${code}, message: ${message}.`);
}

getStringValue⁹⁺

getStringValue(resource: Resource): Promise<string>

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

System capability: SystemCapability.Global.ResourceManager

Model restriction: This API can be used only in the stage model.

Parameters

Name	Type	Mandatory	Description
resource	Resource	Yes	Resource object.

Return value

Type	Description
Promise<string>	Promise used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.
9001006	If the resource re-ref too much.

Example

import resourceManager from '@ohos.resourceManager';
import { BusinessError } from '@ohos.base';

let resource: resourceManager.Resource = {
  bundleName: "com.example.myapplication",
  moduleName: "entry",
  id: $r('app.string.test').id
};
try {
  this.context.resourceManager.getStringValue(resource).then((value: string) => {
    let str = value;
  }).catch((error: BusinessError) => {
    console.log("getStringValue promise error is " + error);
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`promise getStringValue failed, error code: ${code}, message: ${message}.`);
}

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

Name	Type	Mandatory	Description
resName	string	Yes	Resource name.
callback	AsyncCallback<string>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001003	If the resName invalid.
9001004	If the resource not found by resName.
9001006	If the resource re-ref too much.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getStringByName("test", (error, value) => {
    if (error != null) {
      console.log("error is " + error);
    } else {
      let str = value;
    }
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`callback getStringByName failed, error code: ${code}, message: ${message}.`);
}

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

Name	Type	Mandatory	Description
resName	string	Yes	Resource name.

Return value

Type	Description
Promise<string>	Promise used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001003	If the resName invalid.
9001004	If the resource not found by resName.
9001006	If the resource re-ref too much.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getStringByName("test").then((value: string) => {
    let str = value;
  }).catch((error: BusinessError) => {
    console.log("getStringByName promise error is " + error);
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`promise getStringByName failed, error code: ${code}, message: ${message}.`);
}

getStringArrayValueSync¹⁰⁺

getStringArrayValueSync(resId: number): Array<string>

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

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resId	number	Yes	Resource ID.

Return value

Type	Description
Array<string>	String array corresponding to the specified resource ID.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.
9001006	If the resource re-ref too much.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getStringArrayValueSync($r('app.strarray.test').id);
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getStringArrayValueSync failed, error code: ${code}, message: ${message}.`);
}

getStringArrayValueSync¹⁰⁺

getStringArrayValueSync(resource: Resource): Array<string>

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

System capability: SystemCapability.Global.ResourceManager

Model restriction: This API can be used only in the stage model.

Parameters

Name	Type	Mandatory	Description
resource	Resource	Yes	Resource object.

Return value

Type	Description
Array<string>	String array corresponding to the specified resource object.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.
9001006	If the resource re-ref too much.

Example

import resourceManager from '@ohos.resourceManager';
import { BusinessError } from '@ohos.base';

let resource: resourceManager.Resource = {
  bundleName: "com.example.myapplication",
  moduleName: "entry",
  id: $r('app.strarray.test').id
};
try {
  this.context.resourceManager.getStringArrayValueSync(resource);
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getStringArrayValueSync failed, error code: ${code}, message: ${message}.`);
}

getStringArrayByNameSync¹⁰⁺

getStringArrayByNameSync(resName: string): Array<string>

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

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resName	string	Yes	Resource name.

Return value

Type	Description
Array<string>	String array corresponding to the specified resource name.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001003	If the resName invalid.
9001004	If the resource not found by resName.
9001006	If the resource re-ref too much.

Example

try {
  this.context.resourceManager.getStringArrayByNameSync("test");
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getStringArrayByNameSync failed, error code: ${code}, message: ${message}.`);
}

getStringArrayValue⁹⁺

getStringArrayValue(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

Name	Type	Mandatory	Description
resId	number	Yes	Resource ID.
callback	AsyncCallback<Array<string>>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.
9001006	If the resource re-ref too much.

Example

import { BusinessError } from '@ohos.base';

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) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`callback getStringArrayValue failed, error code: ${code}, message: ${message}.`);
}

getStringArrayValue⁹⁺

getStringArrayValue(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

Name	Type	Mandatory	Description
resId	number	Yes	Resource ID.

Return value

Type	Description
Promise<Array<string>>	Promise used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.
9001006	If the resource re-ref too much.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getStringArrayValue($r('app.strarray.test').id).then((value: Array<string>) => {
    let strArray = value;
  }).catch((error: BusinessError) => {
    console.log("getStringArrayValue promise error is " + error);
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`promise getStringArrayValue failed, error code: ${code}, message: ${message}.`);
}

getStringArrayValue⁹⁺

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

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

System capability: SystemCapability.Global.ResourceManager

Model restriction: This API can be used only in the stage model.

Parameters

Name	Type	Mandatory	Description
resource	Resource	Yes	Resource object.
callback	AsyncCallback<Array<string>>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.
9001006	If the resource re-ref too much.

Example

import resourceManager from '@ohos.resourceManager';
import { BusinessError } from '@ohos.base';

let resource: resourceManager.Resource = {
  bundleName: "com.example.myapplication",
  moduleName: "entry",
  id: $r('app.strarray.test').id
};
try {
  this.context.resourceManager.getStringArrayValue(resource, (error, value) => {
    if (error != null) {
      console.log("error is " + error);
    } else {
      let strArray = value;
    }
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`callback getStringArrayValue failed, error code: ${code}, message: ${message}.`);
}

getStringArrayValue⁹⁺

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

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

System capability: SystemCapability.Global.ResourceManager

Model restriction: This API can be used only in the stage model.

Parameters

Name	Type	Mandatory	Description
resource	Resource	Yes	Resource object.

Return value

Type	Description
Promise<Array<string>>	Promise used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.
9001006	If the resource re-ref too much.

Example

import resourceManager from '@ohos.resourceManager';
import { BusinessError } from '@ohos.base';

let resource: resourceManager.Resource = {
  bundleName: "com.example.myapplication",
  moduleName: "entry",
  id: $r('app.strarray.test').id
};
try {
  this.context.resourceManager.getStringArrayValue(resource).then((value: Array<string>) => {
    let strArray = value;
  }).catch((error: BusinessError) => {
    console.log("getStringArray promise error is " + error);
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`promise getStringArrayValue failed, error code: ${code}, message: ${message}.`);
}

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

Name	Type	Mandatory	Description
resName	string	Yes	Resource name.
callback	AsyncCallback<Array<string>>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001003	If the resName invalid.
9001004	If the resource not found by resName.
9001006	If the resource re-ref too much.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getStringArrayByName("test", (error, value) => {
    if (error != null) {
      console.log("error is " + error);
    } else {
      let strArray = value;
    }
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`callback getStringArrayByName failed, error code: ${code}, message: ${message}.`);
}

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

Name	Type	Mandatory	Description
resName	string	Yes	Resource name.

Return value

Type	Description
Promise<Array<string>>	Promise used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001003	If the resName invalid.
9001004	If the resource not found by resName.
9001006	If the resource re-ref too much.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getStringArrayByName("test").then((value: Array<string>) => {
    let strArray = value;
  }).catch((error: BusinessError) => {
    console.log("getStringArrayByName promise error is " + error);
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`promise getStringArrayByName failed, error code: ${code}, message: ${message}.`);
}

getPluralStringValueSync¹⁰⁺

getPluralStringValueSync(resId: number, num: number): string

Obtains the singular-plural string corresponding to the specified resource ID based on the specified number. This API returns the result synchronously.

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resId	number	Yes	Resource ID.
num	number	Yes	Number.

Return value

Type	Description
string	Singular-plural string corresponding to the specified resource ID.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.
9001006	If the resource re-ref too much.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getPluralStringValueSync($r('app.plural.test').id, 1);
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getPluralStringValueSync failed, error code: ${code}, message: ${message}.`);
}

getPluralStringValueSync¹⁰⁺

getPluralStringValueSync(resource: Resource, num: number): string

Obtains the singular-plural string corresponding to the specified resource object based on the specified number. This API returns the result synchronously.

System capability: SystemCapability.Global.ResourceManager

Model restriction: This API can be used only in the stage model.

Parameters

Name	Type	Mandatory	Description
resource	Resource	Yes	Resource object.
num	number	Yes	Number.

Return value

Type	Description
string	Singular-plural string corresponding to the specified resource object.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.
9001006	If the resource re-ref too much.

Example

import resourceManager from '@ohos.resourceManager';
import { BusinessError } from '@ohos.base';

let resource: resourceManager.Resource = {
  bundleName: "com.example.myapplication",
  moduleName: "entry",
  id: $r('app.plural.test').id
};
try {
  this.context.resourceManager.getPluralStringValueSync(resource, 1);
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getPluralStringValueSync failed, error code: ${code}, message: ${message}.`);
}

getPluralStringByNameSync¹⁰⁺

getPluralStringByNameSync(resName: string, num: number): string

Obtains the singular-plural string corresponding to the specified resource name based on the specified number. This API returns the result synchronously.

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resName	string	Yes	Resource name.
num	number	Yes	Number.

Return value

Type	Description
string	Singular-plural string corresponding to the specified resource name.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001003	If the resName invalid.
9001004	If the resource not found by resName.
9001006	If the resource re-ref too much.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getPluralStringByNameSync("test", 1);
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getPluralStringByNameSync failed, error code: ${code}, message: ${message}.`);
}

getPluralStringValue⁹⁺

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

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

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resId	number	Yes	Resource ID.
num	number	Yes	Number.
callback	AsyncCallback<string>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.
9001006	If the resource re-ref too much.

Example

import { BusinessError } from '@ohos.base';

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) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`callback getPluralStringValue failed, error code: ${code}, message: ${message}.`);
}

getPluralStringValue⁹⁺

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

Obtains the singular-plural string corresponding to the specified resource ID based on the specified number. This API uses a promise to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resId	number	Yes	Resource ID.
num	number	Yes	Number.

Return value

Type	Description
Promise<string>	Promise used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.
9001006	If the resource re-ref too much.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getPluralStringValue($r("app.plural.test").id, 1).then((value: string) => {
    let str = value;
  }).catch((error: BusinessError) => {
    console.log("getPluralStringValue promise error is " + error);
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`promise getPluralStringValue failed, error code: ${code}, message: ${message}.`);
}

getPluralStringValue⁹⁺

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

Obtains the singular-plural string corresponding to the specified resource object based on the specified number. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Global.ResourceManager

Model restriction: This API can be used only in the stage model.

Parameters

Name	Type	Mandatory	Description
resource	Resource	Yes	Resource object.
num	number	Yes	Number.
callback	AsyncCallback<string>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.
9001006	If the resource re-ref too much.

Example

import resourceManager from '@ohos.resourceManager';
import { BusinessError } from '@ohos.base';

let resource: resourceManager.Resource = {
  bundleName: "com.example.myapplication",
  moduleName: "entry",
  id: $r('app.plural.test').id
};
try {
  this.context.resourceManager.getPluralStringValue(resource, 1, (error, value) => {
    if (error != null) {
      console.log("error is " + error);
    } else {
      let str = value;
    }
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`callback getPluralStringValue failed, error code: ${code}, message: ${message}.`);
}

getPluralStringValue⁹⁺

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

Obtains the singular-plural string corresponding to the specified resource object based on the specified number. This API uses a promise to return the result.

System capability: SystemCapability.Global.ResourceManager

Model restriction: This API can be used only in the stage model.

Parameters

Name	Type	Mandatory	Description
resource	Resource	Yes	Resource object.
num	number	Yes	Number.

Return value

Type	Description
Promise<string>	Promise used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.
9001006	If the resource re-ref too much.

Example

import resourceManager from '@ohos.resourceManager';
import { BusinessError } from '@ohos.base';

let resource: resourceManager.Resource = {
  bundleName: "com.example.myapplication",
  moduleName: "entry",
  id: $r('app.plural.test').id
};
try {
  this.context.resourceManager.getPluralStringValue(resource, 1).then((value: string) => {
    let str = value;
  }).catch((error: BusinessError) => {
    console.log("getPluralStringValue promise error is " + error);
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`promise getPluralStringValue failed, error code: ${code}, message: ${message}.`);
}

getPluralStringByName⁹⁺

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

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

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resName	string	Yes	Resource name.
num	number	Yes	Number.
callback	AsyncCallback<string>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001003	If the resName invalid.
9001004	If the resource not found by resName.
9001006	If the resource re-ref too much.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getPluralStringByName("test", 1, (error, value) => {
    if (error != null) {
      console.log("error is " + error);
    } else {
      let str = value;
    }
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`callback getPluralStringByName failed, error code: ${code}, message: ${message}.`);
}

getPluralStringByName⁹⁺

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

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

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resName	string	Yes	Resource name.
num	number	Yes	Number.

Return value

Type	Description
Promise<string>	Promise used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001003	If the resName invalid.
9001004	If the resource not found by resName.
9001006	If the resource re-ref too much.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getPluralStringByName("test", 1).then((value: string) => {
    let str = value;
  }).catch((error: BusinessError) => {
    console.log("getPluralStringByName promise error is " + error);
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`promise getPluralStringByName failed, error code: ${code}, message: ${message}.`);
}

getMediaContentSync¹⁰⁺

getMediaContentSync(resId: number, density?: number): Uint8Array

Obtains the media file content (with the default or specified screen density) corresponding to the specified resource ID. This API returns the result synchronously.

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resId	number	Yes	Resource ID.
density	number	No	Screen density. The default value or value 0 indicates the default screen density.

Return value

Type	Description
Uint8Array	Media file content corresponding to the specified resource ID.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getMediaContentSync($r('app.media.test').id); // Default screen density
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getMediaContentSync failed, error code: ${code}, message: ${message}.`);
}

try {
  this.context.resourceManager.getMediaContentSync($r('app.media.test').id, 120); // Specified screen density
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getMediaContentSync failed, error code: ${code}, message: ${message}.`);
}

getMediaContentSync¹⁰⁺

getMediaContentSync(resource: Resource, density?: number): Uint8Array

Obtains the media file content (with the default or specified screen density) corresponding to the specified resource object. This API returns the result synchronously.

System capability: SystemCapability.Global.ResourceManager

Model restriction: This API can be used only in the stage model.

Parameters

Name	Type	Mandatory	Description
resource	Resource	Yes	Resource object.
density	number	No	Screen density. The default value or value 0 indicates the default screen density.

Return value

Type	Description
Uint8Array	Media file content corresponding to the specified resource object

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.

Example

import resourceManager from '@ohos.resourceManager';
import { BusinessError } from '@ohos.base';

let resource: resourceManager.Resource = {
  bundleName: "com.example.myapplication",
  moduleName: "entry",
  id: $r('app.media.test').id
};
try {
  this.context.resourceManager.getMediaContentSync(resource); // Default screen density
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getMediaContentSync failed, error code: ${code}, message: ${message}.`);
}

try {
  this.context.resourceManager.getMediaContentSync(resource, 120); // Specified screen density
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getMediaContentSync failed, error code: ${code}, message: ${message}.`);
}

getMediaByNameSync¹⁰⁺

getMediaByNameSync(resName: string, density?: number): Uint8Array

Obtains the media file content (with the default or specified screen density) corresponding to the specified resource name. This API returns the result synchronously.

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resName	string	Yes	Resource name.
density	number	No	Screen density. The default value or value 0 indicates the default screen density.

Return value

Type	Description
Uint8Array	Media file content corresponding to the resource name.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001003	If the resName invalid.
9001004	If the resource not found by resName.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getMediaByNameSync("test"); // Default screen density
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getMediaByNameSync failed, error code: ${code}, message: ${message}.`);
}

try {
  this.context.resourceManager.getMediaByNameSync("test", 120); // Specified screen density
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getMediaByNameSync failed, error code: ${code}, message: ${message}.`);
}

getMediaContent⁹⁺

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

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

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resId	number	Yes	Resource ID.
callback	AsyncCallback<Uint8Array>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.

Example

import { BusinessError } from '@ohos.base';

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) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`callback getMediaContent failed, error code: ${code}, message: ${message}.`);
}

getMediaContent¹⁰⁺

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

Obtains the media file content (with the specified screen density) corresponding to the specified resource ID. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resId	number	Yes	Resource ID.
density	number	Yes	Screen density. The value 0 indicates the default screen density.
callback	AsyncCallback<Uint8Array>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getMediaContent($r('app.media.test').id, 120, (error, value) => {
    if (error != null) {
      console.error(`callback getMediaContent failed, error code: ${error.code}, message: ${error.message}.`);
    } else {
      let media = value;
    }
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`callback getMediaContent failed, error code: ${code}, message: ${message}.`);
}

getMediaContent⁹⁺

getMediaContent(resId: number): Promise<Uint8Array>

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

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resId	number	Yes	Resource ID.

Return value

Type	Description
Promise<Uint8Array>	Promise used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getMediaContent($r('app.media.test').id).then((value: Uint8Array) => {
    let media = value;
  }).catch((error: BusinessError) => {
    console.log("getMediaContent promise error is " + error);
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`promise getMediaContent failed, error code: ${code}, message: ${message}.`);
}

getMediaContent¹⁰⁺

getMediaContent(resId: number, density: number): Promise<Uint8Array>

Obtains the media file content (with the specified screen density) corresponding to the specified resource ID. This API uses a promise to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resId	number	Yes	Resource ID.
density	number	Yes	Screen density. The value 0 indicates the default screen density.

Return value

Type	Description
Promise<Uint8Array>	Promise used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getMediaContent($r('app.media.test').id, 120).then((value: Uint8Array) => {
    let media = value;
  }).catch((error: BusinessError) => {
    console.error(`promise getMediaContent failed, error code: ${error.code}, message: ${error.message}.`);
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`promise getMediaContent failed, error code: ${code}, message: ${message}.`);
}

getMediaContent⁹⁺

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

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

System capability: SystemCapability.Global.ResourceManager

Model restriction: This API can be used only in the stage model.

Parameters

Name	Type	Mandatory	Description
resource	Resource	Yes	Resource object.
callback	AsyncCallback<Uint8Array>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.

Example

import resourceManager from '@ohos.resourceManager';
import { BusinessError } from '@ohos.base';

let resource: resourceManager.Resource = {
  bundleName: "com.example.myapplication",
  moduleName: "entry",
  id: $r('app.media.test').id
};
try {
  this.context.resourceManager.getMediaContent(resource, (error, value) => {
    if (error != null) {
      console.log("error is " + error);
    } else {
      let media = value;
    }
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`callback getMediaContent failed, error code: ${code}, message: ${message}.`);
}

getMediaContent¹⁰⁺

getMediaContent(resource: Resource, density: number, callback: AsyncCallback<Uint8Array>): void

Obtains the media file content (with the specified screen density) corresponding to the specified resource object. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Global.ResourceManager

Model restriction: This API can be used only in the stage model.

Parameters

Name	Type	Mandatory	Description
resource	Resource	Yes	Resource object.
density	number	Yes	Screen density. The value 0 indicates the default screen density.
callback	AsyncCallback<Uint8Array>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.

Example

import resourceManager from '@ohos.resourceManager';
import { BusinessError } from '@ohos.base';

let resource: resourceManager.Resource = {
  bundleName: "com.example.myapplication",
  moduleName: "entry",
  id: $r('app.media.test').id
};
try {
  this.context.resourceManager.getMediaContent(resource, 120, (error, value) => {
    if (error != null) {
      console.error(`callback getMediaContent failed, error code: ${error.code}, message: ${error.message}.`);
    } else {
      let media = value;
    }
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`callback getMediaContent failed, error code: ${code}, message: ${message}.`);
}

getMediaContent⁹⁺

getMediaContent(resource: Resource): Promise<Uint8Array>

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

System capability: SystemCapability.Global.ResourceManager

Model restriction: This API can be used only in the stage model.

Parameters

Name	Type	Mandatory	Description
resource	Resource	Yes	Resource object.

Return value

Type	Description
Promise<Uint8Array>	Promise used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.

Example

import resourceManager from '@ohos.resourceManager';
import { BusinessError } from '@ohos.base';

let resource: resourceManager.Resource = {
  bundleName: "com.example.myapplication",
  moduleName: "entry",
  id: $r('app.media.test').id
};
try {
  this.context.resourceManager.getMediaContent(resource).then((value: Uint8Array) => {
    let media = value;
  }).catch((error: BusinessError) => {
    console.log("getMediaContent promise error is " + error);
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`promise getMediaContent failed, error code: ${code}, message: ${message}.`);
}

getMediaContent¹⁰⁺

getMediaContent(resource: Resource, density: number): Promise<Uint8Array>

Obtains the media file content (with the specified screen density) corresponding to the specified resource object. This API uses a promise to return the result.

System capability: SystemCapability.Global.ResourceManager

Model restriction: This API can be used only in the stage model.

Parameters

Name	Type	Mandatory	Description
resource	Resource	Yes	Resource object.
density	number	Yes	Screen density. The value 0 indicates the default screen density.

Return value

Type	Description
Promise<Uint8Array>	Promise used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.

Example

import resourceManager from '@ohos.resourceManager';
import { BusinessError } from '@ohos.base';

let resource: resourceManager.Resource = {
  bundleName: "com.example.myapplication",
  moduleName: "entry",
  id: $r('app.media.test').id
};
try {
  this.context.resourceManager.getMediaContent(resource, 120).then((value: Uint8Array) => {
    let media = value;
  }).catch((error: BusinessError) => {
    console.error(`promise getMediaContent failed, error code: ${error.code}, message: ${error.message}.`);
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`promise getMediaContent failed, error code: ${code}, message: ${message}.`);
}

getMediaByName⁹⁺

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

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

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resName	string	Yes	Resource name.
callback	AsyncCallback<Uint8Array>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001003	If the resName invalid.
9001004	If the resource not found by resName.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getMediaByName("test", (error, value) => {
    if (error != null) {
      console.log("error is " + error);
    } else {
      let media = value;
    }
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`callback getMediaByName failed, error code: ${code}, message: ${message}.`);
}

getMediaByName¹⁰⁺

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

Obtains the media file content (with the specified screen density) corresponding to the specified resource ID. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resName	string	Yes	Resource name.
density	number	Yes	Screen density. The value 0 indicates the default screen density.
callback	AsyncCallback<Uint8Array>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001003	If the resName invalid.
9001004	If the resource not found by resName.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getMediaByName("test", 120, (error, value) => {
    if (error != null) {
      console.error(`callback getMediaByName failed, error code: ${error.code}, message: ${error.message}.`);
    } else {
      let media = value;
    }
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`callback getMediaByName failed, error code: ${code}, message: ${message}.`);
}

getMediaByName⁹⁺

getMediaByName(resName: string): Promise<Uint8Array>

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

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resName	string	Yes	Resource name.

Return value

Type	Description
Promise<Uint8Array>	Promise used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001003	If the resName invalid.
9001004	If the resource not found by resName.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getMediaByName("test").then((value: Uint8Array) => {
    let media = value;
  }).catch((error: BusinessError) => {
    console.log("getMediaByName promise error is " + error);
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`promise getMediaByName failed, error code: ${code}, message: ${message}.`);
}

getMediaByName¹⁰⁺

getMediaByName(resName: string, density: number): Promise<Uint8Array>

Obtains the media file content (with the specified screen density) corresponding to the specified resource name. This API uses a promise to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resName	string	Yes	Resource name.
density	number	Yes	Screen density. The value 0 indicates the default screen density.

Return value

Type	Description
Promise<Uint8Array>	Promise used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001003	If the resName invalid.
9001004	If the resource not found by resName.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getMediaByName("test", 120).then((value: Uint8Array) => {
    let media = value;
  }).catch((error: BusinessError) => {
    console.error(`promise getMediaByName failed, error code: ${error.code}, message: ${error.message}.`);
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`promise getMediaByName failed, error code: ${code}, message: ${message}.`);
}

getMediaContentBase64Sync¹⁰⁺

getMediaContentBase64Sync(resId: number, density?: number): string

Obtains the Base64 code of the image (with the default or specified screen density) corresponding to the specified resource ID.

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resId	number	Yes	Resource ID.
density	number	No	Screen density. The default value or value 0 indicates the default screen density.

Return value

Type	Description
string	Base64 code of the image corresponding to the specified resource ID.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getMediaContentBase64Sync($r('app.media.test').id); // Default screen density
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getMediaContentBase64Sync failed, error code: ${code}, message: ${message}.`);
}

try {
  this.context.resourceManager.getMediaContentBase64Sync($r('app.media.test').id, 120); // Specified screen density
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getMediaContentBase64Sync failed, error code: ${code}, message: ${message}.`);
}

getMediaContentBase64Sync¹⁰⁺

getMediaContentBase64Sync(resource: Resource, density?: number): string

Obtains the Base64 code of the image (with the default or specified screen density) corresponding to the specified resource object.

System capability: SystemCapability.Global.ResourceManager

Model restriction: This API can be used only in the stage model.

Parameters

Name	Type	Mandatory	Description
resource	Resource	Yes	Resource object.
density	number	No	Screen density. The default value or value 0 indicates the default screen density.

Return value

Type	Description
string	Base64 code of the media file corresponding to the specified resource object.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.

Example

import resourceManager from '@ohos.resourceManager';
import { BusinessError } from '@ohos.base';

let resource: resourceManager.Resource = {
  bundleName: "com.example.myapplication",
  moduleName: "entry",
  id: $r('app.media.test').id
};
try {
  this.context.resourceManager.getMediaContentBase64Sync(resource); // Default screen density
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getMediaContentBase64Sync failed, error code: ${code}, message: ${message}.`);
}

try {
  this.context.resourceManager.getMediaContentBase64Sync(resource, 120); // Specified screen density
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getMediaContentBase64Sync failed, error code: ${code}, message: ${message}.`);
}

getMediaBase64ByNameSync¹⁰⁺

getMediaBase64ByNameSync(resName: string, density?: number): string

Obtains the Base64 code of the image (with the default or specified screen density) corresponding to the specified resource name.

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resName	string	Yes	Resource name.
density	number	No	Screen density. The default value or value 0 indicates the default screen density.

Return value

Type	Description
string	Promise used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001003	If the resName invalid.
9001004	If the resource not found by resName.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getMediaBase64ByNameSync("test"); // Default screen density
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getMediaBase64ByNameSync failed, error code: ${code}, message: ${message}.`);
}

try {
  this.context.resourceManager.getMediaBase64ByNameSync("test", 120); // Specified screen density
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getMediaBase64ByNameSync failed, error code: ${code}, message: ${message}.`);
}

getMediaContentBase64⁹⁺

getMediaContentBase64(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

Name	Type	Mandatory	Description
resId	number	Yes	Resource ID.
callback	AsyncCallback<string>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getMediaContentBase64($r('app.media.test').id, (error, value) => {
    if (error != null) {
      console.log("error is " + error);
    } else {
      let media = value;
    }
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`callback getMediaContentBase64 failed, error code: ${code}, message: ${message}.`);
}

getMediaContentBase64¹⁰⁺

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

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

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resId	number	Yes	Resource ID.
density	number	Yes	Screen density. The value 0 indicates the default screen density.
callback	AsyncCallback<string>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getMediaContentBase64($r('app.media.test').id, 120, (error, value) => {
    if (error != null) {
      console.error(`callback getMediaContentBase64 failed, error code: ${error.code}, message: ${error.message}.`);
    } else {
      let media = value;
    }
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`callback getMediaContentBase64 failed, error code: ${code}, message: ${message}.`);
}

getMediaContentBase64⁹⁺

getMediaContentBase64(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

Name	Type	Mandatory	Description
resId	number	Yes	Resource ID.

Return value

Type	Description
Promise<string>	Promise used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getMediaContentBase64($r('app.media.test').id).then((value: string) => {
    let media = value;
  }).catch((error: BusinessError) => {
    console.log("getMediaContentBase64 promise error is " + error);
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`promise getMediaContentBase64 failed, error code: ${code}, message: ${message}.`);
}

getMediaContentBase64¹⁰⁺

getMediaContentBase64(resId: number, density: number): Promise<string>

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

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resId	number	Yes	Resource ID.
density	number	Yes	Screen density. The value 0 indicates the default screen density.

Return value

Type	Description
Promise<string>	Promise used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getMediaContentBase64($r('app.media.test').id, 120).then((value: string) => {
    let media = value;
  }).catch((error: BusinessError) => {
    console.error(`promise getMediaContentBase64 failed, error code: ${error.code}, message: ${error.message}.`);
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`promise getMediaContentBase64 failed, error code: ${code}, message: ${message}.`);
}

getMediaContentBase64⁹⁺

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

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

System capability: SystemCapability.Global.ResourceManager

Model restriction: This API can be used only in the stage model.

Parameters

Name	Type	Mandatory	Description
resource	Resource	Yes	Resource object.
callback	AsyncCallback<string>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.

Example

import resourceManager from '@ohos.resourceManager';
import { BusinessError } from '@ohos.base';

let resource: resourceManager.Resource = {
  bundleName: "com.example.myapplication",
  moduleName: "entry",
  id: $r('app.media.test').id
};
try {
  this.context.resourceManager.getMediaContentBase64(resource, (error, value) => {
    if (error != null) {
      console.log("error is " + error);
    } else {
      let media = value;
    }
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`callback getMediaContentBase64 failed, error code: ${code}, message: ${message}.`);
}

getMediaContentBase64¹⁰⁺

getMediaContentBase64(resource: Resource, density: number, callback: AsyncCallback<string>): void

Obtains the Base64 code of an image with the screen density corresponding to the specified resource object. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Global.ResourceManager

Model restriction: This API can be used only in the stage model.

Parameters

Name	Type	Mandatory	Description
resource	Resource	Yes	Resource object.
density	number	Yes	Screen density. The value 0 indicates the default screen density.
callback	AsyncCallback<string>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.

Example

import resourceManager from '@ohos.resourceManager';
import { BusinessError } from '@ohos.base';

let resource: resourceManager.Resource = {
  bundleName: "com.example.myapplication",
  moduleName: "entry",
  id: $r('app.media.test').id
};
try {
  this.context.resourceManager.getMediaContentBase64(resource, 120, (error, value) => {
    if (error != null) {
      console.error(`callback getMediaContentBase64 failed, error code: ${error.code}, message: ${error.message}.`);
    } else {
      let media = value;
    }
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`callback getMediaContentBase64 failed, error code: ${code}, message: ${message}.`);
}

getMediaContentBase64⁹⁺

getMediaContentBase64(resource: Resource): Promise<string>

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

System capability: SystemCapability.Global.ResourceManager

Model restriction: This API can be used only in the stage model.

Parameters

Name	Type	Mandatory	Description
resource	Resource	Yes	Resource object.

Return value

Type	Description
Promise<string>	Promise used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.

Example

import resourceManager from '@ohos.resourceManager';
import { BusinessError } from '@ohos.base';

let resource: resourceManager.Resource = {
  bundleName: "com.example.myapplication",
  moduleName: "entry",
  id: $r('app.media.test').id
};
try {
  this.context.resourceManager.getMediaContentBase64(resource).then((value: string) => {
    let media = value;
  }).catch((error: BusinessError) => {
    console.log("getMediaContentBase64 promise error is " + error);
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`promise getMediaContentBase64 failed, error code: ${code}, message: ${message}.`);
}

getMediaContentBase64¹⁰⁺

getMediaContentBase64(resource: Resource, density: number): Promise<string>

Obtains the Base64 code of an image with the screen density corresponding to the specified resource object. This API uses a promise to return the result.

System capability: SystemCapability.Global.ResourceManager

Model restriction: This API can be used only in the stage model.

Parameters

Name	Type	Mandatory	Description
resource	Resource	Yes	Resource object.
density	number	Yes	Screen density. The value 0 indicates the default screen density.

Return value

Type	Description
Promise<string>	Promise used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.

Example

import resourceManager from '@ohos.resourceManager';
import { BusinessError } from '@ohos.base';

let resource: resourceManager.Resource = {
  bundleName: "com.example.myapplication",
  moduleName: "entry",
  id: $r('app.media.test').id
};
try {
  this.context.resourceManager.getMediaContentBase64(resource, 120).then((value: string) => {
    let media = value;
  }).catch((error: BusinessError) => {
    console.error(`promise getMediaContentBase64 failed, error code: ${error.code}, message: ${error.message}.`);
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`promise getMediaContentBase64 failed, error code: ${code}, message: ${message}.`);
}

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

Name	Type	Mandatory	Description
resName	string	Yes	Resource name.
callback	AsyncCallback<string>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001003	If the resName invalid.
9001004	If the resource not found by resName.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getMediaBase64ByName("test", (error, value) => {
    if (error != null) {
      console.log("error is " + error);
    } else {
      let media = value;
    }
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`callback getMediaBase64ByName failed, error code: ${code}, message: ${message}.`);
}

getMediaBase64ByName¹⁰⁺

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

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

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resName	string	Yes	Resource name.
density	number	Yes	Screen density. The value 0 indicates the default screen density.
callback	AsyncCallback<string>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001003	If the resName invalid.
9001004	If the resource not found by resName.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getMediaBase64ByName("test", 120, (error, value) => {
    if (error != null) {
      console.error(`callback getMediaBase64ByName failed, error code: ${error.code}, message: ${error.message}.`);
    } else {
      let media = value;
    }
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`callback getMediaBase64ByName failed, error code: ${code}, message: ${message}.`);
}

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

Name	Type	Mandatory	Description
resName	string	Yes	Resource name.

Return value

Type	Description
Promise<string>	Promise used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001003	If the resName invalid.
9001004	If the resource not found by resName.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getMediaBase64ByName("test").then((value: string) => {
    let media = value;
  }).catch((error: BusinessError) => {
    console.log("getMediaBase64ByName promise error is " + error);
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`promise getMediaBase64ByName failed, error code: ${code}, message: ${message}.`);
}

getMediaBase64ByName¹⁰⁺

getMediaBase64ByName(resName: string, density: number): Promise<string>

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

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resName	string	Yes	Resource name.
density	number	Yes	Screen density. The value 0 indicates the default screen density.

Return value

Type	Description
Promise<string>	Promise used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001003	If the resName invalid.
9001004	If the resource not found by resName.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getMediaBase64ByName("test", 120).then((value: string) => {
    let media = value;
  }).catch((error: BusinessError) => {
    console.error(`promise getMediaBase64ByName failed, error code: ${error.code}, message: ${error.message}.`);
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`promise getMediaBase64ByName failed, error code: ${code}, message: ${message}.`);
}

getDrawableDescriptor¹⁰⁺

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

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

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resId	number	Yes	Resource ID.
density	number	No	Screen density. The default value or value 0 indicates the default screen density.

Return value

Type	Description
DrawableDescriptor	DrawableDescriptor object corresponding to the specified resource ID.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getDrawableDescriptor($r('app.media.icon').id);
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getDrawableDescriptor failed, error code: ${code}, message: ${message}.`);
}
try {
  this.context.resourceManager.getDrawableDescriptor($r('app.media.icon').id, 120);
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getDrawableDescriptor failed, error code: ${code}, message: ${message}.`);
}

getDrawableDescriptor¹⁰⁺

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

Obtains the DrawableDescriptor object corresponding to the specified resource object. This API returns the result synchronously.

System capability: SystemCapability.Global.ResourceManager

Model restriction: This API can be used only in the stage model.

Parameters

Name	Type	Mandatory	Description
resource	Resource	Yes	Resource object.
density	number	No	Screen density. The default value or value 0 indicates the default screen density.

Return value

Type	Description
DrawableDescriptor	DrawableDescriptor object corresponding to the specified resource ID.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.

Example

import resourceManager from '@ohos.resourceManager';
import { BusinessError } from '@ohos.base';

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

getDrawableDescriptorByName¹⁰⁺

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

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

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resName	string	Yes	Resource name.
density	number	No	Screen density. The default value or value 0 indicates the default screen density.

Return value

Type	Description
DrawableDescriptor	DrawableDescriptor object corresponding to the specified resource ID.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001003	If the resName invalid.
9001004	If the resource not found by resName.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getDrawableDescriptorByName('icon');
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getDrawableDescriptorByName failed, error code: ${code}, message: ${message}.`);
}
try {
  this.context.resourceManager.getDrawableDescriptorByName('icon', 120);
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getDrawableDescriptorByName failed, error code: ${code}, message: ${message}.`);
}

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

Name	Type	Mandatory	Description
resId	number	Yes	Resource ID.

Return value

Type	Description
boolean	Boolean result corresponding to the specified resource ID.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.
9001006	If the resource re-ref too much.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getBoolean($r('app.boolean.boolean_test').id);
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getBoolean failed, error code: ${code}, message: ${message}.`);
}

getBoolean⁹⁺

getBoolean(resource: Resource): boolean

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

System capability: SystemCapability.Global.ResourceManager

Model restriction: This API can be used only in the stage model.

Parameters

Name	Type	Mandatory	Description
resource	Resource	Yes	Resource object.

Return value

Type	Description
boolean	Boolean result corresponding to the specified resource object.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.
9001006	If the resource re-ref too much.

Example

import resourceManager from '@ohos.resourceManager';
import { BusinessError } from '@ohos.base';

let resource: resourceManager.Resource = {
  bundleName: "com.example.myapplication",
  moduleName: "entry",
  id: $r('app.boolean.boolean_test').id
};
try {
  this.context.resourceManager.getBoolean(resource);
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getBoolean failed, error code: ${code}, message: ${message}.`);
}

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

Name	Type	Mandatory	Description
resName	string	Yes	Resource name.

Return value

Type	Description
boolean	Boolean result corresponding to the specified resource name.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001003	If the resName invalid.
9001004	If the resource not found by resName.
9001006	If the resource re-ref too much.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getBooleanByName("boolean_test");
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getBooleanByName failed, error code: ${code}, message: ${message}.`);
}

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

Name	Type	Mandatory	Description
resId	number	Yes	Resource ID.

Return value

Type	Description
number	Integer or float value corresponding to the specified resource ID. Wherein, the integer value is the original value, and the float value is the actual pixel value. For details, see the sample code.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.
9001006	If the resource re-ref too much.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getNumber($r('app.integer.integer_test').id); // integer refers to the original value.
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getNumber failed, error code: ${code}, message: ${message}.`);
}

try {
  this.context.resourceManager.getNumber($r('app.float.float_test').id); // float refers to the actual pixel value.
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getNumber failed, error code: ${code}, message: ${message}.`);
}

getNumber⁹⁺

getNumber(resource: Resource): number

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

System capability: SystemCapability.Global.ResourceManager

Model restriction: This API can be used only in the stage model.

Parameters

Name	Type	Mandatory	Description
resource	Resource	Yes	Resource object.

Return value

Type	Description
number	Integer or float value corresponding to the specified resource object. Wherein, the integer value is the original value, and the float value is the actual pixel value. For details, see the sample code.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.
9001006	If the resource re-ref too much.

Example

import resourceManager from '@ohos.resourceManager';
import { BusinessError } from '@ohos.base';

let resource: resourceManager.Resource = {
  bundleName: "com.example.myapplication",
  moduleName: "entry",
  id: $r('app.integer.integer_test').id
};
try {
  this.context.resourceManager.getNumber(resource);// integer refers to the original value; float refers to the actual pixel value.
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getNumber failed, error code: ${code}, message: ${message}.`);
}

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

Name	Type	Mandatory	Description
resName	string	Yes	Resource name.

Return value

Type	Description
number	Integer or float value corresponding to the specified resource name.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001003	If the resName invalid.
9001004	If the resource not found by resName.
9001006	If the resource re-ref too much.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getNumberByName("integer_test");
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getNumberByName failed, error code: ${code}, message: ${message}.`);
}

try {
  this.context.resourceManager.getNumberByName("float_test");
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getNumberByName failed, error code: ${code}, message: ${message}.`);
}

getColorSync¹⁰⁺

getColorSync(resId: number) : number;

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

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resId	number	Yes	Resource ID.

Return value

Type	Description
number	Color value corresponding to the resource ID (decimal).

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.
9001006	If the resource re-ref too much.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getColorSync($r('app.color.test').id);
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getColorSync failed, error code: ${code}, message: ${message}.`);
}

getColorSync¹⁰⁺

getColorSync(resource: Resource): number

Obtains the color value corresponding to the specified resource object. This API returns the result synchronously.

System capability: SystemCapability.Global.ResourceManager

Model restriction: This API can be used only in the stage model.

Parameters

Name	Type	Mandatory	Description
resource	Resource	Yes	Resource object.

Return value

Type	Description
number	Color value corresponding to the resource object (decimal).

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.
9001006	If the resource re-ref too much.

Example

import resourceManager from '@ohos.resourceManager';
import { BusinessError } from '@ohos.base';

let resource: resourceManager.Resource = {
  bundleName: "com.example.myapplication",
  moduleName: "entry",
  id: $r('app.color.test').id
};
try {
  this.context.resourceManager.getColorSync(resource);
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getColorSync failed, error code: ${code}, message: ${message}.`);
}

getColorByNameSync¹⁰⁺

getColorByNameSync(resName: string) : number;

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

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resName	string	Yes	Resource name.

Return value

Type	Description
number	Color value corresponding to the resource name (decimal).

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001003	If the resName invalid.
9001004	If the resource not found by resName.
9001006	If the resource re-ref too much.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getColorByNameSync("test");
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getColorByNameSync failed, error code: ${code}, message: ${message}.`);
}

getColor¹⁰⁺

getColor(resId: number, callback: AsyncCallback<number>): void;

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

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resId	number	Yes	Resource ID.
callback	AsyncCallback<number>	Yes	Asynchronous callback used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the module resId invalid.
9001002	If the resource not found by resId.
9001006	If the resource re-ref too much.

Example (stage)

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getColor($r('app.color.test').id, (error, value) => {
    if (error != null) {
      console.log("error is " + error);
    } else {
      let str = value;
    }
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`callback getColor failed, error code: ${code}, message: ${message}.`);
}

getColor¹⁰⁺

getColor(resId: number): Promise<number>

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

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resId	number	Yes	Resource ID.

Return value

Type	Description
Promise<number>	Promise used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.
9001006	If the resource re-ref too much.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getColor($r('app.color.test').id).then((value: number) => {
    let str = value;
  }).catch((error: BusinessError) => {
    console.log("getColor promise error is " + error);
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`promise getColor failed, error code: ${code}, message: ${message}.`);
}

getColor¹⁰⁺

getColor(resource: Resource, callback: AsyncCallback<number>): void;

Obtains the color value corresponding to the specified resource object. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Global.ResourceManager

Model restriction: This API can be used only in the stage model.

Parameters

Name	Type	Mandatory	Description
resource	Resource	Yes	Resource object.
callback	AsyncCallback<number>	Yes	Asynchronous callback used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.
9001006	If the resource re-ref too much.

Example

import resourceManager from '@ohos.resourceManager';
import { BusinessError } from '@ohos.base';

let resource: resourceManager.Resource = {
  bundleName: "com.example.myapplication",
  moduleName: "entry",
  id: $r('app.color.test').id
};
try {
  this.context.resourceManager.getColor(resource, (error, value) => {
    if (error != null) {
      console.log("error is " + error);
    } else {
      let str = value;
    }
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`callback getColor failed, error code: ${code}, message: ${message}.`);
}

getColor¹⁰⁺

getColor(resource: Resource): Promise<number>;

Obtains the color value corresponding to the specified resource object. This API uses a promise to return the result.

System capability: SystemCapability.Global.ResourceManager

Model restriction: This API can be used only in the stage model.

Parameters

Name	Type	Mandatory	Description
resource	Resource	Yes	Resource object.

Return value

Type	Description
Promise<number>	Promise used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001001	If the resId invalid.
9001002	If the resource not found by resId.
9001006	If the resource re-ref too much.

Example

import resourceManager from '@ohos.resourceManager';
import { BusinessError } from '@ohos.base';

let resource: resourceManager.Resource = {
  bundleName: "com.example.myapplication",
  moduleName: "entry",
  id: $r('app.color.test').id
};
try {
  this.context.resourceManager.getColor(resource).then((value: number) => {
    let str = value;
  }).catch((error: BusinessError) => {
    console.log("getColor promise error is " + error);
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`promise getColor failed, error code: ${code}, message: ${message}.`);
}

getColorByName¹⁰⁺

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

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

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resName	string	Yes	Resource name.
callback	AsyncCallback<number>	Yes	Asynchronous callback used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001003	If the resName invalid.
9001004	If the resource not found by resName.
9001006	If the resource re-ref too much.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getColorByName("test", (error, value) => {
    if (error != null) {
      console.log("error is " + error);
    } else {
      let string = value;
    }
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`callback getColorByName failed, error code: ${code}, message: ${message}.`);
}

getColorByName¹⁰⁺

getColorByName(resName: string): Promise<number>

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

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resName	string	Yes	Resource name.

Return value

Type	Description
Promise<number>	Promise used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001003	If the resName invalid.
9001004	If the resource not found by resName.
9001006	If the resource re-ref too much.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getColorByName("test").then((value: number) => {
    let string = value;
  }).catch((error: BusinessError) => {
    console.log("getColorByName promise error is " + error);
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`promise getColorByName failed, error code: ${code}, message: ${message}.`);
}

getRawFileContentSync¹⁰⁺

getRawFileContentSync(path: string): Uint8Array

Obtains the content of the raw file in the resources/rawfile directory. This API returns the result synchronously.

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
path	string	Yes	Path of the raw file.

Return value

Type	Description
Uint8Array	Content of the raw file.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001005	If the resource not found by path.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getRawFileContentSync("test.txt");
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getRawFileContentSync failed, error code: ${code}, message: ${message}.`);
}

getRawFileContent⁹⁺

getRawFileContent(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

Name	Type	Mandatory	Description
path	string	Yes	Path of the raw file.
callback	AsyncCallback<Uint8Array>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001005	If the resource not found by path.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getRawFileContent("test.txt", (error, value) => {
    if (error != null) {
      console.log("error is " + error);
    } else {
      let rawFile = value;
    }
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`callback getRawFileContent failed, error code: ${code}, message: ${message}.`);
}

getRawFileContent⁹⁺

getRawFileContent(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

Name	Type	Mandatory	Description
path	string	Yes	Path of the raw file.

Return value

Type	Description
Promise<Uint8Array>	Promise used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001005	If the resource not found by path.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getRawFileContent("test.txt").then((value: Uint8Array) => {
    let rawFile = value;
  }).catch((error: BusinessError) => {
    console.log("getRawFileContent promise error is " + error);
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`promise getRawFileContent failed, error code: ${code}, message: ${message}.`);
}

getRawFileListSync¹⁰⁺

getRawFileListSync(path: string): Array<string>

Obtains the list of files in the resources/rawfile directory. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
path	string	Yes	Path of the rawfile folder.

Return value

Type	Description
Array<string>	List of files in the resources/rawfile directory.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001005	If the resource not found by path.

Example

import { BusinessError } from '@ohos.base';

try { // Passing "" means to obtain the list of files in the root directory of the raw file.
  this.context.resourceManager.getRawFileListSync("")
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getRawFileListSync failed, error code: ${code}, message: ${message}.`);
}

getRawFileList¹⁰⁺

getRawFileList(path: string, callback: AsyncCallback<Array<string>>): void;

Obtains the list of files in the resources/rawfile directory. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
path	string	Yes	Path of the rawfile folder.
callback	AsyncCallback<Array<string>>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001005	If the resource not found by path.

Example

import { BusinessError } from '@ohos.base';

try { // Passing "" means to obtain the list of files in the root directory of the raw file.
  this.context.resourceManager.getRawFileList("", (error, value) => {
    if (error != null) {
      console.error(`callback getRawFileList failed, error code: ${error.code}, message: ${error.message}.`);
    } else {
      let rawFile = value;
    }
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`callback getRawFileList failed, error code: ${code}, message: ${message}.`);
}

getRawFileList¹⁰⁺

getRawFileList(path: string): Promise<Array<string>>

Obtains the list of files in the resources/rawfile directory. This API uses a promise to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
path	string	Yes	Path of the rawfile folder.

Return value

Type	Description
Promise<Array<string>>	Promise used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001005	If the resource not found by path.

Example

import { BusinessError } from '@ohos.base';

try { // Passing "" means to obtain the list of files in the root directory of the raw file.
  this.context.resourceManager.getRawFileList("").then((value: Array<string>) => {
    let rawFile = value;
  }).catch((error: BusinessError) => {
    console.error(`promise getRawFileList failed, error code: ${error.code}, message: ${error.message}.`);
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`promise getRawFileList failed, error code: ${code}, message: ${message}.`);
}

getRawFdSync¹⁰⁺

getRawFdSync(path: string): RawFileDescriptor

Obtains the descriptor of the raw file in the resources/rawfile directory.

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
path	string	Yes	Path of the raw file.

Return value

Type	Description
RawFileDescriptor	Descriptor of the raw file.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001005	If the resource not found by path.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getRawFdSync("test.txt");
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`getRawFdSync failed, error code: ${code}, message: ${message}.`);
}

getRawFd⁹⁺

getRawFd(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

Name	Type	Mandatory	Description
path	string	Yes	Path of the raw file.
callback	AsyncCallback<RawFileDescriptor>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001005	If the resource not found by path.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getRawFd("test.txt", (error, value) => {
    if (error != null) {
      console.log(`callback getRawFd failed error code: ${error.code}, message: ${error.message}.`);
    } else {
      let fd = value.fd;
      let offset = value.offset;
      let length = value.length;
    }
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`callback getRawFd failed, error code: ${code}, message: ${message}.`);
}

getRawFd⁹⁺

getRawFd(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

Name	Type	Mandatory	Description
path	string	Yes	Path of the raw file.

Return value

Type	Description
Promise<RawFileDescriptor>	Promise used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001005	If the resource not found by path.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getRawFd("test.txt").then((value: resourceManager.RawFileDescriptor) => {
    let fd = value.fd;
    let offset = value.offset;
    let length = value.length;
  }).catch((error: BusinessError) => {
    console.log(`promise getRawFd error error code: ${error.code}, message: ${error.message}.`);
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`promise getRawFd failed, error code: ${code}, message: ${message}.`);
}

closeRawFdSync¹⁰⁺

closeRawFdSync(path: string): void

Closes the descriptor of the raw file in the resources/rawfile directory.

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
path	string	Yes	Path of the raw file.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001005	The resource not found by path.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.closeRawFdSync("test.txt");
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`closeRawFd failed, error code: ${code}, message: ${message}.`);
}

closeRawFd⁹⁺

closeRawFd(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

Name	Type	Mandatory	Description
path	string	Yes	Path of the raw file.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001005	The resource not found by path.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.closeRawFd("test.txt", (error, value) => {
    if (error != null) {
      console.log("error is " + error);
    }
  });
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`callback closeRawFd failed, error code: ${code}, message: ${message}.`);
}

closeRawFd⁹⁺

closeRawFd(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

Name	Type	Mandatory	Description
path	string	Yes	Path of the raw file.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001005	If the resource not found by path.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.closeRawFd("test.txt");
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`promise closeRawFd failed, error code: ${code}, message: ${message}.`);
}

getConfigurationSync

getConfigurationSync(): Configuration

Obtains the device configuration. This API return the results synchronously.

System capability: SystemCapability.Global.ResourceManager

Return value

Type	Description
Configuration	Promise used to return the result.

Example

try {
  let value = this.context.resourceManager.getConfigurationSync();
  let direction = value.direction;
  let locale = value.locale;
} catch (error) {
  console.error("getConfigurationSync 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

Name	Type	Mandatory	Description
callback	AsyncCallback<Configuration>	Yes	Callback used to return the result.

Example

try {
  this.context.resourceManager.getConfiguration((error, value) => {
    if (error != null) {
      console.error("getConfiguration callback error is " + error);
    } else {
      let direction = value.direction;
      let locale = value.locale;
    }
  });
} catch (error) {
  console.error("getConfiguration callback error is " + error);
}

getConfiguration

getConfiguration(): Promise<Configuration>

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

System capability: SystemCapability.Global.ResourceManager

Return value

Type	Description
Promise<Configuration>	Promise used to return the result.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getConfiguration().then((value: resourceManager.Configuration) => {
    let direction = value.direction;
    let locale = value.locale;
  }).catch((error: BusinessError) => {
    console.error("getConfiguration promise error is " + error);
  });
} catch (error) {
  console.error("getConfiguration promise error is " + error);
}

getDeviceCapabilitySync

getDeviceCapabilitySync(): DeviceCapability

Obtains the device capability. This API return the results synchronously.

System capability: SystemCapability.Global.ResourceManager

Return value

Type	Description
DeviceCapability	Promise used to return the result.

Example

try {
  let value = this.context.resourceManager.getDeviceCapabilitySync();
  let screenDensity = value.screenDensity;
  let deviceType = value.deviceType;
} catch (error) {
  console.error("getDeviceCapabilitySync 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

Name	Type	Mandatory	Description
callback	AsyncCallback<DeviceCapability>	Yes	Callback used to return the result.

Example

try {
  this.context.resourceManager.getDeviceCapability((error, value) => {
    if (error != null) {
      console.error("getDeviceCapability callback error is " + error);
    } else {
      let screenDensity = value.screenDensity;
      let deviceType = value.deviceType;
    }
  });
} catch (error) {
  console.error("getDeviceCapability callback error is " + error);
}

getDeviceCapability

getDeviceCapability(): Promise<DeviceCapability>

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

System capability: SystemCapability.Global.ResourceManager

Return value

Type	Description
Promise<DeviceCapability>	Promise used to return the result.

Example

import { BusinessError } from '@ohos.base';

try {
  this.context.resourceManager.getDeviceCapability().then((value: resourceManager.DeviceCapability) => {
    let screenDensity = value.screenDensity;
    let deviceType = value.deviceType;
  }).catch((error: BusinessError) => {
    console.error("getDeviceCapability promise error is " + error);
  });
} catch (error) {
  console.error("getDeviceCapability promise error is " + error);
}

release⁷⁺

release()

Releases a ResourceManager object. This API is not supported currently.

System capability: SystemCapability.Global.ResourceManager

Example

try {
  this.context.resourceManager.release();
} catch (error) {
  console.error("release error is " + error);
}

addResource¹⁰⁺

addResource(path: string) : void;

Loads resources from the specified path.

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
path	string	Yes	Resource path.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001010	If the overlay path is invalid.

Example

import { BusinessError } from '@ohos.base';

let path = getContext().bundleCodeDir + "/library1-default-signed.hsp";
try {
  this.context.resourceManager.addResource(path);
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`addResource failed, error code: ${code}, message: ${message}.`);
}

removeResource¹⁰⁺

removeResource(path: string) : void;

Removes the resources loaded from the specified path to restore the original resources.

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
path	string	Yes	Resource path.

Error codes

For details about the error codes, see Resource Manager Error Codes.

ID	Error Message
9001010	If the overlay path is invalid.

Example

import { BusinessError } from '@ohos.base';

let path = getContext().bundleCodeDir + "/library1-default-signed.hsp";
try {
  this.context.resourceManager.removeResource(path);
} catch (error) {
  let code = (error as BusinessError).code;
  let message = (error as BusinessError).message;
  console.error(`removeResource failed, error code: ${code}, message: ${message}.`);
}

getString^(deprecated)

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.

This API is deprecated since API version 9. You are advised to use getStringValue instead.

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resId	number	Yes	Resource ID.
callback	AsyncCallback<string>	Yes	Callback used to return the result.

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^(deprecated)

getString(resId: number): Promise<string>

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

This API is deprecated since API version 9. You are advised to use getStringValue instead.

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resId	number	Yes	Resource ID.

Return value

Type	Description
Promise<string>	Promise used to return the result.

Example

import { BusinessError } from '@ohos.base';

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

getStringArray^(deprecated)

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.

This API is deprecated since API version 9. You are advised to use getStringArrayValue instead.

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resId	number	Yes	Resource ID.
callback	AsyncCallback<Array<string>>	Yes	Callback used to return the result.

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^(deprecated)

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.

This API is deprecated since API version 9. You are advised to use getStringArrayValue instead.

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resId	number	Yes	Resource ID.

Return value

Type	Description
Promise<Array<string>>	Promise used to return the result.

Example

import { BusinessError } from '@ohos.base';

resourceManager.getResourceManager((error, mgr) => {
     mgr.getStringArray($r('app.strarray.test').id).then((value: Array<string>) => {
        let strArray = value;
    }).catch((error: BusinessError) => {
        console.log("getStringArray promise error is " + error);
    });
});

getMedia^(deprecated)

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

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

This API is deprecated since API version 9. You are advised to use getMediaContent instead.

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resId	number	Yes	Resource ID.
callback	AsyncCallback<Uint8Array>	Yes	Callback used to return the result.

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^(deprecated)

getMedia(resId: number): Promise<Uint8Array>

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

This API is deprecated since API version 9. You are advised to use getMediaContent instead.

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resId	number	Yes	Resource ID.

Return value

Type	Description
Promise<Uint8Array>	Promise used to return the result.

Example

import { BusinessError } from '@ohos.base';

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

getMediaBase64^(deprecated)

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.

This API is deprecated since API version 9. You are advised to use getMediaContentBase64 instead.

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resId	number	Yes	Resource ID.
callback	AsyncCallback<string>	Yes	Callback used to return the result.

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^(deprecated)

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.

This API is deprecated since API version 9. You are advised to use getMediaContentBase64 instead.

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resId	number	Yes	Resource ID.

Return value

Type	Description
Promise<string>	Promise used to return the result.

Example

import { BusinessError } from '@ohos.base';

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

getPluralString^(deprecated)

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

Obtains the singular-plural string corresponding to the specified resource ID based on the specified number. This API uses a promise to return the result.

This API is deprecated since API version 9. You are advised to use getPluralStringValue instead.

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resId	number	Yes	Resource ID.
num	number	Yes	Number.

Return value

Type	Description
Promise<string>	Promise used to return the result.

Example

import { BusinessError } from '@ohos.base';

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

getPluralString^(deprecated)

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

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

This API is deprecated since API version 9. You are advised to use getPluralStringValue instead.

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
resId	number	Yes	Resource ID.
num	number	Yes	Number.
callback	AsyncCallback<string>	Yes	Callback used to return the result.

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

getRawFile^(deprecated)

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.

This API is deprecated since API version 9. You are advised to use getRawFileContent instead.

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
path	string	Yes	Path of the raw file.
callback	AsyncCallback<Uint8Array>	Yes	Callback used to return the result.

Example

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

getRawFile^(deprecated)

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.

This API is deprecated since API version 9. You are advised to use getRawFileContent instead.

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
path	string	Yes	Path of the raw file.

Return value

Type	Description
Promise<Uint8Array>	Promise used to return the result.

Example

import { BusinessError } from '@ohos.base';

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

getRawFileDescriptor^(deprecated)

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.

This API is deprecated since API version 9. You are advised to use getRawFd instead.

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
path	string	Yes	Path of the raw file.
callback	AsyncCallback<RawFileDescriptor>	Yes	Callback used to return the result.

Example

resourceManager.getResourceManager((error, mgr) => {
    mgr.getRawFileDescriptor("test.txt", (error, value) => {
        if (error != null) {
            console.log("error is " + error);
        } else {
            let fd = value.fd;
            let offset = value.offset;
            let length = value.length;
        }
    });
});

getRawFileDescriptor^(deprecated)

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.

This API is deprecated since API version 9. You are advised to use getRawFd instead.

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
path	string	Yes	Path of the raw file.

Return value

Type	Description
Promise<RawFileDescriptor>	Promise used to return the result.

Example

import { BusinessError } from '@ohos.base';

resourceManager.getResourceManager((error, mgr) => {
    mgr.getRawFileDescriptor("test.txt").then((value: resourceManager.RawFileDescriptor) => {
        let fd = value.fd;
        let offset = value.offset;
        let length = value.length;
    }).catch((error: BusinessError) => {
        console.log("getRawFileDescriptor promise error is " + error);
    });
});

closeRawFileDescriptor^(deprecated)

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.

This API is deprecated since API version 9. You are advised to use closeRawFd.

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
path	string	Yes	Path of the raw file.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Example

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

closeRawFileDescriptor^(deprecated)

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.

This API is deprecated since API version 9. You are advised to use closeRawFd.

System capability: SystemCapability.Global.ResourceManager

Parameters

Name	Type	Mandatory	Description
path	string	Yes	Path of the raw file.

Return value

Type	Description
Promise<void>	Promise that returns no value.

Example

resourceManager.getResourceManager((error, mgr) => {
    mgr.closeRawFileDescriptor("test.txt");
});

你可能感兴趣的鸿蒙文章

harmony 鸿蒙APIs

harmony 鸿蒙System Common Events (To Be Deprecated Soon)

harmony 鸿蒙System Common Events

harmony 鸿蒙API Reference Document Description

harmony 鸿蒙Enterprise Device Management Overview (for System Applications Only)

harmony 鸿蒙BundleStatusCallback

harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager)

harmony 鸿蒙@ohos.distributedBundle (Distributed Bundle Management)

harmony 鸿蒙@ohos.bundle (Bundle)

harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (EnterpriseAdminExtensionAbility)