@ohos.resourceManager (Resource Manager)

The Resource Manager 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';

Instruction

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

export default class EntryAbility extends UIAbility {
    onWindowStageCreate(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.

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

System capability: SystemCapability.Global.ResourceManager

Parameters

Example

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

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.

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

System capability: SystemCapability.Global.ResourceManager

Parameters

Example

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

resourceManager.getResourceManager

getResourceManager(): Promise<ResourceManager>

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

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

System capability: SystemCapability.Global.ResourceManager

Return value

Example

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

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.

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

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Example

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

Direction

Enumerates the screen directions.

System capability: SystemCapability.Global.ResourceManager

DeviceType

Enumerates the device types.

System capability: SystemCapability.Global.ResourceManager

ScreenDensity

Enumerates the screen density types.

System capability: SystemCapability.Global.ResourceManager

Configuration

Defines the device configuration.

System capability: SystemCapability.Global.ResourceManager

Parameters

Example

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

DeviceCapability

Defines the device capability.

System capability: SystemCapability.Global.ResourceManager

Parameters

Example

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

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 APIs 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.

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

Error codes

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

Example (stage)

  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) {
      console.error(`callback getStringValue failed, error code: ${error.code}, message: ${error.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

Return value

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

Error codes

Example

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

Parameters

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

Error codes

Example

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

Parameters

Return value

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

Error codes

Example

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

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

Error codes

Example

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

Return value

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

Error codes

Example

try {
  this.context.resourceManager.getStringArrayValue($r('app.strarray.test').id).then(value => {
      let strArray = value;
  }).catch(error => {
      console.log("getStringArrayValue promise error is " + error);
  });
} catch (error) {
  console.error(`promise getStringArrayValue failed, error code: ${error.code}, message: ${error.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

Parameters

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

Error codes

Example

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

Parameters

Return value

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

Error codes

Example

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

getMediaContent⁹⁺

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

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

System capability: SystemCapability.Global.ResourceManager

Parameters

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

Error codes

Example

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

getMediaContent⁹⁺

getMediaContent(resId: number): Promise<Uint8Array>

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

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

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

Error codes

Example

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

getMediaContent⁹⁺

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

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

System capability: SystemCapability.Global.ResourceManager

Parameters

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

Error codes

Example

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

getMediaContent⁹⁺

getMediaContent(resource: Resource): Promise<Uint8Array>

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

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

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

Error codes

Example

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

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

Error codes

Example

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) {
  console.error(`callback getMediaContentBase64 failed, error code: ${error.code}, message: ${error.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

Return value

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

Error codes

Example

try {
  this.context.resourceManager.getMediaContentBase64($r('app.media.test').id).then(value => {
      let media = value;
  }).catch(error => {
      console.log("getMediaContentBase64 promise error is " + error);
  });
} catch (error) {
  console.error(`promise getMediaContentBase64 failed, error code: ${error.code}, message: ${error.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

Parameters

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

Error codes

Example

let 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) {
  console.error(`promise getMediaContentBase64 failed, error code: ${error.code}, message: ${error.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

Parameters

Return value

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

Error codes

Example

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

getConfiguration

getConfiguration(callback: AsyncCallback<Configuration>): void

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

System capability: SystemCapability.Global.ResourceManager

Parameters

Example

resourceManager.getResourceManager((error, mgr) => {
    mgr.getConfiguration((error, value) => {
        if (error != null) {
            console.log("error is " + error);
        } else {
            let direction = value.direction;
            let locale = value.locale;
        }
    });
});

getConfiguration

getConfiguration(): Promise<Configuration>

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

System capability: SystemCapability.Global.ResourceManager

Return value

Example

resourceManager.getResourceManager((error, mgr) => {
    mgr.getConfiguration().then(value => {
        let direction = value.direction;
        let locale = value.locale;
    }).catch(error => {
        console.log("getConfiguration promise error is " + error);
    });
});

getDeviceCapability

getDeviceCapability(callback: AsyncCallback<DeviceCapability>): void

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

System capability: SystemCapability.Global.ResourceManager

Parameters

Example

resourceManager.getResourceManager((error, mgr) => {
    mgr.getDeviceCapability((error, value) => {
        if (error != null) {
            console.log("error is " + error);
        } else {
            let screenDensity = value.screenDensity;
            let deviceType = value.deviceType;
        }
    });
});

getDeviceCapability

getDeviceCapability(): Promise<DeviceCapability>

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

System capability: SystemCapability.Global.ResourceManager

Return value

Example

resourceManager.getResourceManager((error, mgr) => {
    mgr.getDeviceCapability().then(value => {
        let screenDensity = value.screenDensity;
        let deviceType = value.deviceType;
    }).catch(error => {
        console.log("getDeviceCapability promise error is " + error);
    });
});

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

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

Error codes

Example

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

Return value

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

Error codes

Example

try {
  this.context.resourceManager.getPluralStringValue($r("app.plural.test").id, 1).then(value => {
      let str = value;
  }).catch(error => {
      console.log("getPluralStringValue promise error is " + error);
  });
} catch (error) {
  console.error(`callback getPluralStringValue failed, error code: ${error.code}, message: ${error.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

Parameters

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

Error codes

Example

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

Parameters

Return value

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

Error codes

Example

let resource = {
    bundleName: "com.example.myapplication",
    moduleName: "entry",
    id: $r('app.plural.test').id
};
try {
  this.context.resourceManager.getPluralStringValue(resource, 1).then(value => {
      let str = value;
  }).catch(error => {
      console.log("getPluralStringValue promise error is " + error);
  });
} catch (error) {
  console.error(`callback getPluralStringValue failed, error code: ${error.code}, message: ${error.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

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

Error codes

Example

try {
  this.context.resourceManager.getRawFileContent("test.xml", (error, value) => {
      if (error != null) {
          console.log("error is " + error);
      } else {
          let rawFile = value;
      }
  });
} catch (error) {
  console.error(`callback getRawFileContent failed, error code: ${error.code}, message: ${error.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

Return value

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

Error codes

Example

try {
  this.context.resourceManager.getRawFileContent("test.xml").then(value => {
      let rawFile = value;
  }).catch(error => {
      console.log("getRawFileContent promise error is " + error);
  });
} catch (error) {
  console.error(`promise getRawFileContent failed, error code: ${error.code}, message: ${error.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

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

Error codes

Example

try {
  this.context.resourceManager.getRawFd("test.xml", (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) {
    console.error(`callback getRawFd failed, error code: ${error.code}, message: ${error.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

Return value

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

Error codes

Example

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

closeRawFileDescriptor⁸⁺

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

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

System capability: SystemCapability.Global.ResourceManager

Parameters

Example

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

closeRawFileDescriptor⁸⁺

closeRawFileDescriptor(path: string): Promise<void>

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

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Example

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

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

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

Error codes

Example

try {
  this.context.resourceManager.closeRawFd("test.xml", (error, value) => {
      if (error != null) {
          console.log("error is " + error);
      }
  });
} catch (error) {
  console.error(`callback closeRawFd failed, error code: ${error.code}, message: ${error.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

Return value

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

Error codes

Example

try {
  this.context.resourceManager.closeRawFd("test.xml").then(value => {
      let result = value;
  }).catch(error => {
      console.log("closeRawFd promise error is " + error);
  });
} catch (error) {
  console.error(`promise closeRawFd failed, error code: ${error.code}, message: ${error.message}.`)
}

release⁷⁺

release()

Releases a created resourceManager object.

System capability: SystemCapability.Global.ResourceManager

Example

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

getStringByName⁹⁺

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

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

System capability: SystemCapability.Global.ResourceManager

Parameters

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

Error codes

Example

try {
  this.context.resourceManager.getStringByName("test", (error, value) => {
      if (error != null) {
           console.log("error is " + error);
      } else {
          let string = value;
      }
  });
} catch (error) {
  console.error(`callback getStringByName failed, error code: ${error.code}, message: ${error.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

Return value

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

Error codes

Example

try {
  this.context.resourceManager.getStringByName("test").then(value => {
      let string = value;
  }).catch(error => {
      console.log("getStringByName promise error is " + error);
  });
} catch (error) {
  console.error(`promise getStringByName failed, error code: ${error.code}, message: ${error.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

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

Error codes

Example

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

Return value

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

Error codes

Example

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

getMediaByName⁹⁺

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

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

System capability: SystemCapability.Global.ResourceManager

Parameters

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

Error codes

Example

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

getMediaByName⁹⁺

getMediaByName(resName: string): Promise<Uint8Array>

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

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

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

Error codes

Example

try {
  this.context.resourceManager.getMediaByName("test").then(value => {
      let media = value;
  }).catch(error => {
      console.log("getMediaByName promise error is " + error);
  });
} catch (error) {
  console.error(`promise getMediaByName failed, error code: ${error.code}, message: ${error.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

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

Error codes

Example

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

Return value

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

Error codes

Example

try {
  this.context.resourceManager.getMediaBase64ByName("test").then(value => {
      let media = value;
  }).catch(error => {
      console.log("getMediaBase64ByName promise error is " + error);
  });
} catch (error) {
  console.error(`promise getMediaBase64ByName failed, error code: ${error.code}, message: ${error.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

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

Error codes

Example

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

Return value

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

Error codes

Example

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

getStringSync⁹⁺

getStringSync(resId: number): string

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

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

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

Error codes

Example

try {
  this.context.resourceManager.getStringSync($r('app.string.test').id);
} catch (error) {
  console.error(`getStringSync failed, error code: ${error.code}, message: ${error.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

Parameters

Return value

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

Error codes

Example

let resource = {
    bundleName: "com.example.myapplication",
    moduleName: "entry",
    id: $r('app.string.test').id
};
try {
  this.context.resourceManager.getStringSync(resource);
} catch (error) {
  console.error(`getStringSync failed, error code: ${error.code}, message: ${error.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

Return value

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

Error codes

Example

try {
  this.context.resourceManager.getStringByNameSync("test");
} catch (error) {
  console.error(`getStringByNameSync failed, error code: ${error.code}, message: ${error.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

Return value

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

Error codes

Example

try {
  this.context.resourceManager.getBoolean($r('app.boolean.boolean_test').id);
} catch (error) {
  console.error(`getBoolean failed, error code: ${error.code}, message: ${error.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

Parameters

Return value

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

Error codes

Example

let resource = {
    bundleName: "com.example.myapplication",
    moduleName: "entry",
    id: $r('app.boolean.boolean_test').id
};
try {
  this.context.resourceManager.getBoolean(resource);
} catch (error) {
  console.error(`getBoolean failed, error code: ${error.code}, message: ${error.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

Return value

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

Error codes

Example

try {
  this.context.resourceManager.getBooleanByName("boolean_test");
} catch (error) {
  console.error(`getBooleanByName failed, error code: ${error.code}, message: ${error.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

Return value

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

Error codes

Example

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

try {
  this.context.resourceManager.getNumber($r('app.float.float_test').id); // float refers to the actual pixel value.
} catch (error) {
  console.error(`getNumber failed, error code: ${error.code}, message: ${error.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

Parameters

Return value

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

Error codes

Example

let 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) {
  console.error(`getNumber failed, error code: ${error.code}, message: ${error.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

Return value

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

Error codes

Example

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

try {
  this.context.resourceManager.getNumberByName("float_test");
} catch (error) {
  console.error(`getNumberByName failed, error code: ${error.code}, message: ${error.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

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

Return value

Example

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

getStringArray^(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

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

Return value

Example

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

getMedia^(deprecated)

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

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

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

System capability: SystemCapability.Global.ResourceManager

Parameters

Example

resourceManager.getResourceManager((error, mgr) => {
    mgr.getMedia($r('app.media.test').id, (error, value) => {
        if (error != null) {
            console.log("error is " + error);
        } else {
            let media = value;
        }
    });
});

getMedia^(deprecated)

getMedia(resId: number): Promise<Uint8Array>

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

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

System capability: SystemCapability.Global.ResourceManager

Parameters

Return value

Example

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

getMediaBase64^(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

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

Return value

Example

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

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

Return value

Example

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

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

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

Example

resourceManager.getResourceManager((error, mgr) => {
    mgr.getRawFile("test.xml", (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

Return value

Example

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

getRawFileDescriptor^(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

Example

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

getRawFileDescriptor^(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

Return value

Example

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