@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

Example

resourceManager.getResourceManager((error, mgr) => {
  if (error != null) {
    console.error("error is " + error);
    return;
  }
  mgr.getStringValue(0x1000000, (error: BusinessError, value: string) => {
    if (error != null) {
      console.error("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 the specified 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

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

Example

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

resourceManager.getResourceManager().then((mgr: resourceManager.ResourceManager) => {
  mgr.getStringValue(0x1000000, (error: BusinessError, value: string) => {
    if (error != null) {
      console.error("error is " + error);
    } else {
      let str = value;
    }
  });
}).catch((error: BusinessError) => {
  console.error("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 the specified 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.

Parameters

Return value

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

Error codes

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

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.error("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

DeviceType

Enumerates the device types.

System capability: SystemCapability.Global.ResourceManager

ScreenDensity

Enumerates the screen density types.

System capability: SystemCapability.Global.ResourceManager

Configuration

Defines the device configuration.

System capability: SystemCapability.Global.ResourceManager

Parameters

DeviceCapability

Defines the device capability.

System capability: SystemCapability.Global.ResourceManager

Parameters

RawFileDescriptor⁸⁺

Defines the descriptor of the raw file.

System capability: SystemCapability.Global.ResourceManager

Parameters

Resource⁹⁺

Defines the resource information of an application.

System capability: SystemCapability.Global.ResourceManager

Parameters

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.

• You can use .context().resourceManager to access intra-package resources in an application by resource ID or resource name.

• For cross-package resources within an application, two methods are available for accessing a resource: by way of a resource object or by creating the context of the corresponding module and accessing the resource through .context().createModuleContext().resourceManager.

• For cross-application package resources, use .context.createModuleContext(bundleName:'bundleName name',moduleName:'module name').resourceManager. This API can be used only by system applications.

• For details about Context, see [Context (Stage Model)] (../../application-models/application-context-stage.md).

getStringSync⁹⁺

getStringSync(resId: number): string

Obtains a string based on the specified resource ID. This API returns the result synchronously.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Error codes

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

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 a string based on the specified resource ID and formats the string based on args. This API returns the result synchronously.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Error codes

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

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 a string based on the specified resource object. This API returns the result synchronously. This API is used for cross-package access in a multi-project application. It works by creating the context of the corresponding module to obtain required resources.

System capability: SystemCapability.Global.ResourceManager

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

Parameters

Return value

Error codes

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

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 a string based on the specified resource object and formats the string based on args. This API returns the result synchronously. This API is used for cross-package access in a multi-project application. It works by creating the context of the corresponding module to obtain required resources.

System capability: SystemCapability.Global.ResourceManager

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

Parameters

Return value

Error codes

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

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 a string based on the specified resource name. This API returns the result synchronously.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Error codes

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

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 a string based on the specified resource name and formats the string based on args. This API returns the result synchronously.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Error codes

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

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 a string based on the specified resource ID. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Error codes

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

Example (stage)

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

try {
  this.context.resourceManager.getStringValue($r('app.string.test').id, (error: BusinessError, value: string) => {
    if (error != null) {
      console.error("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 a string based on the specified resource ID. This API uses a promise to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Error codes

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

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.error("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 a string based on the specified resource object. This API uses an asynchronous callback to return the result. This API is used for cross-package access in a multi-project application. It works by creating the context of the corresponding module to obtain required resources.

System capability: SystemCapability.Global.ResourceManager

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

Parameters

Error codes

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

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: BusinessError, value: string) => {
    if (error != null) {
      console.error("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 a string based on the specified resource object. This API uses a promise to return the result. This API is used for cross-package access in a multi-project application. It works by creating the context of the corresponding module to obtain required resources.

System capability: SystemCapability.Global.ResourceManager

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

Parameters

Return value

Error codes

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

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.error("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 a string based on the specified resource name. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Error codes

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

Example

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

try {
  this.context.resourceManager.getStringByName("test", (error: BusinessError, value: string) => {
    if (error != null) {
      console.error("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 a string based on the specified resource name. This API uses a promise to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Error codes

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

Example

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

try {
  this.context.resourceManager.getStringByName("test").then((value: string) => {
    let str = value;
  }).catch((error: BusinessError) => {
    console.error("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 a string array based on the specified resource ID. This API returns the result synchronously.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Error codes

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

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 a string array based on the specified resource object. This API returns the result synchronously. This API is used for cross-package access in a multi-project application. It works by creating the context of the corresponding module to obtain required resources.

System capability: SystemCapability.Global.ResourceManager

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

Parameters

Return value

Error codes

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

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 a string array based on the specified resource name. This API returns the result synchronously.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Error codes

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

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 a string array based on the specified resource ID. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Error codes

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

Example

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

try {
  this.context.resourceManager.getStringArrayValue($r('app.strarray.test').id, (error: BusinessError, value: Array<string>) => {
    if (error != null) {
      console.error("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 a string array based on the specified resource ID. This API uses a promise to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Error codes

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

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.error("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 a string array based on the specified resource object. This API uses an asynchronous callback to return the result. This API is used for cross-package access in a multi-project application. It works by creating the context of the corresponding module to obtain required resources. System capability: SystemCapability.Global.ResourceManager

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

Parameters

Error codes

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

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: BusinessError, value: Array<string>) => {
    if (error != null) {
      console.error("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 a string array based on the specified resource object. This API uses a promise to return the result. This API is used for cross-package access in a multi-project application. It works by creating the context of the corresponding module to obtain required resources.

System capability: SystemCapability.Global.ResourceManager

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

Parameters

Return value

Error codes

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

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.error("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 a string array based on the specified resource name. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Error codes

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

Example

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

try {
  this.context.resourceManager.getStringArrayByName("test", (error: BusinessError, value: Array<string>) => {
    if (error != null) {
      console.error("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 a string array based on the specified resource name. This API uses a promise to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Error codes

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

Example

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

try {
  this.context.resourceManager.getStringArrayByName("test").then((value: Array<string>) => {
    let strArray = value;
  }).catch((error: BusinessError) => {
    console.error("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 a singular-plural string by the specified number based on the specified resource ID. This API returns the result synchronously.

NOTE

Singular and plural forms are available for English, but not Chinese.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Error codes

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

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 a singular-plural string by the specified number based on the specified resource object. This API returns the result synchronously. This API is used for cross-package access in a multi-project application. It works by creating the context of the corresponding module to obtain required resources.

NOTE

Singular and plural forms are available for English, but not Chinese.

System capability: SystemCapability.Global.ResourceManager

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

Parameters

Return value

Error codes

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

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 a singular-plural string by the specified number based on the specified resource name. This API returns the result synchronously.

NOTE

Singular and plural forms are available for English, but not Chinese.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Error codes

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

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 a singular-plural string by the specified number based on the specified resource ID. This API uses an asynchronous callback to return the result.

NOTE

Singular and plural forms are available for English, but not Chinese.

System capability: SystemCapability.Global.ResourceManager

Parameters

Error codes

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

Example

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

try {
  this.context.resourceManager.getPluralStringValue($r("app.plural.test").id, 1, (error: BusinessError, value: string) => {
    if (error != null) {
      console.error("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 a singular-plural string by the specified number based on the specified resource ID. This API uses a promise to return the result.

NOTE

Singular and plural forms are available for English, but not Chinese.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Error codes

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

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.error("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 a singular-plural string by the specified number based on the specified resource object. This API uses an asynchronous callback to return the result. This API is used for cross-package access in a multi-project application. It works by creating the context of the corresponding module to obtain required resources.

NOTE

Singular and plural forms are available for English, but not Chinese.

System capability: SystemCapability.Global.ResourceManager

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

Parameters

Error codes

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

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: BusinessError, value: string) => {
    if (error != null) {
      console.error("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 a singular-plural string by the specified number based on the specified resource object. This API uses a promise to return the result. This API is used for cross-package access in a multi-project application. It works by creating the context of the corresponding module to obtain required resources.

NOTE

Singular and plural forms are available for English, but not Chinese.

System capability: SystemCapability.Global.ResourceManager

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

Parameters

Return value

Error codes

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

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.error("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 a singular-plural string by the specified number based on the specified resource name. This API uses an asynchronous callback to return the result.

NOTE

Singular and plural forms are available for English, but not Chinese.

System capability: SystemCapability.Global.ResourceManager

Parameters

Error codes

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

Example

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

try {
  this.context.resourceManager.getPluralStringByName("test", 1, (error: BusinessError, value: string) => {
    if (error != null) {
      console.error("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 a singular-plural string by the specified number based on the specified resource name. This API uses a promise to return the result.

NOTE

Singular and plural forms are available for English, but not Chinese.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Error codes

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

Example

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

try {
  this.context.resourceManager.getPluralStringByName("test", 1).then((value: string) => {
    let str = value;
  }).catch((error: BusinessError) => {
    console.error("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 content of a media file with the default or specified screen density based on the specified resource ID. This API returns the result synchronously.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Error codes

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

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 content of a media file with the default or specified screen density based on the specified resource object. This API returns the result synchronously. This API is used for cross-package access in a multi-project application. It works by creating the context of the corresponding module to obtain required resources.

System capability: SystemCapability.Global.ResourceManager

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

Parameters

Return value

Error codes

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

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 content of a media file with the default or specified screen density based on the specified resource name. This API returns the result synchronously.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Error codes

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

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 content of a media file based on the specified resource ID. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Error codes

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

Example

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

try {
  this.context.resourceManager.getMediaContent($r('app.media.test').id, (error: BusinessError, value: Uint8Array) => {
    if (error != null) {
      console.error("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 content of a media file with the specified screen density based on the specified resource ID. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Error codes

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

Example

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

try {
  this.context.resourceManager.getMediaContent($r('app.media.test').id, 120, (error: BusinessError, value: Uint8Array) => {
    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 content of a media file based on the specified resource ID. This API uses a promise to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Error codes

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

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.error("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 content of a media file with the specified screen density based on the specified resource ID. This API uses a promise to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Error codes

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

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 content of a media file based on the specified resource object. This API uses an asynchronous callback to return the result. This API is used for cross-package access in a multi-project application. It works by creating the context of the corresponding module to obtain required resources.

System capability: SystemCapability.Global.ResourceManager

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

Parameters

Error codes

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

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: BusinessError, value: Uint8Array) => {
    if (error != null) {
      console.error("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 content of a media file with the specified screen density based on the specified resource object. This API uses an asynchronous callback to return the result. This API is used for cross-package access in a multi-project application. It works by creating the context of the corresponding module to obtain required resources.

System capability: SystemCapability.Global.ResourceManager

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

Parameters

Error codes

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

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: BusinessError, value: Uint8Array) => {
    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 content of a media file based on the specified resource object. This API uses a promise to return the result. This API is used for cross-package access in a multi-project application. It works by creating the context of the corresponding module to obtain required resources.

System capability: SystemCapability.Global.ResourceManager

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

Parameters

Return value

Error codes

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

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.error("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 content of a media file with the specified screen density based on the specified resource object. This API uses a promise to return the result. This API is used for cross-package access in a multi-project application. It works by creating the context of the corresponding module to obtain required resources.

System capability: SystemCapability.Global.ResourceManager

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

Parameters

Return value

Error codes

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

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 content of a media file based on the specified resource name. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Error codes

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

Example

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

try {
  this.context.resourceManager.getMediaByName("test", (error: BusinessError, value: Uint8Array) => {
    if (error != null) {
      console.error("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 content of a media file with the specified screen density based on the specified resource name. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Error codes

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

Example

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

try {
  this.context.resourceManager.getMediaByName("test", 120, (error: BusinessError, value: Uint8Array) => {
    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 content of a media file based on the specified resource name. This API uses a promise to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Error codes

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

Example

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

try {
  this.context.resourceManager.getMediaByName("test").then((value: Uint8Array) => {
    let media = value;
  }).catch((error: BusinessError) => {
    console.error("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 content of a media file with the specified screen density based on the specified resource name. This API uses a promise to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Error codes

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

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 an image with the default or specified screen density based on the specified resource ID. This API returns the result synchronously.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Error codes

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

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 an image with the default or specified screen density based on the specified resource object. This API returns the result synchronously. This API is used for cross-package access in a multi-project application. It works by creating the context of the corresponding module to obtain required resources.

System capability: SystemCapability.Global.ResourceManager

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

Parameters

Return value

Error codes

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

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 an image with the default or specified screen density based on the specified resource name. This API returns the result synchronously.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Error codes

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

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 an image based on the specified resource ID. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Error codes

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

Example

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

try {
  this.context.resourceManager.getMediaContentBase64($r('app.media.test').id, (error: BusinessError, value: string) => {
    if (error != null) {
      console.error("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 specified screen density based on the specified resource ID. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Error codes

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

Example

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

try {
  this.context.resourceManager.getMediaContentBase64($r('app.media.test').id, 120, (error: BusinessError, value: string) => {
    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 an image based on the specified resource ID. This API uses a promise to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Error codes

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

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.error("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 specified screen density based on the specified resource ID. This API uses a promise to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Error codes

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

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 an image based on the specified resource object. This API uses an asynchronous callback to return the result. This API is used for cross-package access in a multi-project application. It works by creating the context of the corresponding module to obtain required resources.

System capability: SystemCapability.Global.ResourceManager

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

Parameters

Error codes

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

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: BusinessError, value: string) => {
    if (error != null) {
      console.error("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 specified screen density based on the specified resource object. This API uses an asynchronous callback to return the result. This API is used for cross-package access in a multi-project application. It works by creating the context of the corresponding module to obtain required resources.

System capability: SystemCapability.Global.ResourceManager

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

Parameters

Error codes

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

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: BusinessError, value: string) => {
    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 an image based on the specified resource object. This API uses a promise to return the result. This API is used for cross-package access in a multi-project application. It works by creating the context of the corresponding module to obtain required resources.

System capability: SystemCapability.Global.ResourceManager

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

Parameters

Return value

Error codes

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

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.error("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 specified screen density based on the specified resource object. This API uses a promise to return the result. This API is used for cross-package access in a multi-project application. It works by creating the context of the corresponding module to obtain required resources.

System capability: SystemCapability.Global.ResourceManager

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

Parameters

Return value

Error codes

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

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 an image based on the specified resource name. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Error codes

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

Example

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

try {
  this.context.resourceManager.getMediaBase64ByName("test", (error: BusinessError, value: string) => {
    if (error != null) {
      console.error("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 specified screen density based on the specified resource name. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Error codes

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

Example

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

try {
  this.context.resourceManager.getMediaBase64ByName("test", 120, (error: BusinessError, value: string) => {
    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 an image based on the specified resource name. This API uses a promise to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Error codes

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

Example

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

try {
  this.context.resourceManager.getMediaBase64ByName("test").then((value: string) => {
    let media = value;
  }).catch((error: BusinessError) => {
    console.error("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 specified screen density based on the specified resource name. This API uses a promise to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Error codes

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

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 a DrawableDescriptor object for icon display based on the specified resource ID. This API returns the result synchronously.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Error codes

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

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}.`);
}
try {
  this.context.resourceManager.getDrawableDescriptor($r('app.media.icon').id, 0, 1);
} 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 a DrawableDescriptor object for icon display based on the specified resource object. This API returns the result synchronously. This API is used for cross-package access in a multi-project application. It works by creating the context of the corresponding module to obtain required resources.

System capability: SystemCapability.Global.ResourceManager

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

Parameters

Return value

Error codes

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

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}.`);
}
try {
  this.context.resourceManager.getDrawableDescriptor(resource, 0, 1);
} 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 a DrawableDescriptor object for icon display based on the specified resource name. This API returns the result synchronously.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Error codes

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

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}.`);
}
try {
  this.context.resourceManager.getDrawableDescriptorByName('icon', 0, 1);
} 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 a Boolean result based on the specified resource ID. This API returns the result synchronously.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Error codes

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

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 a Boolean result based on the specified resource object. This API returns the result synchronously. This API is used for cross-package access in a multi-project application. It works by creating the context of the corresponding module to obtain required resources.

System capability: SystemCapability.Global.ResourceManager

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

Parameters

Return value

Error codes

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

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 a Boolean result based on the specified resource name. This API returns the result synchronously.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Error codes

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

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 an integer or float value based on the specified resource ID. This API returns the result synchronously.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Error codes

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

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 an integer or float value based on the specified resource object. This API returns the result synchronously. This API is used for cross-package access in a multi-project application. It works by creating the context of the corresponding module to obtain required resources.

System capability: SystemCapability.Global.ResourceManager

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

Parameters

Return value

Error codes

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

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 an integer or float value based on the specified resource name. This API returns the result synchronously.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Error codes

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

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 a color value based on the specified resource ID. This API returns the result synchronously.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Error codes

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

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 a color value based on the specified resource object. This API returns the result synchronously. This API is used for cross-package access in a multi-project application. It works by creating the context of the corresponding module to obtain required resources.

System capability: SystemCapability.Global.ResourceManager

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

Parameters

Return value

Error codes

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

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 a color value based on the specified resource name. This API returns the result synchronously.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Error codes

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

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 a color value based on the specified resource ID. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Error codes

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

Example (stage)

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

try {
  this.context.resourceManager.getColor($r('app.color.test').id, (error: BusinessError, value: number) => {
    if (error != null) {
      console.error("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 a color value based on the specified resource ID. This API uses a promise to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Error codes

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

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.error("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 a color value based on the specified resource object. This API uses an asynchronous callback to return the result. This API is used for cross-package access in a multi-project application. It works by creating the context of the corresponding module to obtain required resources.

System capability: SystemCapability.Global.ResourceManager

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

Parameters

Error codes

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

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: BusinessError, value: number) => {
    if (error != null) {
      console.error("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 a color value based on the specified resource object. This API uses a promise to return the result. This API is used for cross-package access in a multi-project application. It works by creating the context of the corresponding module to obtain required resources.

System capability: SystemCapability.Global.ResourceManager

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

Parameters

Return value

Error codes

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

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.error("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 a color value based on the specified resource name. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Error codes

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

Example

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

try {
  this.context.resourceManager.getColorByName("test", (error: BusinessError, value: number) => {
    if (error != null) {
      console.error("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 a color value based on the specified resource name. This API uses a promise to return the result.

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value