diff --git a/README_zh.md b/README_zh.md index 21846d91b8adec8fa349e614fb8dd3fb7ddfc319..3b699b495ac94d927cdc76afb24a20bb2e9dcb48 100644 --- a/README_zh.md +++ b/README_zh.md @@ -1,4 +1,5 @@ -# API声明文件公共仓 + API声明文件公共仓 + - [简介](#section11660541593) diff --git a/api/@ohos.ability.ability.d.ts b/api/@ohos.ability.ability.d.ts index 44be58f12e8b9ef4cb8065dcefc71c68003f576b..17028a16b12ffecba9971bf05383f2d21fcbea41 100755 --- a/api/@ohos.ability.ability.d.ts +++ b/api/@ohos.ability.ability.d.ts @@ -37,8 +37,26 @@ declare namespace ability { * @since 9 * @FAModelOnly */ - export type DataAbilityHelper = _DataAbilityHelper + export type DataHelper = _DataAbilityHelper + + /** + * DataAbilityHelper + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel + * + * @since 9 + * @FAModelOnly + */ + export type testType = boolean | number; + /** + * DataAbilityHelper + * @syscap SystemCapability.Ability.AbilityRuntime.FAModel + * + * @since 9 + * @FAModelOnly + */ + export type teebtbtbtType = number; + /** * Defines a PacMap object for storing a series of values. * @since 9 diff --git a/api/@ohos.ability.errorCode.d.ts b/api/@ohos.ability.errorCode.d.ts index 155f039766c9f43e869df44ef695970b524b57f8..bf91c412cea59d42db2861516704e7c5b579aa9a 100644 --- a/api/@ohos.ability.errorCode.d.ts +++ b/api/@ohos.ability.errorCode.d.ts @@ -18,32 +18,53 @@ * @since 6 * @syscap SystemCapability.Ability.AbilityRuntime.Core */ -export enum ErrorCode { - /** - * Permission denied. - * @since 6 - * @syscap SystemCapability.Ability.AbilityRuntime.Core - */ - PERMISSION_DENY = -3, - - /** - * Ability not found. - * @since 6 - * @syscap SystemCapability.Ability.AbilityRuntime.Core - */ - ABILITY_NOT_FOUND = -2, - - /** - * Invalid parameter. - * @since 6 - * @syscap SystemCapability.Ability.AbilityRuntime.Core - */ - INVALID_PARAMETER = -1, - - /** - * No error. - * @since 6 - * @syscap SystemCapability.Ability.AbilityRuntime.Core - */ - NO_ERROR = 0 -} + export enum ErrorCode { + /** + * Permission denied. + * @since 6 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + */ + PERMISSION_DENY = -3, + + /** + * Ability not found. + * @since 6 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + */ + ABILITY_NOT_FOUND = -2, + + /** + * Invalid parameter. + * @since 6 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + */ + INVALID_PARAMETER = -1, + + /** + * Invalid parameter. + * @since 6 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + */ + enumValueSyscabcp = -10, + + /** + * Invalid parameter. + * @since 6 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + */ + enumValueSyscap = -12, + + /** + * Invalid parameter. + * @since 6 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + */ + enumSyscap = -11, + + /** + * No error. + * @since 6 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + */ + NO_ERROR = 0 + } \ No newline at end of file diff --git a/api/@ohos.account.appAccount.d.ts b/api/@ohos.account.appAccount.d.ts index c1c808ad92bd76176f2a1a85d9a7947be5cdde77..8d7558beeab8fad511c8f27e14d47e6a5757e1ea 100644 --- a/api/@ohos.account.appAccount.d.ts +++ b/api/@ohos.account.appAccount.d.ts @@ -95,6 +95,7 @@ declare namespace appAccount { * @throws {BusinessError} 401 - the parameter check failed. * @throws {BusinessError} 12300001 - system service exception. * @throws {BusinessError} 12300002 - invalid owner or options. + * @throws {BusinessError} 12300010 - account service busy. * @throws {BusinessError} 12300011 - the account number has reached the upper limit. * @throws {BusinessError} 12400002 - the account authenticator service does not exist. * @since 9 @@ -427,7 +428,7 @@ declare namespace appAccount { * @throws {BusinessError} 401 - the parameter check failed. * @throws {BusinessError} 12300001 - system service exception. * @throws {BusinessError} 12300002 - invalid owner. - * @throws {BusinessError} 12300003 - the account indicated by owner dose not exist. + * @throws {BusinessError} 12400001 - the application indicated by bundlename does not exist. * @since 9 */ getAccountsByOwner(owner: string, callback: AsyncCallback>): void; @@ -507,6 +508,7 @@ declare namespace appAccount { * @throws {BusinessError} 12300001 - system service exception. * @throws {BusinessError} 12300002 - invalid name or key. * @throws {BusinessError} 12300003 - the account indicated by name dose not exist. + * @throws {BusinessError} 12400009 - the customData does not exist. * @since 9 */ getCustomDataSync(name: string, key: string): string; @@ -536,8 +538,8 @@ declare namespace appAccount { * @throws {BusinessError} 401 - the parameter check failed. * @throws {BusinessError} 12300001 - system service exception. * @throws {BusinessError} 12300002 - invalid type or owners. - * @throws {BusinessError} 12300003 - the account indicated by owners dose not exist. * @throws {BusinessError} 12300005 - the listener has been registered. + * @throws {BusinessError} 12400001 - the application indicated by bundlename does not exist. * @since 9 */ on(type: 'accountChange', owners: Array, callback: Callback>): void; @@ -557,7 +559,7 @@ declare namespace appAccount { * @throws {BusinessError} 401 - the parameter check failed. * @throws {BusinessError} 12300001 - system service exception. * @throws {BusinessError} 12300002 - invalid type. - * @throws {BusinessError} 12300005 - the listener has been registered. + * @throws {BusinessError} 12300006 - the listener has not been registered. * @since 9 */ off(type: 'accountChange', callback?: Callback>): void; @@ -588,10 +590,10 @@ declare namespace appAccount { * @throws {BusinessError} 12300001 - system service exception. * @throws {BusinessError} 12300002 - invalid name, owner, authType or options. * @throws {BusinessError} 12300003 - the account indicated by owner dose not exist. - * @throws {BusinessError} 12300016 - authentication timeout. + * @throws {BusinessError} 12300010 - authentication timeout. * @throws {BusinessError} 12300017 - authentication service is busy. * @throws {BusinessError} 12300018 - authentication service is locked. - * @throws {BusinessError} 12400001 - the application indicated by name does not exist. + * @throws {BusinessError} 12400002 - the account authenticator service does not exist. * @since 9 */ auth(name: string, owner: string, authType: string, callback: AuthCallback): void; @@ -620,8 +622,7 @@ declare namespace appAccount { * @throws {BusinessError} 12300001 - system service exception. * @throws {BusinessError} 12300002 - invalid name, owner or authType. * @throws {BusinessError} 12300003 - the account indicated by owner dose not exist. - * @throws {BusinessError} 12300015 - the authType is not supported on current device. - * @throws {BusinessError} 12400001 - the application indicated by name does not exist. + * @throws {BusinessError} 12400004 - the authType is not found. * @since 9 */ getAuthToken(name: string, owner: string, authType: string, callback: AsyncCallback): void; @@ -654,8 +655,6 @@ declare namespace appAccount { * @throws {BusinessError} 12300001 - system service exception. * @throws {BusinessError} 12300002 - invalid name, owner, authType or token. * @throws {BusinessError} 12300003 - the account indicated by name dose not exist. - * @throws {BusinessError} 12300015 - the authType is not supported on current device. - * @throws {BusinessError} 12300019 - credential does not exist. * @throws {BusinessError} 12400007 - the number of token has reached the upper limit. * @since 9 */ @@ -691,8 +690,7 @@ declare namespace appAccount { * @throws {BusinessError} 12300001 - system service exception. * @throws {BusinessError} 12300002 - invalid name, owner, authType or token. * @throws {BusinessError} 12300003 - the account indicated by name dose not exist. - * @throws {BusinessError} 12300015 - the authType is not supported on current device. - * @throws {BusinessError} 12300019 - credential does not exist. + * @throws {BusinessError} 12400004 - the authType is not found. * @since 9 */ deleteAuthToken(name: string, owner: string, authType: string, token: string, callback: AsyncCallback): void; @@ -727,8 +725,9 @@ declare namespace appAccount { * @throws {BusinessError} 12300001 - system service exception. * @throws {BusinessError} 12300002 - invalid name, authType or bundleName. * @throws {BusinessError} 12300003 - the account indicated by name dose not exist. - * @throws {BusinessError} 12300015 - the authType is not supported on current device. - * @throws {BusinessError} 12300019 - credential does not exist. + * @throws {BusinessError} 12400001 - the application indicated by name does not exist. + * @throws {BusinessError} 12400004 - the authType is not found. + * @throws {BusinessError} 12400006 - the size of authorization list reaches the upper limit. * @since 9 */ setAuthTokenVisibility(name: string, authType: string, bundleName: string, isVisible: boolean, callback: AsyncCallback): void; @@ -761,8 +760,8 @@ declare namespace appAccount { * @throws {BusinessError} 12300001 - system service exception. * @throws {BusinessError} 12300002 - invalid name, authType or bundleName. * @throws {BusinessError} 12300003 - the account indicated by name dose not exist. - * @throws {BusinessError} 12300015 - the authType is not supported on current device. - * @throws {BusinessError} 12300019 - credential does not exist. + * @throws {BusinessError} 12400001 - the application indicated by name does not exist. + * @throws {BusinessError} 12400004 - the authType is not found. * @since 9 */ checkAuthTokenVisibility(name: string, authType: string, bundleName: string, callback: AsyncCallback): void; @@ -819,8 +818,7 @@ declare namespace appAccount { * @throws {BusinessError} 12300001 - system service exception. * @throws {BusinessError} 12300002 - invalid name or authType. * @throws {BusinessError} 12300003 - the account indicated by name dose not exist. - * @throws {BusinessError} 12300015 - the authType is not supported on current device. - * @throws {BusinessError} 12300019 - credential does not exist. + * @throws {BusinessError} 12400004 - the authType is not found. * @since 9 */ getAuthList(name: string, authType: string, callback: AsyncCallback>): void; @@ -847,6 +845,7 @@ declare namespace appAccount { * @returns Returns the authenticator callback related to the session id. * @throws {BusinessError} 401 - the parameter check failed. * @throws {BusinessError} 12300001 - system service exception. + * @throws {BusinessError} 12300002 - invalid session id. * @throws {BusinessError} 12400005 - the session indicated by sessionId does not exist. * @since 9 */ @@ -871,7 +870,7 @@ declare namespace appAccount { * @throws {BusinessError} 401 - the parameter check failed. * @throws {BusinessError} 12300001 - system service exception. * @throws {BusinessError} 12300002 - invalid owner. - * @throws {BusinessError} 12300003 - the account indicated by owner dose not exist. + * @throws {BusinessError} 12400002 - the account authenticator service does not exist. * @since 9 */ queryAuthenticatorInfo(owner: string, callback: AsyncCallback): void; @@ -885,9 +884,10 @@ declare namespace appAccount { * @returns boolean * @throws {BusinessError} 401 - the parameter check failed. * @throws {BusinessError} 12300001 - system service exception. - * @throws {BusinessError} 12300002 - invalid name or owner. + * @throws {BusinessError} 12300002 - invalid name, owner or labels. * @throws {BusinessError} 12300003 - the account indicated by owner dose not exist. - * @throws {BusinessError} 12400001 - the application indicated by name does not exist. + * @throws {BusinessError} 12300010 - account service busy. + * @throws {BusinessError} 12400002 - the account authenticator service does not exist. * @since 9 */ checkAccountLabels(name: string, owner: string, labels: Array, callback: AsyncCallback): void; @@ -901,8 +901,8 @@ declare namespace appAccount { * @throws {BusinessError} 401 - the parameter check failed. * @throws {BusinessError} 12300001 - system service exception. * @throws {BusinessError} 12300002 - invalid name or credentialType. + * @throws {BusinessError} 12300003 - the account indicated by name dose not exist. * @throws {BusinessError} 12300019 - credential does not exist. - * @throws {BusinessError} 12400001 - the application indicated by name does not exist. * since 9 */ deleteCredential(name: string, credentialType: string, callback: AsyncCallback): void; @@ -915,6 +915,7 @@ declare namespace appAccount { * @throws {BusinessError} 401 - the parameter check failed. * @throws {BusinessError} 12300001 - system service exception. * @throws {BusinessError} 12300002 - invalid options. + * @throws {BusinessError} 12300010 - account service busy. * @since 9 */ selectAccountsByOptions(options: SelectAccountsOptions, callback: AsyncCallback>): void; @@ -931,8 +932,8 @@ declare namespace appAccount { * @throws {BusinessError} 12300001 - system service exception. * @throws {BusinessError} 12300002 - invalid name, owner or options. * @throws {BusinessError} 12300003 - the account indicated by owner dose not exist. - * @throws {BusinessError} 12400001 - the application indicated by name does not exist. - * @throws {BusinessError} 12400002 - he account authenticator service does not exist. + * @throws {BusinessError} 12300010 - account service busy. + * @throws {BusinessError} 12400002 - the account authenticator service does not exist. * @since 9 */ verifyCredential(name: string, owner: string, callback: AuthCallback): void; @@ -949,7 +950,7 @@ declare namespace appAccount { * @throws {BusinessError} 401 - the parameter check failed. * @throws {BusinessError} 12300001 - system service exception. * @throws {BusinessError} 12300002 - invalid owner or options. - * @throws {BusinessError} 12300003 - the account indicated by owner dose not exist. + * @throws {BusinessError} 12300010 - account service busy. * @throws {BusinessError} 12400002 - the account authenticator service does not exist. * @since 9 */ diff --git a/api/@ohos.account.osAccount.d.ts b/api/@ohos.account.osAccount.d.ts index 92a81d4b44d572743e76639447886445cdae8e48..14efd77a481a0be150d1f660601a7072986f85d6 100644 --- a/api/@ohos.account.osAccount.d.ts +++ b/api/@ohos.account.osAccount.d.ts @@ -52,8 +52,8 @@ declare namespace osAccount { * @throws {BusinessError} 12300001 - system service exception. * @throws {BusinessError} 12300002 - invalid localId. * @throws {BusinessError} 12300003 - the account indicated by localId dose not exist. - * @throws {BusinessError} 12300003 - the account indicated by localId has been activated. - * @throws {BusinessError} 12300010 - account service is busy. + * @throws {BusinessError} 12300004 - the localId indicates restricted account. + * @throws {BusinessError} 12300009 - the account indicated by localId has been activated. * @systemapi Hide this for inner system use. * @since 7 */ @@ -151,7 +151,6 @@ declare namespace osAccount { * @throws {BusinessError} 12300001 - system service exception. * @throws {BusinessError} 12300002 - invalid localId or constraint. * @throws {BusinessError} 12300003 - the account indicated by localId dose not exist. - * @throws {BusinessError} 12300004 - the localId indicates restricted account. * @since 9 */ checkConstraintEnabled(localId: number, constraint: string, callback: AsyncCallback): void; @@ -399,7 +398,6 @@ declare namespace osAccount { * @throws {BusinessError} 12300001 - system service exception. * @throws {BusinessError} 12300002 - invalid localId. * @throws {BusinessError} 12300003 - the account indicated by localId dose not exist. - * @throws {BusinessError} 12300004 - the localId indicates restricted account. * @since 9 */ getOsAccountConstraints(localId: number, callback: AsyncCallback>): void; @@ -598,6 +596,7 @@ declare namespace osAccount { * @throws {BusinessError} 12300001 - system service exception. * @throws {BusinessError} 12300002 - invalid localId or photo. * @throws {BusinessError} 12300003 - the account indicated by localId dose not exist. + * @throws {BusinessError} 12300004 - the localId indicates restricted account. * @systemapi Hide this for inner system use. * @since 7 */