Class AzureCommunicationTokenCredential

Package version

The CommunicationTokenCredential implementation with support for proactive token refresh.

Hierarchy

AzureCommunicationTokenCredential

Implements

CommunicationTokenCredential

Index

Constructors

constructor

Methods

Constructors

constructor

new AzureCommunicationTokenCredential(token: string): AzureCommunicationTokenCredential
new AzureCommunicationTokenCredential(refreshOptions: CommunicationTokenRefreshOptions): AzureCommunicationTokenCredential

- Defined in communicationTokenCredential.ts:44
Creates an instance of CommunicationTokenCredential with a static token and no proactive refreshing.

Parameters
- token: string
  
  A user access token issued by Communication Services.
Returns AzureCommunicationTokenCredential
- Defined in communicationTokenCredential.ts:50
Creates an instance of CommunicationTokenCredential with a lambda to get a token and options to configure proactive refreshing.

Parameters
- refreshOptions: CommunicationTokenRefreshOptions
  
  Options to configure refresh and opt-in to proactive refreshing.
Returns AzureCommunicationTokenCredential

Methods

dispose

dispose(): void

Implementation of CommunicationTokenCredential.dispose
- Defined in communicationTokenCredential.ts:79
Disposes the CommunicationTokenCredential and cancels any internal auto-refresh operation.

Returns void

getToken

getToken(options?: CommunicationGetTokenOptions): Promise<AccessToken>

Implementation of CommunicationTokenCredential.getToken
- Defined in communicationTokenCredential.ts:69
Gets an AccessToken for the user. Throws if already disposed.

Parameters
- Optional options: CommunicationGetTokenOptions
Returns Promise<AccessToken>

Generated using TypeDoc