Udostępnij za pośrednictwem


AccessTokenRefresher class

Ostrzeżenie

Ten interfejs API jest już przestarzały.

No longer used in the bearer authorization policy.

Pomaga zasadom uwierzytelniania tokenu core-http żądać nowego tokenu, jeśli nie czekamy na nowy token.

Konstruktory

AccessTokenRefresher(TokenCredential, string | string[], number)

Metody

isReady()

Zwraca wartość true, jeśli wymagane milisekundy (domyślnie 30000) zostały przekazane, co oznacza, że jesteśmy gotowi do nowego odświeżenia.

refresh(GetTokenOptions)

Żąda nowego tokenu, jeśli obecnie nie czekamy na nowy token. Zwraca wartość null, jeśli nie osiągnięto wymaganego czasu między każdym wywołaniem.

Szczegóły konstruktora

AccessTokenRefresher(TokenCredential, string | string[], number)

new AccessTokenRefresher(credential: TokenCredential, scopes: string | string[], requiredMillisecondsBeforeNewRefresh?: number)

Parametry

credential
TokenCredential
scopes

string | string[]

requiredMillisecondsBeforeNewRefresh

number

Szczegóły metody

isReady()

Zwraca wartość true, jeśli wymagane milisekundy (domyślnie 30000) zostały przekazane, co oznacza, że jesteśmy gotowi do nowego odświeżenia.

function isReady(): boolean

Zwraca

boolean

refresh(GetTokenOptions)

Żąda nowego tokenu, jeśli obecnie nie czekamy na nowy token. Zwraca wartość null, jeśli nie osiągnięto wymaganego czasu między każdym wywołaniem.

function refresh(options: GetTokenOptions): Promise<undefined | AccessToken>

Parametry

options
GetTokenOptions

Zwraca

Promise<undefined | AccessToken>