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 renovar sob demanda. Por padrão, false.
token	Token opcional a ser inicializado. Pode ser um string ou um AccessToken portador de vencimento explícito.
tokenRefresher	Callback que retorna um token adquirido da API de Identidade de Comunicação. O token retornado deve ser válido (a data de validade deve ser no futuro). Retorne a string para que o vencimento seja lido do JWT, ou an AccessToken para fornecer o vencimento explicitamente (exigido para tokens de acesso criptografados que não podem ser decodificados).
undecodableTokenExpiryIntervalInSeconds	Vida útil, em segundos, assumida para um token retornado que não pode ser decodificado e não carrega expiração explícita (por exemplo, um token de acesso criptografado). O padrão é 600 (10 minutos). Defina isso para a vida real dos seus tokens. Ele não é limitado: um valor maior que a 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 suposições, prefira retornar an AccessToken com um explícito expiresOnTimestamp (por exemplo, derivado da resposta expires_indo token ).

Detalhes da propriedade

refreshProactively

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

refreshProactively?: boolean

Valor da propriedade

boolean

token

Token opcional a ser inicializado. Pode ser um string ou um AccessToken portador de vencimento explícito.

token?: string | AccessToken

Valor da propriedade

string | AccessToken

tokenRefresher

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

Retorne a string para que o vencimento seja lido do JWT, ou an AccessToken para fornecer o vencimento explicitamente (exigido para tokens de acesso criptografados que não podem ser decodificados).

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

Valor da propriedade

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

undecodableTokenExpiryIntervalInSeconds

Vida útil, em segundos, assumida para um token retornado que não pode ser decodificado e não carrega expiração explícita (por exemplo, um token de acesso criptografado). O padrão é 600 (10 minutos).

Defina isso para a vida real dos seus tokens. Ele não é limitado: um valor maior que a 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 suposições, prefira retornar an AccessToken com um explícito expiresOnTimestamp (por exemplo, derivado da resposta expires_indo token ).

undecodableTokenExpiryIntervalInSeconds?: number

Valor da propriedade

number