Class AzureCommunicationUserCredential

Package version

The CommunicationUserCredential implementation with support for proactive token refresh.

Hierarchy

AzureCommunicationUserCredential

Implements

CommunicationUserCredential

Index

Constructors

constructor

Methods

Constructors

constructor

new AzureCommunicationUserCredential(token: string): AzureCommunicationUserCredential
new AzureCommunicationUserCredential(refreshOptions: RefreshOptions): AzureCommunicationUserCredential

- Defined in communicationUserCredential.ts:31
Creates an instance of CommunicationUserCredential with a static token and no proactive refreshing.

Parameters
- token: string
  
  A user access token issued by Communication Services.
Returns AzureCommunicationUserCredential
- Defined in communicationUserCredential.ts:37
Creates an instance of CommunicationUserCredential with a lambda to get a token and options to configure proactive refreshing.

Parameters
- refreshOptions: RefreshOptions
  
  Options to configure refresh and opt-in to proactive refreshing.
Returns AzureCommunicationUserCredential

Methods

dispose

dispose(): void

Implementation of CommunicationUserCredential.dispose
- Defined in communicationUserCredential.ts:66
Disposes the CommunicationUserCredential and cancels any internal auto-refresh operation.

Returns void

getToken

getToken(abortSignal?: AbortSignalLike): Promise<AccessToken>

Implementation of CommunicationUserCredential.getToken
- Defined in communicationUserCredential.ts:56
Gets an AccessToken for the user. Throws if already disposed.

Parameters
- Optional abortSignal: AbortSignalLike
  
  An implementation of AbortSignalLike to cancel the operation.
Returns Promise<AccessToken>

Generated using TypeDoc