Class DeregistrationAbstract

The object that can be used to trigger a deregistration operation.

Usage example:

  [...]
  async deregister(
      client: MobileAuthenticationClient,
      username: string,
      aaid: string
  ): Promise<void> {
      await client.operations.deregistration
          .username(username)
          .aaid(aaid)
          .onSuccess(() => {
              // handle success
          })
          .onError((_error) => {
              // handle error
          })
          .execute();
  }
  [...]

Hierarchy

Methods

username aaid authorizationProvider onSuccess onError requestHeaders execute

Methods

Abstract username

  • Specifies the username that must be deregistered.

    IMPORTANT
    Providing the username is required.

    Parameters

    • username: string

      the username.

    Returns Deregistration

    a Deregistration object.

Abstract aaid

  • Specifies the AAID of the Authenticator that must be deregistered.

    NOTE
    If no AAID is provided then all authenticators will be deregistered.

    Parameters

    • aaid: string

      the AAID of the authenticator to be deregistered.

    Returns Deregistration

    a Deregistration object.

Abstract authorizationProvider

Abstract onSuccess

  • Specifies the object that will be invoked if the authenticator was deleted successfully.

    IMPORTANT
    Providing the onSuccess is required.

    Parameters

    • onSuccess: (() => void)

      the function which is invoked on successful deregistration.

        • (): void

        • Returns void

    Returns Deregistration

    a Deregistration object.

Abstract onError

Abstract requestHeaders

Abstract execute

  • Executes the operation asynchronously.

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc