Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CommunicationTokenRefreshOptions

Package version

Options for auto-refreshing a Communication Token credential.

Hierarchy

  • CommunicationTokenRefreshOptions

Index

Properties

Properties

Optional refreshProactively

refreshProactively: undefined | false | true

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

Optional token

token: undefined | string

Optional token to initialize.

tokenRefresher

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

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

Type declaration

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

    • Parameters

      • Optional abortSignal: AbortSignalLike

      Returns Promise<string>

Generated using TypeDoc