Class Authenticator

ReadonlyloginSupported

expirationHandler

• get expirationHandler(): AuthenticationExpirationHandler

• The handler that will be called when authentication for this Ditto instance is about to expire.

  This API is in preview and provides a replacement for the phased out AuthenticationHandler interface.

  Important: If the Ditto instance is configured with a DittoConfigConnectServer this property must be set and the handler must properly authenticate when called.

  Returns AuthenticationExpirationHandler

  See

  setExpirationHandler

status

• get status(): AuthenticationStatus

• Returns the current authentication status.

  Returns AuthenticationStatus

StaticDEVELOPMENT_PROVIDER

• get DEVELOPMENT_PROVIDER(): string

• The built-in development authentication provider to be used together with development authentication tokens.

  This API is in preview as part of the new configuration APIs that replace the legacy Identity-based initialization.

  Returns string

  See

  Authenticator.login() for more information about the provider parameter.

login

• login(token, provider): Promise<LoginResult>

• Log in to Ditto with a third-party token.

  Returns a promise that resolves to a LoginResult object. When the login attempt is successful, the error property of the response will be null, otherwise it will contain a DittoError object with details about the error.

  If the authentication service provides additional client info, it will be returned in the clientInfo property of the response, whether the login attempt was successful or not.

  Parameters

  • token: string

    The authentication token required to log in.
  • provider: string

    The name of the authentication provider. Use Authenticator.DEVELOPMENT_PROVIDER with development tokens.

  Returns Promise<LoginResult>

  A promise that resolves to a LoginResult object.

  Throws

  DittoError authentication/failed-to-authenticate if the Ditto instance is closed.

loginWithToken

• loginWithToken(token, provider): Promise<void>

• Log in to Ditto with a third-party token. Throws if authentication is not available, which can be checked with loginSupported.

  Parameters

  • token: string

    the authentication token required to log in.
  • provider: string

    the name of the authentication provider.

  Returns Promise<void>

  Deprecated

  Use login instead, which provides access to client info provided by the authentication service.

loginWithUsernameAndPassword

• loginWithUsernameAndPassword(username, password, provider): Promise<void>

• Log in to Ditto with a username and password. Throws if authentication is not available, which can be checked with loginSupported.

  Parameters

  • username: string

    the username component of the credentials used for log in.
  • password: string

    the password component of the credentials used for log in.
  • provider: string

    the name of the authentication provider.

  Returns Promise<void>

  Deprecated

  this method is deprecated and will be removed in a future version.

logout

• logout(cleanupFn?): Promise<void>

• Log out of Ditto.

  This will stop sync, shut down all replication sessions, and remove any cached authentication credentials. Note that this does not remove any data from the store. If you wish to delete data from the store then use the optional cleanupFn parameter to perform any required cleanup.

  Parameters

  • OptionalcleanupFn: ((ditto: Ditto) => void)

    An optional function that will be called with the relevant [Ditto] instance as the sole argument that allows you to perform any required cleanup of the store as part of the logout process.

    • • (ditto): void

      • Parameters

        • ditto: Ditto

        Returns void

  Returns Promise<void>

observeStatus

• observeStatus(callback): Observer

• Parameters

  • callback: ((authenticationStatus: AuthenticationStatus) => void)
    • • (authenticationStatus): void

      • Parameters

        • authenticationStatus: AuthenticationStatus

        Returns void

  Returns Observer

setExpirationHandler

• setExpirationHandler(handler): Promise<void>

• Sets the handler that will be called when authentication for this Ditto instance is about to expire.

  This API is in preview and provides a replacement for the phased out AuthenticationHandler interface.

  Assign a handler function to be notified before authentication expires, allowing you to login or perform other necessary actions.

  Parameters

  • handler: AuthenticationExpirationHandler

  Returns Promise<void>

  See

  expirationHandler