@azure/communication-common package

Classes

AzureCommunicationTokenCredential

Implémentation communicationTokenCredential avec prise en charge de l’actualisation proactive des jetons.

Interfaces

CommunicationGetTokenOptions	Options pour CommunicationTokenCredentialla fonction de getToken .
CommunicationTokenCredential	Informations d’identification du jeton Azure Communication Services.
CommunicationTokenRefreshOptions	Options d’actualisation automatique des informations d’identification d’un jeton de communication.
CommunicationUserIdentifier	Un utilisateur Azure Communication.
CommunicationUserKind	IdentifierKind pour un Objet CommunicationUserIdentifier.
MicrosoftTeamsAppIdentifier	Une application Microsoft Teams.
MicrosoftTeamsAppKind	IdentifierKind pour un MicrosoftTeamsAppIdentifier.
MicrosoftTeamsUserIdentifier	Un utilisateur Microsoft Teams.
MicrosoftTeamsUserKind	IdentifierKind pour un MicrosoftTeamsUserIdentifier.
PhoneNumberIdentifier	Un numéro de téléphone
PhoneNumberKind	IdentifierKind pour un PhoneNumberIdentifier.
UnknownIdentifier	Identificateur inconnu qui ne correspond à aucun des autres types d’identificateurs.
UnknownIdentifierKind	IdentifierKind pour UnknownIdentifier.

Alias de type

CommunicationIdentifier	Identifie un participant à la communication.
CommunicationIdentifierKind	CommunicationIdentifierKind est une union discriminée qui ajoute une propriété kind à un identificateur.

Fonctions

createIdentifierFromRawId(string)	Crée un CommunicationIdentifierKind à partir d’un rawId donné. Lors du stockage des rawIds, utilisez cette fonction pour restaurer l’identificateur qui a été encodé dans le rawId.
getIdentifierKind(CommunicationIdentifier)	Renvoie communicationIdentifierKind pour un CommunicationIdentifier donné. Retourne undefined si le type n’a pas pu être déduit.
getIdentifierRawId(CommunicationIdentifier)	Retourne le rawId pour un CommunicationIdentifier donné. Vous pouvez utiliser le rawId pour encoder l’identificateur, puis l’utiliser comme clé dans une base de données.
isCommunicationUserIdentifier(CommunicationIdentifier)	Teste un identificateur pour déterminer s’il implémente CommunicationUserIdentifier.
isKeyCredential(unknown)	Vérifie si une valeur est un KeyCredential.
isMicrosoftTeamsAppIdentifier(CommunicationIdentifier)	Teste un identificateur pour déterminer s’il implémente MicrosoftTeamsAppIdentifier.
isMicrosoftTeamsUserIdentifier(CommunicationIdentifier)	Teste un identificateur pour déterminer s’il implémente MicrosoftTeamsUserIdentifier.
isPhoneNumberIdentifier(CommunicationIdentifier)	Teste un identificateur pour déterminer s’il implémente PhoneNumberIdentifier.
isUnknownIdentifier(CommunicationIdentifier)	Teste un identificateur pour déterminer s’il implémente UnknownIdentifier.

Informations relatives à la fonction

createIdentifierFromRawId(string)

Crée un CommunicationIdentifierKind à partir d’un rawId donné. Lors du stockage des rawIds, utilisez cette fonction pour restaurer l’identificateur qui a été encodé dans le rawId.

function createIdentifierFromRawId(rawId: string): CommunicationIdentifierKind

Paramètres

rawId

string

RawId à traduire en sa représentation d’identificateur.

Retours

CommunicationIdentifierKind

getIdentifierKind(CommunicationIdentifier)

Renvoie communicationIdentifierKind pour un CommunicationIdentifier donné. Retourne undefined si le type n’a pas pu être déduit.

function getIdentifierKind(identifier: CommunicationIdentifier): CommunicationIdentifierKind

Paramètres

identifier

CommunicationIdentifier

Identificateur dont le type doit être déduit.

Retours

CommunicationIdentifierKind

getIdentifierRawId(CommunicationIdentifier)

Retourne le rawId pour un CommunicationIdentifier donné. Vous pouvez utiliser le rawId pour encoder l’identificateur, puis l’utiliser comme clé dans une base de données.

function getIdentifierRawId(identifier: CommunicationIdentifier): string

Paramètres

identifier

CommunicationIdentifier

Identificateur à traduire en rawId.

Retours

string

isCommunicationUserIdentifier(CommunicationIdentifier)

Teste un identificateur pour déterminer s’il implémente CommunicationUserIdentifier.

function isCommunicationUserIdentifier(identifier: CommunicationIdentifier): identifier

Paramètres

identifier

CommunicationIdentifier

Le supposé CommunicationUserIdentifier à tester.

Retours

identifier

isKeyCredential(unknown)

Vérifie si une valeur est un KeyCredential.

function isKeyCredential(credential: unknown): credential

Paramètres

credential

unknown

Informations d’identification en cours de vérification.

Retours

credential

isMicrosoftTeamsAppIdentifier(CommunicationIdentifier)

Teste un identificateur pour déterminer s’il implémente MicrosoftTeamsAppIdentifier.

function isMicrosoftTeamsAppIdentifier(identifier: CommunicationIdentifier): identifier

Paramètres

identifier

CommunicationIdentifier

Supposé disponible pour être testé.

Retours

identifier

isMicrosoftTeamsUserIdentifier(CommunicationIdentifier)

Teste un identificateur pour déterminer s’il implémente MicrosoftTeamsUserIdentifier.

function isMicrosoftTeamsUserIdentifier(identifier: CommunicationIdentifier): identifier

Paramètres

identifier

CommunicationIdentifier

Supposé disponible pour être testé.

Retours

identifier

isPhoneNumberIdentifier(CommunicationIdentifier)

Teste un identificateur pour déterminer s’il implémente PhoneNumberIdentifier.

function isPhoneNumberIdentifier(identifier: CommunicationIdentifier): identifier

Paramètres

identifier

CommunicationIdentifier

PhoneNumberIdentifier supposé à tester.

Retours

identifier

isUnknownIdentifier(CommunicationIdentifier)

Teste un identificateur pour déterminer s’il implémente UnknownIdentifier.

function isUnknownIdentifier(identifier: CommunicationIdentifier): identifier

Paramètres

identifier

CommunicationIdentifier

UnknownIdentifier supposé à tester.

Retours

identifier