Class PinChangeAbstract

The object that can be used to change the PIN.

Usage example:

class PinChangerImpl implements PinChanger {
    async changePin(context: PinChangeContext, handler: PinChangeHandler) {
        handler.pins(oldPin, newPin);
    }
}

[...]
async changePin({
    client: MobileAuthenticationClient,
    username: string,
}): Promise<void> {
    await client.operations.pinChange
        .username(username)
        .pinChanger(PinChangerImpl(...))
        .onSuccess(() {
            // handle success
        })
        .onError((error) {
            // handle error
        })
        .execute();
}
[...]

Hierarchy (View Summary)

Methods

execute username pinChanger onSuccess onError

Methods

Abstractexecute

  • execute(): Promise<void>

  • Executes the operation asynchronously.

    Returns Promise<void>

Abstractusername

  • username(username: string): PinChange

  • The username whose PIN must be changed.

    IMPORTANT
    Providing the username is required.

    WARNING
    The username is the technical user identifier stored in the Account.username property. Do not provide the login identifier (for example the users e-mail address) here. We recommend always using the username provided via LocalData.accounts.

    Parameters

    • username: string

      the username.

    Returns PinChange

    a PinChange object.

AbstractpinChanger

AbstractonSuccess

  • onSuccess(onSuccess: () => void): PinChange

  • Specifies the object that will be invoked if the PIN was successfully modified.

    IMPORTANT
    Providing the onSuccess is required.

    Parameters

    • onSuccess: () => void

      the callback which is invoked on successful PIN modification.

    Returns PinChange

    a PinChange object.

AbstractonError

  • onError(onError: (error: PinChangeError) => void): PinChange

  • Specifies the object that will be invoked when the PIN could not be changed: the PIN was not enrolled, the PIN is locked or the operation was canceled.

    IMPORTANT
    Providing the onError is required.

    Parameters

    Returns PinChange

    a PinChange object.

Settings

Member Visibility

On This Page

Methods