@azure/communication-common package

Klassen

AzureCommunicationTokenCredential

De CommunicationTokenCredential-implementatie met ondersteuning voor proactief vernieuwen van tokens.

Interfaces

CommunicationGetTokenOptions	Opties voor CommunicationTokenCredential's getToken functie.
CommunicationTokenCredential	De Azure Communication Services tokenreferentie.
CommunicationTokenRefreshOptions	Opties voor het automatisch vernieuwen van een communicatietokenreferentie.
CommunicationUserIdentifier	Een Azure Communication-gebruiker.
CommunicationUserKind	IdentifierKind voor een CommunicationUserIdentifier.
MicrosoftTeamsAppIdentifier	Een Microsoft Teams-app.
MicrosoftTeamsAppKind	IdentifierKind voor een MicrosoftTeamsAppIdentifier.
MicrosoftTeamsUserIdentifier	Een Microsoft Teams-gebruiker.
MicrosoftTeamsUserKind	IdentifierKind voor een MicrosoftTeamsUserIdentifier.
PhoneNumberIdentifier	Een telefoonnummer.
PhoneNumberKind	IdentifierKind voor een PhoneNumberIdentifier.
UnknownIdentifier	Een onbekende id die niet past bij een van de andere id-typen.
UnknownIdentifierKind	IdentifierKind voor UnknownIdentifier.

Type-aliassen

CommunicationIdentifier	Identificeert een communicatiedeelnemer.
CommunicationIdentifierKind	CommunicationIdentifierKind is een gediscrimineerde samenvoeging die een eigenschap kind toevoegt aan een id.

Functies

createIdentifierFromRawId(string)	Hiermee maakt u een CommunicationIdentifierKind op basis van een bepaalde rawId. Wanneer u rawIds opslaat, gebruikt u deze functie om de id te herstellen die is gecodeerd in de rawId.
getIdentifierKind(CommunicationIdentifier)	Retourneert het CommunicationIdentifierKind voor een bepaalde CommunicationIdentifier. Retourneert niet-gedefinieerd als het type niet kan worden afgeleid.
getIdentifierRawId(CommunicationIdentifier)	Retourneert de rawId voor een bepaalde CommunicationIdentifier. U kunt de rawId gebruiken voor het coderen van de id en deze vervolgens gebruiken als sleutel in een database.
isCommunicationUserIdentifier(CommunicationIdentifier)	Test een id om te bepalen of CommunicationUserIdentifier wordt geïmplementeerd.
isKeyCredential(unknown)	Hiermee wordt gecontroleerd of een waarde een KeyCredential is.
isMicrosoftTeamsAppIdentifier(CommunicationIdentifier)	Test een id om te bepalen of MicrosoftTeamsAppIdentifier wordt geïmplementeerd.
isMicrosoftTeamsUserIdentifier(CommunicationIdentifier)	Test een id om te bepalen of MicrosoftTeamsUserIdentifier wordt geïmplementeerd.
isPhoneNumberIdentifier(CommunicationIdentifier)	Test een id om te bepalen of deze PhoneNumberIdentifier implementeert.
isUnknownIdentifier(CommunicationIdentifier)	Test een id om te bepalen of UnknownIdentifier wordt geïmplementeerd.

Functiedetails

createIdentifierFromRawId(string)

Hiermee maakt u een CommunicationIdentifierKind op basis van een bepaalde rawId. Wanneer u rawIds opslaat, gebruikt u deze functie om de id te herstellen die is gecodeerd in de rawId.

function createIdentifierFromRawId(rawId: string): CommunicationIdentifierKind

Parameters

rawId

string

De rawId die moet worden vertaald naar de id-weergave.

Retouren

CommunicationIdentifierKind

getIdentifierKind(CommunicationIdentifier)

Retourneert het CommunicationIdentifierKind voor een bepaalde CommunicationIdentifier. Retourneert niet-gedefinieerd als het type niet kan worden afgeleid.

function getIdentifierKind(identifier: CommunicationIdentifier): CommunicationIdentifierKind

Parameters

identifier

CommunicationIdentifier

De id waarvan het type moet worden afgeleid.

Retouren

CommunicationIdentifierKind

getIdentifierRawId(CommunicationIdentifier)

Retourneert de rawId voor een bepaalde CommunicationIdentifier. U kunt de rawId gebruiken voor het coderen van de id en deze vervolgens gebruiken als sleutel in een database.

function getIdentifierRawId(identifier: CommunicationIdentifier): string

Parameters

identifier

CommunicationIdentifier

De id die moet worden vertaald naar de rawId.

Retouren

string

isCommunicationUserIdentifier(CommunicationIdentifier)

Test een id om te bepalen of CommunicationUserIdentifier wordt geïmplementeerd.

function isCommunicationUserIdentifier(identifier: CommunicationIdentifier): identifier

Parameters

identifier

CommunicationIdentifier

De veronderstelde CommunicationUserIdentifier die moet worden getest.

Retouren

identifier

isKeyCredential(unknown)

Hiermee wordt gecontroleerd of een waarde een KeyCredential is.

function isKeyCredential(credential: unknown): credential

Parameters

credential

unknown

De referentie die wordt gecontroleerd.

Retouren

credential

isMicrosoftTeamsAppIdentifier(CommunicationIdentifier)

Test een id om te bepalen of MicrosoftTeamsAppIdentifier wordt geïmplementeerd.

function isMicrosoftTeamsAppIdentifier(identifier: CommunicationIdentifier): identifier

Parameters

identifier

CommunicationIdentifier

De verondersteld beschikbaar te zijn om te worden getest.

Retouren

identifier

isMicrosoftTeamsUserIdentifier(CommunicationIdentifier)

Test een id om te bepalen of MicrosoftTeamsUserIdentifier wordt geïmplementeerd.

function isMicrosoftTeamsUserIdentifier(identifier: CommunicationIdentifier): identifier

Parameters

identifier

CommunicationIdentifier

De verondersteld beschikbaar te zijn om te worden getest.

Retouren

identifier

isPhoneNumberIdentifier(CommunicationIdentifier)

Test een id om te bepalen of deze PhoneNumberIdentifier implementeert.

function isPhoneNumberIdentifier(identifier: CommunicationIdentifier): identifier

Parameters

identifier

CommunicationIdentifier

De veronderstelde PhoneNumberIdentifier die moet worden getest.

Retouren

identifier

isUnknownIdentifier(CommunicationIdentifier)

Test een id om te bepalen of UnknownIdentifier wordt geïmplementeerd.

function isUnknownIdentifier(identifier: CommunicationIdentifier): identifier

Parameters

identifier

CommunicationIdentifier

De veronderstelde UnknownIdentifier die moet worden getest.

Retouren

identifier