Nevis Mobile Authentication SDK React Native plugin
    Preparing search index...

    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 (View Summary)

    Index

    Methods

    username aaid authorizationProvider onSuccess onError requestHeaders execute

    Methods

    • Specifies the username that must be deregistered.

      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 Deregistration

      a Deregistration object.

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

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

      Returns Deregistration

      a Deregistration object.

    • Executes the operation asynchronously.

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Methods