xref: /docs/en/release-notes/changelogs/v3.2-beta4/changelogs-account_os_account.md

# Account Subsystem Changelog

## cl.account_os_account.1 Error Code Change

To ensure consistent error codes and normalized return of error codes in the account subsystem APIs, the following changes are made in API version 9:

- Added the following error codes:
  - [Account Management Error Codes](../../../application-dev/reference/errorcodes/errorcode-account.md)

- Changed the error code return modes as follows:
  - Asynchronous APIs: Return error information in the **error** object of **AsyncCallback** or **Promise**. Wherein, parameter type or quantity error information is returned by throwing an exception.
  - Synchronous APIs: Throw an exception to return an error message.

**Change Impact**

The application developed based on earlier versions needs to adapt the method for returning API error information. Otherwise, the original service logic will be affected.

**Key API/Component Changes**

Involved APIs:
  - class AccountManager
    - activateOsAccount(localId: number, callback: AsyncCallback<void>): void;
    - removeOsAccount(localId: number, callback: AsyncCallback<void>): void;
    - setOsAccountConstraints(localId: number, constraints: Array<string>, enable: boolean, callback: AsyncCallback<void>): void;
    - setOsAccountName(localId: number, localName: string, callback: AsyncCallback<void>): void;
    - queryMaxOsAccountNumber(callback: AsyncCallback<number>): void;
    - queryAllCreatedOsAccounts(callback: AsyncCallback<Array<OsAccountInfo>>): void;
    - createOsAccount(localName: string, type: OsAccountType, callback: AsyncCallback<OsAccountInfo>): void;
    - createOsAccountForDomain(type: OsAccountType, domainInfo: DomainAccountInfo, callback: AsyncCallback<OsAccountInfo>): void;
    - queryOsAccountById(localId: number, callback: AsyncCallback<OsAccountInfo>): void;
    - getOsAccountProfilePhoto(localId: number, callback: AsyncCallback<string>): void;
    - setOsAccountProfilePhoto(localId: number, photo: string, callback: AsyncCallback<void>): void;
    - on(type: 'activate' | 'activating', name: string, callback: Callback<number>): void;
    - off(type: 'activate' | 'activating', name: string, callback?: Callback<number>): void;
    - isMainOsAccount(callback: AsyncCallback<boolean>): void;
    - queryOsAccountConstraintSourceTypes(localId: number, constraint: string, callback: AsyncCallback<Array<ConstraintSourceTypeInfo>>): void;
  - class UserAuth
    - constructor();
    - getVersion(): number;
    - getAvailableStatus(authType: AuthType, authTrustLevel: AuthTrustLevel): number;
    - getProperty(request: GetPropertyRequest, callback: AsyncCallback<ExecutorProperty>): void;
    - setProperty(request: SetPropertyRequest, callback: AsyncCallback<number>): void;
    - auth(challenge: Uint8Array, authType: AuthType, authTrustLevel: AuthTrustLevel, callback: IUserAuthCallback): Uint8Array;
    - authUser(userId: number, challenge: Uint8Array, authType: AuthType, authTrustLevel: AuthTrustLevel, callback: IUserAuthCallback): Uint8Array;
    - cancelAuth(contextID: Uint8Array): number;
  - class PINAuth
    - constructor();
    - registerInputer(inputer: IInputer): boolean;
    - unregisterInputer(authType: AuthType): void;
  - class UserIdentityManager
    - constructor();
    - openSession(callback: AsyncCallback<Uint8Array>): void;
    - addCredential(credentialInfo: CredentialInfo, callback: IIdmCallback): void;
    - updateCredential(credentialInfo: CredentialInfo, callback: IIdmCallback): void;
    - closeSession(): void;
    - cancel(challenge: Uint8Array): number;
    - delUser(token: Uint8Array, callback: IIdmCallback): void;
    - delCred(credentialId: Uint8Array, token: Uint8Array, callback: IIdmCallback): void;
    - getAuthInfo(callback: AsyncCallback<Array<EnrolledCredInfo>>): void;
  - interface IInputData
    - onSetData: (authSubType: AuthSubType, data: Uint8Array) => void;

**Adaptation Guide**

The following uses **activateOsAccount** as an example to describe the error information processing logic of an asynchronous API:

```ts
import account_osAccount from "@ohos.account.osAccount"
let accountMgr = account_osAccount.getAccountManager()
let callbackFunc = (err) => {
  if (err != null) {  // Handle the service error.
    console.log("account_osAccount failed, error: " + JSON.stringify(err));
  } else {
    console.log("account_osAccount successfully");
  }
}
try {
  accountMgr.activateOsAccount("100", callbackFunc);
} catch (err) {  // Handle the parameter type error.
  console.log("account_osAccount failed for incorrect parameter type, error: " + JSON.stringify(err));
}
try {
  accountMgr.activateOsAccount();
} catch (err) {  // Handle the parameter number error.
  console.log("account_osAccount failed for incorrect parameter number, error: " + JSON.stringify(err));
}
```

The following uses **registerInputer** as an example to describe the error information processing logic of a synchronous API:

```ts
import account_osAccount from "@ohos.account.osAccount"
let pinAuth = new account_osAccount.PINAuth()
try {
    pinAuth.registerInputer({})
} catch (err) {  // Handle the parameter type error.
  console.log("account_osAccount failed for incorrect parameter type, error: " + JSON.stringify(err));
}
try {
    pinAuth.registerInputer()
} catch (err) {  // Handle the parameter number error.
  console.log("account_osAccount failed for incorrect parameter number, error: " + JSON.stringify(err));
}
```

## cl.account_os_account.2 Change in Error Information Return of Account System APIs

Some system APIs of the account subsystem use service logic return values to indicate error information, which does not comply with the API error code specifications of OpenHarmony. The following changes are made in API version 9:

Asynchronous API: An error message is returned via **AsyncCallback** or the **error** object of **Promise**.

Synchronous API: An error message is returned via an exception.

**Change Impact**

The application developed based on earlier versions needs to be adapted. Otherwise, the service logic will be affected.

**Key API/Component Changes**

Before change:

  - class UserAuth
    - setProperty(request: SetPropertyRequest, callback: AsyncCallback<number>): void;
    - setProperty(request: SetPropertyRequest): Promise<number>;
    - cancelAuth(contextID: Uint8Array): number;
  - class PINAuth
    - registerInputer(inputer: Inputer): boolean;
  - UserIdentityManager
    - cancel(challenge: Uint8Array): number;

After change:

  - class UserAuth
    - setProperty(request: SetPropertyRequest, callback: AsyncCallback<void>): void;
    - setProperty(request: SetPropertyRequest): Promise<void>;
    - cancelAuth(contextID: Uint8Array): void;
  - class PINAuth
    - registerInputer(inputer: Inputer): void;
  - UserIdentityManager
    - cancel(challenge: Uint8Array): void;

**Adaptation Guide**

The following uses **setProperty** as an example for asynchronous APIs:

```
import account_osAccount from "@ohos.account.osAccount"
userAuth.setProperty({
    authType: account_osAccount.AuthType.PIN,
    key: account_osAccount.SetPropertyType.INIT_ALGORITHM,
    setInfo: new Uint8Array([0])
}, (err) => {
    if (err) {
        console.log("setProperty failed, error: " + JSON.stringify(err));
    } else {
        console.log("setProperty successfully");
    }
});

userAuth.setProperty({
    authType: account_osAccount.AuthType.PIN,
    key: account_osAccount.SetPropertyType.INIT_ALGORITHM,
    setInfo: new Uint8Array([0])
}).catch((err) => {
    if (err) {
        console.log("setProperty failed, error: " + JSON.stringify(err));
    } else {
        console.log("setProperty successfully");
    }
});
```

The following uses **registerInputer** as an example for synchronous APIs:

```
import account_osAccount from "@ohos.account.osAccount"
let pinAuth = new account_osAccount.PINAuth()
let inputer = {
    onGetData: (authType, passwordRecipient) => {
        let password = new Uint8Array([0]);
        passwordRecipient.onSetData(authType, password);
    }
}
try {
    pinAuth.registerInputer(inputer);
} catch (err) {
    console.log("registerInputer failed, error: " + JSON.stringify(err));
}
```

## cl.account_os_account.3 Change of ACTION for the App Account Authentication Service

**Change Impact**

For the application developed based on an earlier version, you need to modify **ACTION** in the application configuration file (**config.json** for the FA model and **module.json5** for the stage model). Otherwise, the application authentication service will be affected.

**Key API/Component Changes**

Involved constant:

@ohos.ability.wantConstant.ACTION_APP_ACCOUNT_AUTH

Before change:

ACTION_APP_ACCOUNT_AUTH = "account.appAccount.action.auth"

After change:

ACTION_APP_ACCOUNT_AUTH = "ohos.appAccount.action.auth"

**Adaptation Guide**

For a third-party application providing the account authentication service, change **ACTION** in the **ServiceAbility** configuration file (**config.json** for the FA module or **module.json5** for the stage module).

```
"abilities": [
    {
        "name": "ServiceAbility",
        "srcEnty": "./ets/ServiceAbility/ServiceAbility.ts",
        ...
        "visible": true,
        "skills": {
            {
                "actions": [
                    "ohos.appAccount.action.auth"
                ]
            }
        }
    }]
}

```