@azure/communication-common package
Classes
| AzureCommunicationTokenCredential |
The CommunicationTokenCredential implementation with support for proactive token refresh. |
Interfaces
| CommunicationGetTokenOptions |
Options for |
| CommunicationTokenCredential |
The Azure Communication Services token credential. |
| CommunicationTokenRefreshOptions |
Options for auto-refreshing a Communication Token credential. |
| CommunicationUserIdentifier |
An Azure Communication user. |
| CommunicationUserKind |
IdentifierKind for a CommunicationUserIdentifier. |
| EntraCommunicationTokenCredentialOptions |
The Entra Communication Token Options. |
| MicrosoftTeamsAppIdentifier |
A Microsoft Teams App. |
| MicrosoftTeamsAppKind |
IdentifierKind for a MicrosoftTeamsAppIdentifier. |
| MicrosoftTeamsUserIdentifier |
A Microsoft Teams user. |
| MicrosoftTeamsUserKind |
IdentifierKind for a MicrosoftTeamsUserIdentifier. |
| PhoneNumberIdentifier |
A phone number. |
| PhoneNumberKind |
IdentifierKind for a PhoneNumberIdentifier. |
| TeamsExtensionUserIdentifier |
A Microsoft Teams Phone user who is using the Azure Communication Services resource to extend their Teams Phone set up. |
| TeamsExtensionUserKind |
IdentifierKind for a TeamsExtensionUserIdentifier. |
| UnknownIdentifier |
An unknown identifier that doesn't fit any of the other identifier types. |
| UnknownIdentifierKind |
IdentifierKind for UnknownIdentifier. |
Type Aliases
| CommunicationIdentifier |
Identifies a communication participant. |
| CommunicationIdentifierKind |
The CommunicationIdentifierKind is a discriminated union that adds a property |
Functions
| create |
Creates a CommunicationIdentifierKind from a given rawId. When storing rawIds use this function to restore the identifier that was encoded in the rawId. |
| get |
Returns the CommunicationIdentifierKind for a given CommunicationIdentifier. Returns undefined if the kind couldn't be inferred. |
| get |
Returns the rawId for a given CommunicationIdentifier. You can use the rawId for encoding the identifier and then use it as a key in a database. |
| is |
Tests an Identifier to determine whether it implements CommunicationUserIdentifier. |
| is |
Checks whether a value is a KeyCredential. |
| is |
Tests an Identifier to determine whether it implements MicrosoftTeamsAppIdentifier. |
| is |
Tests an Identifier to determine whether it implements MicrosoftTeamsUserIdentifier. |
| is |
Tests an Identifier to determine whether it implements PhoneNumberIdentifier. |
| is |
Tests an Identifier to determine whether it implements TeamsExtensionUserIdentifier. |
| is |
Tests an Identifier to determine whether it implements UnknownIdentifier. |
Function Details
createIdentifierFromRawId(string)
Creates a CommunicationIdentifierKind from a given rawId. When storing rawIds use this function to restore the identifier that was encoded in the rawId.
function createIdentifierFromRawId(rawId: string): CommunicationIdentifierKindParameters
- rawId
-
string
The rawId to be translated to its identifier representation.
Returns
getIdentifierKind(CommunicationIdentifier)
Returns the CommunicationIdentifierKind for a given CommunicationIdentifier. Returns undefined if the kind couldn't be inferred.
function getIdentifierKind(identifier: CommunicationIdentifier): CommunicationIdentifierKindParameters
- identifier
- CommunicationIdentifier
The identifier whose kind is to be inferred.
Returns
getIdentifierRawId(CommunicationIdentifier)
Returns the rawId for a given CommunicationIdentifier. You can use the rawId for encoding the identifier and then use it as a key in a database.
function getIdentifierRawId(identifier: CommunicationIdentifier): stringParameters
- identifier
- CommunicationIdentifier
The identifier to be translated to its rawId.
Returns
string
isCommunicationUserIdentifier(CommunicationIdentifier)
Tests an Identifier to determine whether it implements CommunicationUserIdentifier.
function isCommunicationUserIdentifier(identifier: CommunicationIdentifier): identifierParameters
- identifier
- CommunicationIdentifier
The assumed CommunicationUserIdentifier to be tested.
Returns
identifier
isKeyCredential(unknown)
Checks whether a value is a KeyCredential.
function isKeyCredential(credential: unknown): credentialParameters
- credential
-
unknown
The credential being checked.
Returns
credential
isMicrosoftTeamsAppIdentifier(CommunicationIdentifier)
Tests an Identifier to determine whether it implements MicrosoftTeamsAppIdentifier.
function isMicrosoftTeamsAppIdentifier(identifier: CommunicationIdentifier): identifierParameters
- identifier
- CommunicationIdentifier
The assumed available to be tested.
Returns
identifier
isMicrosoftTeamsUserIdentifier(CommunicationIdentifier)
Tests an Identifier to determine whether it implements MicrosoftTeamsUserIdentifier.
function isMicrosoftTeamsUserIdentifier(identifier: CommunicationIdentifier): identifierParameters
- identifier
- CommunicationIdentifier
The assumed available to be tested.
Returns
identifier
isPhoneNumberIdentifier(CommunicationIdentifier)
Tests an Identifier to determine whether it implements PhoneNumberIdentifier.
function isPhoneNumberIdentifier(identifier: CommunicationIdentifier): identifierParameters
- identifier
- CommunicationIdentifier
The assumed PhoneNumberIdentifier to be tested.
Returns
identifier
isTeamsExtensionUserIdentifier(CommunicationIdentifier)
Tests an Identifier to determine whether it implements TeamsExtensionUserIdentifier.
function isTeamsExtensionUserIdentifier(identifier: CommunicationIdentifier): identifierParameters
- identifier
- CommunicationIdentifier
The assumed available to be tested.
Returns
identifier
isUnknownIdentifier(CommunicationIdentifier)
Tests an Identifier to determine whether it implements UnknownIdentifier.
function isUnknownIdentifier(identifier: CommunicationIdentifier): identifierParameters
- identifier
- CommunicationIdentifier
The assumed UnknownIdentifier to be tested.
Returns
identifier