Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RefreshOptions

Package version

Options for auto-refreshing a Communication user credential.

Hierarchy

  • RefreshOptions

Index

Properties

Properties

Optional initialToken

initialToken: undefined | string

Optional user token to initialize.

Optional refreshProactively

refreshProactively: undefined | false | true

Indicates whether the user token should be proactively renewed prior to expiry or only renew on demand. By default false.

tokenRefresher

tokenRefresher: (abortSignal?: AbortSignalLike) => Promise<string>

Function that returns a user token acquired from the Communication configuration SDK.

Type declaration

    • (abortSignal?: AbortSignalLike): Promise<string>

    • Parameters

      • Optional abortSignal: AbortSignalLike

      Returns Promise<string>

Generated using TypeDoc