JS API Changes of the Account Subsystem

The table below lists the APIs changes of the account subsystem in OpenHarmony 3.1 Release over OpenHarmony 3.0 LTS.

API Changes

Module Class Method/Attribute/Enumeration/Constant Change Type
ohos.account.osAccount OsAccountType GUEST Added
ohos.account.osAccount OsAccountType NORMAL Added
ohos.account.osAccount OsAccountType ADMIN = 0 Added
ohos.account.osAccount DomainAccountInfo accountName: string; Added
ohos.account.osAccount DomainAccountInfo domain: string; Added
ohos.account.osAccount OsAccountInfo domainInfo: DomainAccountInfo; Added
ohos.account.osAccount OsAccountInfo distributedInfo: distributedAccount.DistributedInfo; Added
ohos.account.osAccount OsAccountInfo isCreateCompleted: boolean; Added
ohos.account.osAccount OsAccountInfo isActived: boolean; Added
ohos.account.osAccount OsAccountInfo serialNumber: number; Added
ohos.account.osAccount OsAccountInfo lastLoginTime: number; Added
ohos.account.osAccount OsAccountInfo createTime: number; Added
ohos.account.osAccount OsAccountInfo photo: string; Added
ohos.account.osAccount OsAccountInfo isVerified: boolean; Added
ohos.account.osAccount OsAccountInfo constraints: Array; Added
ohos.account.osAccount OsAccountInfo type: OsAccountType; Added
ohos.account.osAccount OsAccountInfo localName: string; Added
ohos.account.osAccount OsAccountInfo localId: number; Added
ohos.account.osAccount AccountManager getSerialNumberByOsAccountLocalId(localId: number, callback: AsyncCallback): void;
getSerialNumberByOsAccountLocalId(localId: number): Promise;		 Added
ohos.account.osAccount AccountManager getOsAccountLocalIdBySerialNumber(serialNumber: number, callback: AsyncCallback): void;
getOsAccountLocalIdBySerialNumber(serialNumber: number): Promise;		 Added
ohos.account.osAccount AccountManager getDistributedVirtualDeviceId(callback: AsyncCallback): void;
getDistributedVirtualDeviceId(): Promise;		 Added
ohos.account.osAccount AccountManager getOsAccountTypeFromProcess(callback: AsyncCallback): void;
getOsAccountTypeFromProcess(): Promise;		 Added
ohos.account.osAccount AccountManager queryCurrentOsAccount(callback: AsyncCallback): void;
queryCurrentOsAccount(): Promise;		 Added
ohos.account.osAccount AccountManager queryActivatedOsAccountIds(callback: AsyncCallback<Array>): void;
queryActivatedOsAccountIds(): Promise<Array>;		 Added
ohos.account.osAccount AccountManager getOsAccountAllConstraints(localId: number, callback: AsyncCallback<Array>): void;
getOsAccountAllConstraints(localId: number): Promise<Array>;		 Added
ohos.account.osAccount AccountManager getOsAccountLocalIdFromDomain(domainInfo: DomainAccountInfo, callback: AsyncCallback): void;
getOsAccountLocalIdFromDomain(domainInfo: DomainAccountInfo): Promise;		 Added
ohos.account.osAccount AccountManager getOsAccountLocalIdFromUid(uid: number, callback: AsyncCallback): void;
getOsAccountLocalIdFromUid(uid: number): Promise;		 Added
ohos.account.osAccount AccountManager getOsAccountLocalIdFromProcess(callback: AsyncCallback): void;
getOsAccountLocalIdFromProcess(): Promise;		 Added
ohos.account.osAccount AccountManager getCreatedOsAccountsCount(callback: AsyncCallback): void;
getCreatedOsAccountsCount(): Promise;		 Added
ohos.account.osAccount AccountManager isOsAccountVerified(callback: AsyncCallback): void;
isOsAccountVerified(localId: number, callback: AsyncCallback): void;
isOsAccountVerified(localId?: number): Promise;		 Added
ohos.account.osAccount AccountManager isTestOsAccount(callback: AsyncCallback): void;
isTestOsAccount(): Promise;		 Added
ohos.account.osAccount AccountManager isOsAccountConstraintEnable(localId: number, constraint: string, callback: AsyncCallback): void;
isOsAccountConstraintEnable(localId: number, constraint: string): Promise;		 Added
ohos.account.osAccount AccountManager isOsAccountActived(localId: number, callback: AsyncCallback): void;
isOsAccountActived(localId: number): Promise;		 Added
ohos.account.osAccount AccountManager isMultiOsAccountEnable(callback: AsyncCallback): void;
isMultiOsAccountEnable(): Promise;		 Added
ohos.account.osAccount osAccount function getAccountManager(): AccountManager; Added
ohos.account.appAccount Authenticator authenticate(name: string, authType: string, callerBundleName: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void; Added
ohos.account.appAccount Authenticator addAccountImplicitly(authType: string, callerBundleName: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void; Added
ohos.account.appAccount AuthenticatorCallback onRequestRedirected: (request: Want) => void; Added
ohos.account.appAccount AuthenticatorCallback onResult: (code: number, result: {[key: string]: any}) => void; Added
ohos.account.appAccount ResultCode ERROR_PERMISSION_DENIED = 10018 Added
ohos.account.appAccount ResultCode ERROR_OAUTH_UNSUPPORT_AUTH_TYPE = 10017 Added
ohos.account.appAccount ResultCode ERROR_OAUTH_UNSUPPORT_ACTION = 10016 Added
ohos.account.appAccount ResultCode ERROR_OAUTH_TOKEN_TOO_MANY = 10015 Added
ohos.account.appAccount ResultCode ERROR_OAUTH_TOKEN_NOT_EXIST = 10014 Added
ohos.account.appAccount ResultCode ERROR_OAUTH_TIMEOUT = 10013 Added
ohos.account.appAccount ResultCode ERROR_OAUTH_SESSION_NOT_EXIST = 10012 Added
ohos.account.appAccount ResultCode ERROR_OAUTH_SERVICE_EXCEPTION = 10011 Added
ohos.account.appAccount ResultCode ERROR_OAUTH_SERVICE_BUSY = 10010 Added
ohos.account.appAccount ResultCode ERROR_OAUTH_LIST_TOO_LARGE = 10009 Added
ohos.account.appAccount ResultCode ERROR_OAUTH_CANCELED = 10008 Added
ohos.account.appAccount ResultCode ERROR_OAUTH_AUTHENTICATOR_NOT_EXIST = 10007 Added
ohos.account.appAccount ResultCode ERROR_NETWORK_EXCEPTION = 10006 Added
ohos.account.appAccount ResultCode ERROR_INVALID_RESPONSE = 10005 Added
ohos.account.appAccount ResultCode ERROR_INVALID_REQUEST = 10004 Added
ohos.account.appAccount ResultCode ERROR_INVALID_PASSWORD = 10003 Added
ohos.account.appAccount ResultCode ERROR_APP_ACCOUNT_SERVICE_EXCEPTION = 10002 Added
ohos.account.appAccount ResultCode ERROR_ACCOUNT_NOT_EXIST = 10001 Added
ohos.account.appAccount ResultCode SUCCESS = 0 Added
ohos.account.appAccount Constants KEY_CALLER_BUNDLE_NAME = "callerBundleName" Added
ohos.account.appAccount Constants KEY_CALLER_UID = "callerUid" Added
ohos.account.appAccount Constants KEY_CALLER_PID = "callerPid" Added
ohos.account.appAccount Constants KEY_SESSION_ID = "sessionId" Added
ohos.account.appAccount Constants KEY_AUTH_TYPE = "authType" Added
ohos.account.appAccount Constants KEY_ACTION = "action" Added
ohos.account.appAccount Constants KEY_TOKEN = "token" Added
ohos.account.appAccount Constants KEY_OWNER = "owner" Added
ohos.account.appAccount Constants KEY_NAME = "name" Added
ohos.account.appAccount Constants ACTION_AUTHENTICATE = "authenticate" Added
ohos.account.appAccount Constants ACTION_ADD_ACCOUNT_IMPLICITLY = "addAccountImplicitly" Added
ohos.account.appAccount AuthenticatorInfo labelId: number; Added
ohos.account.appAccount AuthenticatorInfo iconId: number; Added
ohos.account.appAccount AuthenticatorInfo owner: string; Added
ohos.account.appAccount OAuthTokenInfo token: string; Added
ohos.account.appAccount OAuthTokenInfo authType: string; Added
ohos.account.appAccount AppAccountInfo name: string; Added
ohos.account.appAccount AppAccountInfo owner: string; Added
ohos.account.appAccount AppAccountManager getAuthenticatorInfo(owner: string, callback: AsyncCallback): void;
getAuthenticatorInfo(owner: string): Promise;		 Added
ohos.account.appAccount AppAccountManager getAuthenticatorCallback(sessionId: string, callback: AsyncCallback): void;
getAuthenticatorCallback(sessionId: string): Promise;		 Added
ohos.account.appAccount AppAccountManager getOAuthList(name: string, authType: string, callback: AsyncCallback<Array>): void;
getOAuthList(name: string, authType: string): Promise<Array>;		 Added
ohos.account.appAccount AppAccountManager getAllOAuthTokens(name: string, owner: string, callback: AsyncCallback<Array>): void;
getAllOAuthTokens(name: string, owner: string): Promise<Array>;		 Added
ohos.account.appAccount AppAccountManager checkOAuthTokenVisibility(name: string, authType: string, bundleName: string, callback: AsyncCallback): void;
checkOAuthTokenVisibility(name: string, authType: string, bundleName: string): Promise;		 Added
ohos.account.appAccount AppAccountManager setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVisible: boolean, callback: AsyncCallback): void;
setOAuthTokenVisibility(name: string, authType: string, bundleName: string, isVisible: boolean): Promise;		 Added
ohos.account.appAccount AppAccountManager deleteOAuthToken(name: string, owner: string, authType: string, token: string, callback: AsyncCallback): void;
deleteOAuthToken(name: string, owner: string, authType: string, token: string): Promise;		 Added
ohos.account.appAccount AppAccountManager setOAuthToken(name: string, authType: string, token: string, callback: AsyncCallback): void;
setOAuthToken(name: string, authType: string, token: string): Promise;		 Added
ohos.account.appAccount AppAccountManager getOAuthToken(name: string, owner: string, authType: string, callback: AsyncCallback): void;
getOAuthToken(name: string, owner: string, authType: string): Promise;		 Added
ohos.account.appAccount AppAccountManager authenticate(name: string, owner: string, authType: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void; Added
ohos.account.appAccount AppAccountManager off(type: 'change', callback?: Callback<Array>): void; Added
ohos.account.appAccount AppAccountManager on(type: 'change', owners: Array, callback: Callback<Array>): void; Added
ohos.account.appAccount AppAccountManager getAssociatedData(name: string, key: string, callback: AsyncCallback): void;
getAssociatedData(name: string, key: string): Promise;		 Added
ohos.account.appAccount AppAccountManager getAccountExtraInfo(name: string, callback: AsyncCallback): void;
getAccountExtraInfo(name: string): Promise;		 Added
ohos.account.appAccount AppAccountManager getAccountCredential(name: string, credentialType: string, callback: AsyncCallback): void;
getAccountCredential(name: string, credentialType: string): Promise;		 Added
ohos.account.appAccount AppAccountManager getAllAccounts(owner: string, callback: AsyncCallback<Array>): void;
getAllAccounts(owner: string): Promise<Array>;		 Added
ohos.account.appAccount AppAccountManager getAllAccessibleAccounts(callback: AsyncCallback<Array>): void;
getAllAccessibleAccounts(): Promise<Array>;		 Added
ohos.account.appAccount AppAccountManager setAssociatedData(name: string, key: string, value: string, callback: AsyncCallback): void;
setAssociatedData(name: string, key: string, value: string): Promise;		 Added
ohos.account.appAccount AppAccountManager setAppAccountSyncEnable(name: string, isEnable: boolean, callback: AsyncCallback): void;
setAppAccountSyncEnable(name: string, isEnable: boolean): Promise;		 Added
ohos.account.appAccount AppAccountManager setAccountExtraInfo(name: string, extraInfo: string, callback: AsyncCallback): void;
setAccountExtraInfo(name: string, extraInfo: string): Promise;		 Added
ohos.account.appAccount AppAccountManager setAccountCredential(name: string, credentialType: string, credential: string, callback: AsyncCallback): void;
setAccountCredential(name: string, credentialType: string, credential: string): Promise;		 Added
ohos.account.appAccount AppAccountManager checkAppAccountSyncEnable(name: string, callback: AsyncCallback): void;
checkAppAccountSyncEnable(name: string): Promise;		 Added
ohos.account.appAccount AppAccountManager enableAppAccess(name: string, bundleName: string, callback: AsyncCallback): void;
enableAppAccess(name: string, bundleName: string): Promise;		 Added
ohos.account.appAccount AppAccountManager disableAppAccess(name: string, bundleName: string, callback: AsyncCallback): void;
disableAppAccess(name: string, bundleName: string): Promise;		 Added
ohos.account.appAccount AppAccountManager deleteAccount(name: string, callback: AsyncCallback): void;
deleteAccount(name: string): Promise;		 Added
ohos.account.appAccount AppAccountManager addAccountImplicitly(owner: string, authType: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void; Added
ohos.account.appAccount AppAccountManager addAccount(name: string, callback: AsyncCallback): void;
addAccount(name: string, extraInfo: string, callback: AsyncCallback): void;
addAccount(name: string, extraInfo?: string): Promise;		 Added
ohos.account.appAccount appAccount function createAppAccountManager(): AppAccountManager; Added