CommunicationTokenRefreshOptions interface

Pacote:

@azure/communication-common

Opções para atualizar automaticamente uma credencial de Token de Comunicação.

Propriedades

refreshProactively	Indica se o token deve ser renovado proativamente antes da expiração ou apenas renovado sob demanda. Por padrão, false.
token	Token opcional para inicializar. Pode ser um string ou um AccessToken com uma expiração explícita.
tokenRefresher	Callback que devolve um token adquirido da API de Identidade de Comunicação. O token devolvido deve ser válido (a data de expiração deve ser no futuro). Retorne a string para que o vencimento seja lido do JWT, ou um AccessToken para fornecer o expiração explicitamente (exigido para tokens de acesso encriptados que não podem ser descodificados).
undecodableTokenExpiryIntervalInSeconds	A vida útil, em segundos, assumida para um token devolvido que não pode ser decodificado e não tem qualquer expiração explícita (por exemplo, um token de acesso encriptado). Por defeito é 600 (10 minutos). Define isto para a vida real dos teus tokens. Não está limitado: um valor superior à vida útil real do token significa que a credencial é atualizada mais tarde do que deveria e o serviço rejeitará o token expirado. Para evitar adivinhar, prefira devolver an AccessToken com um explícito expiresOnTimestamp (por exemplo, derivado da resposta do expires_intoken ).

Detalhes de Propriedade

refreshProactively

Indica se o token deve ser renovado proativamente antes da expiração ou apenas renovado sob demanda. Por padrão, false.

refreshProactively?: boolean

Valor de Propriedade

boolean

token

Token opcional para inicializar. Pode ser um string ou um AccessToken com uma expiração explícita.

token?: string | AccessToken

Valor de Propriedade

string | AccessToken

tokenRefresher

Callback que devolve um token adquirido da API de Identidade de Comunicação. O token devolvido deve ser válido (a data de expiração deve ser no futuro).

Retorne a string para que o vencimento seja lido do JWT, ou um AccessToken para fornecer o expiração explicitamente (exigido para tokens de acesso encriptados que não podem ser descodificados).

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

Valor de Propriedade

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

undecodableTokenExpiryIntervalInSeconds

A vida útil, em segundos, assumida para um token devolvido que não pode ser decodificado e não tem qualquer expiração explícita (por exemplo, um token de acesso encriptado). Por defeito é 600 (10 minutos).

Define isto para a vida real dos teus tokens. Não está limitado: um valor superior à vida útil real do token significa que a credencial é atualizada mais tarde do que deveria e o serviço rejeitará o token expirado. Para evitar adivinhar, prefira devolver an AccessToken com um explícito expiresOnTimestamp (por exemplo, derivado da resposta do expires_intoken ).

undecodableTokenExpiryIntervalInSeconds?: number

Valor de Propriedade

number