Interface AuthenticationHandler

Provides feedback to the developer about Ditto authentication status.

Hierarchy

  • AuthenticationHandler

Properties

authenticationExpiringSoon authenticationRequired authenticationStatusDidChange?

Properties

authenticationExpiringSoon

authenticationExpiringSoon: ((authenticator: Authenticator, secondsRemaining: number) => void)

Type declaration

    • (authenticator: Authenticator, secondsRemaining: number): void

    • Warns that the Ditto authentication token is getting old.

      Ditto will attempt to refresh tokens periodically, starting from halfway through the token's validity period. This reduces the risk of authentication expiring while the user is offline.

      The refresh will happen automatically if Ditto has a suitable refresh token. If new credentials are required, such as a third-party token or a username/password, then Ditto does not cache that information and you must submit it again using one of the login methods on Authenticator.

      Parameters

      Returns void

authenticationRequired

authenticationRequired: ((authenticator: Authenticator) => void)

Type declaration

    • (authenticator: Authenticator): void

    • There is no Ditto authentication token or it has expired. Sync will not work until there is a successful login using one of the login methods on Authenticator.

      Parameters

      Returns void

Optional authenticationStatusDidChange

authenticationStatusDidChange?: ((authenticator: Authenticator) => void)

Type declaration

    • (authenticator: Authenticator): void

    • Notifies the authentication handler that the authentication status did change. Use the authenticators property status to query for the current authentication status.

      This method is optional.

      Parameters

      Returns void

Settings

Member Visibility

Theme