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

Methods

  • Executes the operation asynchronously.

    Returns Promise<void>

  • The username whose PIN must be changed.

    IMPORTANT
    Providing the username is required.

    Parameters

    • username: string

      the username.

    Returns PinChange

    a PinChange object.

  • Specifies the object that will be informed of the potential recoverable errors and is responsible for obtaining the PIN from the end-user.

    IMPORTANT
    Providing the pinChanger is required.

    Parameters

    Returns PinChange

    a PinChange object.

  • 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.

        • (): void
        • Returns void

    Returns PinChange

    a PinChange object.

  • 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.

    Params:

    Parameters

    • onError: ((error) => void)

    Returns PinChange

    a PinChange object.

Generated using TypeDoc