Class Authenticator

Readonly loginSupported

status

• get status(): AuthenticationStatus

• Returns the current authentication status.

  Returns AuthenticationStatus

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>

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>

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

  • Optional cleanupFn: ((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) => void)

    • • (authenticationStatus): void

      • Parameters

        • authenticationStatus: AuthenticationStatus

        Returns void

  Returns Observer