!3342 资源api规范整改

Merge pull request !3342 from maoziduanl/master
This commit is contained in:
openharmony_ci 2022-11-17 06:45:03 +00:00 committed by Gitee
commit 657638edce
No known key found for this signature in database
GPG Key ID: 173E9B9CA92EEF8F

View File

@ -216,7 +216,7 @@ export function getResourceManager(bundleName: string, callback: AsyncCallback<R
/**
* Obtains the ResourceManager object of the current application.
*
* @return Returns that the ResourceManager object is returned in Promise mode.
* @returns Returns that the ResourceManager object is returned in Promise mode.
* @since 6
* @FAModelOnly
*/
@ -226,7 +226,7 @@ export function getResourceManager(): Promise<ResourceManager>;
* Obtains the ResourceManager object of the specified application.
*
* @param bundleName Indicates the bundle name of the specified application.
* @return Returns that the ResourceManager object is returned in Promise mode.
* @returns Returns that the ResourceManager object is returned in Promise mode.
* @since 6
* @FAModelOnly
*/
@ -253,7 +253,7 @@ export interface ResourceManager {
* Obtains string resources associated with a specified resource ID in Promise mode.
*
* @param resId Indicates the resource ID.
* @return Returns the character string corresponding to the resource ID.
* @returns Returns the character string corresponding to the resource ID.
* @since 6
* @deprecated since 9
* @useinstead ohos.resourceManager.getStringValue
@ -277,7 +277,7 @@ export interface ResourceManager {
* Obtains string resources associated with a specified resource object in Promise mode.
*
* @param resource Indicates the resource object.
* @return Returns the character string corresponding to the resource object.
* @returns Returns the character string corresponding to the resource object.
* @throws { BusinessError } 401 - If the input parameter invalid.
* @throws { BusinessError } 9001001 - If the module resId invalid.
* @throws { BusinessError } 9001002 - If the resource not found by module resId.
@ -301,7 +301,7 @@ export interface ResourceManager {
* Obtains the array of character strings corresponding to a specified resource ID in Promise mode.
*
* @param resId Indicates the resource ID.
* @return Returns the array of character strings corresponding to the specified resource ID.
* @returns Returns the array of character strings corresponding to the specified resource ID.
* @since 6
* @deprecated since 9
* @useinstead ohos.resourceManager.getStringArrayValue
@ -325,7 +325,7 @@ export interface ResourceManager {
* Obtains the array of character strings corresponding to a specified resource object in Promise mode.
*
* @param resource Indicates the resource object.
* @return Returns the array of character strings corresponding to the specified resource object.
* @returns Returns the array of character strings corresponding to the specified resource object.
* @throws { BusinessError } 401 - If the input parameter invalid.
* @throws { BusinessError } 9001001 - If the module resId invalid.
* @throws { BusinessError } 9001002 - If the resource not found by module resId.
@ -349,7 +349,7 @@ export interface ResourceManager {
* Obtains the content of the media file corresponding to a specified resource ID in Promise mode.
*
* @param resId Indicates the resource ID.
* @return Returns the content of the media file corresponding to the specified resource ID.
* @returns Returns the content of the media file corresponding to the specified resource ID.
* @since 6
* @deprecated since 9
* @useinstead ohos.resourceManager.getMediaContent
@ -372,7 +372,7 @@ export interface ResourceManager {
* Obtains the content of the media file corresponding to a specified resource object in Promise mode.
*
* @param resource Indicates the resource object.
* @return Returns the content of the media file corresponding to the specified resource object.
* @returns Returns the content of the media file corresponding to the specified resource object.
* @throws { BusinessError } 401 - If the input parameter invalid.
* @throws { BusinessError } 9001001 - If the module resId invalid.
* @throws { BusinessError } 9001002 - If the resource not found by module resId.
@ -396,7 +396,7 @@ export interface ResourceManager {
* Obtains the Base64 code of the image resource corresponding to the specified resource ID in Promise mode.
*
* @param resId Indicates the resource ID.
* @return Returns the Base64 code of the image resource corresponding to the specified resource ID.
* @returns Returns the Base64 code of the image resource corresponding to the specified resource ID.
* @since 6
* @deprecated since 9
* @useinstead ohos.resourceManager.getMediaContentBase64
@ -420,7 +420,7 @@ export interface ResourceManager {
* Obtains the Base64 code of the image resource corresponding to the specified resource object in Promise mode.
*
* @param resource Indicates the resource object.
* @return Returns the Base64 code of the image resource corresponding to the specified resource object.
* @returns Returns the Base64 code of the image resource corresponding to the specified resource object.
* @throws { BusinessError } 401 - If the input parameter invalid.
* @throws { BusinessError } 9001001 - If the module resId invalid.
* @throws { BusinessError } 9001002 - If the resource not found by module resId.
@ -439,7 +439,7 @@ export interface ResourceManager {
/**
* Obtains the device capability in Promise mode.
*
* @return Returns the device capability.
* @returns Returns the device capability.
* @since 6
*/
getDeviceCapability(): Promise<DeviceCapability>;
@ -481,7 +481,7 @@ export interface ResourceManager {
*
* @param resId Indicates the resource ID.
* @param num Indicates the number.
* @return Returns the singular-plural character string represented by the ID string
* @returns Returns the singular-plural character string represented by the ID string
* corresponding to the specified number.
* @since 6
* @deprecated since 9
@ -511,7 +511,7 @@ export interface ResourceManager {
*
* @param resource Indicates the resource object.
* @param num Indicates the number.
* @return Returns the singular-plural character string represented by the resource object string
* @returns Returns the singular-plural character string represented by the resource object string
* corresponding to the specified number.
* @throws { BusinessError } 401 - If the input parameter invalid.
* @throws { BusinessError } 9001001 - If the resId invalid.
@ -536,7 +536,7 @@ export interface ResourceManager {
* Obtains the raw file resource corresponding to the specified resource path in Promise mode.
*
* @param path Indicates the resource relative path.
* @return Returns the raw file resource corresponding to the specified resource path.
* @returns Returns the raw file resource corresponding to the specified resource path.
* @since 8
* @deprecated since 9
* @useinstead ohos.resourceManager.getRawFileContent
@ -558,7 +558,7 @@ export interface ResourceManager {
* Obtains the raw file resource descriptor corresponding to the specified resource path in Promise mode.
*
* @param path Indicates the resource relative path.
* @return Returns the raw file resource descriptor corresponding to the specified resource path.
* @returns Returns the raw file resource descriptor corresponding to the specified resource path.
* @since 8
* @deprecated since 9
* @useinstead ohos.resourceManager.getRawFd
@ -580,7 +580,7 @@ export interface ResourceManager {
* Obtains close raw file resource descriptor corresponding to the specified resource path in Promise mode.
*
* @param path Indicates the resource relative path.
* @return Returns result close raw file resource descriptor corresponding to the specified resource path.
* @returns Returns result close raw file resource descriptor corresponding to the specified resource path.
* @since 8
* @deprecated since 9
* @useinstead ohos.resourceManager.closeRawFd
@ -604,7 +604,7 @@ export interface ResourceManager {
* Obtains string resources associated with a specified resource name in Promise mode.
*
* @param resName Indicates the resource name.
* @return Returns the character string corresponding to the resource name.
* @returns Returns the character string corresponding to the resource name.
* @throws { BusinessError } 401 - If the input parameter invalid.
* @throws { BusinessError } 9001003 - If the resName invalid.
* @throws { BusinessError } 9001004 - If the resource not found by resName.
@ -630,7 +630,7 @@ export interface ResourceManager {
* Obtains the array of character strings corresponding to a specified resource name in Promise mode.
*
* @param resName Indicates the resource name.
* @return Returns the array of character strings corresponding to the specified resource name.
* @returns Returns the array of character strings corresponding to the specified resource name.
* @throws { BusinessError } 401 - If the input parameter invalid.
* @throws { BusinessError } 9001003 - If the resName invalid.
* @throws { BusinessError } 9001004 - If the resource not found by resName.
@ -655,7 +655,7 @@ export interface ResourceManager {
* Obtains the content of the media file corresponding to a specified resource name in Promise mode.
*
* @param resName Indicates the resource name.
* @return Returns the content of the media file corresponding to the specified resource name.
* @returns Returns the content of the media file corresponding to the specified resource name.
* @throws { BusinessError } 401 - If the input parameter invalid.
* @throws { BusinessError } 9001003 - If the resName invalid.
* @throws { BusinessError } 9001004 - If the resource not found by resName.
@ -680,7 +680,7 @@ export interface ResourceManager {
* Obtains the Base64 code of the image resource corresponding to the specified resource name in Promise mode.
*
* @param resName Indicates the resource name.
* @return Returns the Base64 code of the image resource corresponding to the specified resource name.
* @returns Returns the Base64 code of the image resource corresponding to the specified resource name.
* @throws { BusinessError } 401 - If the input parameter invalid.
* @throws { BusinessError } 9001003 - If the resName invalid.
* @throws { BusinessError } 9001004 - If the resource not found by resName.
@ -710,7 +710,7 @@ export interface ResourceManager {
*
* @param resName Indicates the resource name.
* @param num Indicates the number.
* @return Returns the singular-plural character string represented by the name string
* @returns Returns the singular-plural character string represented by the name string
* corresponding to the specified number.
* @throws { BusinessError } 401 - If the input parameter invalid.
* @throws { BusinessError } 9001003 - If the resName invalid.
@ -724,7 +724,7 @@ export interface ResourceManager {
* Obtains string resources associated with a specified resource ID.
*
* @param resId Indicates the resource ID.
* @return Returns the character string corresponding to the resource ID.
* @returns Returns the character string corresponding to the resource ID.
* @throws { BusinessError } 401 - If the input parameter invalid.
* @throws { BusinessError } 9001001 - If the resId invalid.
* @throws { BusinessError } 9001002 - If the resource not found by resId.
@ -737,7 +737,7 @@ export interface ResourceManager {
* Obtains string resources associated with a specified resource object.
*
* @param resource Indicates the resource object.
* @return Returns the character string corresponding to the resource object.
* @returns Returns the character string corresponding to the resource object.
* @throws { BusinessError } 401 - If the input parameter invalid.
* @throws { BusinessError } 9001001 - If the module resId invalid.
* @throws { BusinessError } 9001002 - If the resource not found by module resId.
@ -750,7 +750,7 @@ export interface ResourceManager {
* Obtains string resources associated with a specified resource name.
*
* @param resName Indicates the resource name.
* @return Returns the character string corresponding to the resource name.
* @returns Returns the character string corresponding to the resource name.
* @throws { BusinessError } 401 - If the input parameter invalid.
* @throws { BusinessError } 9001003 - If the resName invalid.
* @throws { BusinessError } 9001004 - If the resource not found by resName.
@ -763,7 +763,7 @@ export interface ResourceManager {
* Obtains the boolean result with a specified resource ID.
*
* @param resId Indicates the resource ID.
* @return Returns the boolean resource corresponding to the resource ID.
* @returns Returns the boolean resource corresponding to the resource ID.
* @throws { BusinessError } 401 - If the input parameter invalid.
* @throws { BusinessError } 9001001 - If the resId invalid.
* @throws { BusinessError } 9001002 - If the resource not found by resId.
@ -776,7 +776,7 @@ export interface ResourceManager {
* Obtains the boolean result with a specified resource object.
*
* @param resource Indicates the resource object.
* @return Returns the boolean resource corresponding to the resource object.
* @returns Returns the boolean resource corresponding to the resource object.
* @throws { BusinessError } 401 - If the input parameter invalid.
* @throws { BusinessError } 9001001 - If the module resId invalid.
* @throws { BusinessError } 9001002 - If the resource not found by module resId.
@ -789,7 +789,7 @@ export interface ResourceManager {
* Obtains the boolean result with a specified resource name.
*
* @param resName Indicates the resource name.
* @return Returns the boolean resource corresponding to the resource name.
* @returns Returns the boolean resource corresponding to the resource name.
* @throws { BusinessError } 401 - If the input parameter invalid.
* @throws { BusinessError } 9001003 - If the resName invalid.
* @throws { BusinessError } 9001004 - If the resource not found by resName.
@ -802,7 +802,7 @@ export interface ResourceManager {
* Obtains the number result with a specified resource ID.
*
* @param resId Indicates the resource ID.
* @return Returns the number resource corresponding to the resource ID.
* @returns Returns the number resource corresponding to the resource ID.
* @throws { BusinessError } 401 - If the input parameter invalid.
* @throws { BusinessError } 9001001 - If the resId invalid.
* @throws { BusinessError } 9001002 - If the resource not found by resId.
@ -815,7 +815,7 @@ export interface ResourceManager {
* Obtains the number result with a specified resource object.
*
* @param resource Indicates the resource object.
* @return Returns the number resource corresponding to the resource object.
* @returns Returns the number resource corresponding to the resource object.
* @throws { BusinessError } 401 - If the input parameter invalid.
* @throws { BusinessError } 9001001 - If the module resId invalid.
* @throws { BusinessError } 9001002 - If the resource not found by module resId.
@ -828,7 +828,7 @@ export interface ResourceManager {
* Obtains the number result with a specified resource name.
*
* @param resName Indicates the resource name.
* @return Returns the number resource corresponding to the resource name.
* @returns Returns the number resource corresponding to the resource name.
* @throws { BusinessError } 401 - If the input parameter invalid.
* @throws { BusinessError } 9001003 - If the resName invalid.
* @throws { BusinessError } 9001004 - If the resource not found by resName.
@ -861,7 +861,7 @@ export interface ResourceManager {
* Obtains string resources associated with a specified resource ID in Promise mode.
*
* @param resId Indicates the resource ID.
* @return Returns the character string corresponding to the resource ID.
* @returns Returns the character string corresponding to the resource ID.
* @throws { BusinessError } 401 - If the input parameter invalid.
* @throws { BusinessError } 9001001 - If the resId invalid.
* @throws { BusinessError } 9001002 - If the resource not found by resId.
@ -887,7 +887,7 @@ export interface ResourceManager {
* Obtains the array of character strings corresponding to a specified resource ID in Promise mode.
*
* @param resId Indicates the resource ID.
* @return Returns the array of character strings corresponding to the specified resource ID.
* @returns Returns the array of character strings corresponding to the specified resource ID.
* @throws { BusinessError } 401 - If the input parameter invalid.
* @throws { BusinessError } 9001001 - If the resId invalid.
* @throws { BusinessError } 9001002 - If the resource not found by resId.
@ -918,7 +918,7 @@ export interface ResourceManager {
*
* @param resId Indicates the resource ID.
* @param num Indicates the number.
* @return Returns the singular-plural character string represented by the ID string
* @returns Returns the singular-plural character string represented by the ID string
* corresponding to the specified number.
* @throws { BusinessError } 401 - If the input parameter invalid.
* @throws { BusinessError } 9001001 - If the resId invalid.
@ -944,7 +944,7 @@ export interface ResourceManager {
* Obtains the content of the media file corresponding to a specified resource ID in Promise mode.
*
* @param resId Indicates the resource ID.
* @return Returns the content of the media file corresponding to the specified resource ID.
* @returns Returns the content of the media file corresponding to the specified resource ID.
* @throws { BusinessError } 401 - If the input parameter invalid.
* @throws { BusinessError } 9001001 - If the resId invalid.
* @throws { BusinessError } 9001002 - If the resource not found by resId.
@ -969,7 +969,7 @@ export interface ResourceManager {
* Obtains the Base64 code of the image resource corresponding to the specified resource ID in Promise mode.
*
* @param resId Indicates the resource ID.
* @return Returns the Base64 code of the image resource corresponding to the specified resource ID.
* @returns Returns the Base64 code of the image resource corresponding to the specified resource ID.
* @throws { BusinessError } 401 - If the input parameter invalid.
* @throws { BusinessError } 9001001 - If the resId invalid.
* @throws { BusinessError } 9001002 - If the resource not found by resId.
@ -992,7 +992,7 @@ export interface ResourceManager {
* Obtains the raw file resource corresponding to the specified resource path in Promise mode.
*
* @param path Indicates the resource relative path.
* @return Returns the raw file resource corresponding to the specified resource path.
* @returns Returns the raw file resource corresponding to the specified resource path.
* @throws { BusinessError } 401 - If the input parameter invalid.
* @throws { BusinessError } 9001005 - If the resource not found by path.
* @since 9
@ -1014,7 +1014,7 @@ export interface ResourceManager {
* Obtains the raw file resource descriptor corresponding to the specified resource path in Promise mode.
*
* @param path Indicates the resource relative path.
* @return Returns the raw file resource descriptor corresponding to the specified resource path.
* @returns Returns the raw file resource descriptor corresponding to the specified resource path.
* @throws { BusinessError } 401 - If the input parameter invalid.
* @throws { BusinessError } 9001005 - If the resource not found by path.
* @since 9