CommunicationTokenRefreshOptions interface

パッケージ:

@azure/communication-common

通信トークン資格情報を自動的に更新するためのオプション。

プロパティ

refreshProactively	有効期限が切れる前にトークンを事前に更新するか、オンデマンドでのみ更新するかを示します。 既定では false。
token	初期化する省略可能なトークン。 明確に有効期限が記載されている string や AccessToken かもしれません。
tokenRefresher	通信識別APIから取得したトークンを返すコールバック。 返されるトークンは有効である必要があります (有効期限は将来である必要があります)。 JWTから有効期限を読み取るための string を返すか、期限を明示的に提供する AccessToken (暗号化されたアクセストークンでデコードできない場合に必要)を返します。
undecodableTokenExpiryIntervalInSeconds	復号できず明示的な有効期限もない返還トークン(例:暗号化されたアクセストークン)に対して、寿命(秒単位)と仮定されます。 デフォルトは600(10分)です。 これをトークンの実際の寿命に設定してください。 制限はありません。トークンの実際の寿命より大きい値があると、認証情報の更新が遅れ、サービスは期限切れトークンを拒否します。 推測を避けるために、トークン応答のexpires_inから導き出された明示的なexpiresOnTimestamp付きのAccessTokenを返すことを好む。

プロパティの詳細

refreshProactively

有効期限が切れる前にトークンを事前に更新するか、オンデマンドでのみ更新するかを示します。 既定では false。

refreshProactively?: boolean

プロパティ値

boolean

token

初期化する省略可能なトークン。 明確に有効期限が記載されている string や AccessToken かもしれません。

token?: string | AccessToken

プロパティ値

string | AccessToken

tokenRefresher

通信識別APIから取得したトークンを返すコールバック。 返されるトークンは有効である必要があります (有効期限は将来である必要があります)。

JWTから有効期限を読み取るための string を返すか、期限を明示的に提供する AccessToken (暗号化されたアクセストークンでデコードできない場合に必要)を返します。

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

プロパティ値

(abortSignal?: AbortSignalLike) => Promise<string | AccessToken>

undecodableTokenExpiryIntervalInSeconds

復号できず明示的な有効期限もない返還トークン(例:暗号化されたアクセストークン)に対して、寿命(秒単位)と仮定されます。 デフォルトは600(10分)です。

これをトークンの実際の寿命に設定してください。 制限はありません。トークンの実際の寿命より大きい値があると、認証情報の更新が遅れ、サービスは期限切れトークンを拒否します。 推測を避けるために、トークン応答のexpires_inから導き出された明示的なexpiresOnTimestamp付きのAccessTokenを返すことを好む。

undecodableTokenExpiryIntervalInSeconds?: number

プロパティ値

number