@azure/communication-common package

Klasser

AzureCommunicationTokenCredential

CommunicationTokenCredential-implementeringen med stöd för proaktiv tokenuppdatering.

Gränssnitt

CommunicationGetTokenOptions	Alternativ för CommunicationTokenCredentialfunktionen 's getToken .
CommunicationTokenCredential	Den Azure Communication Services tokenautentiseringsuppgiften.
CommunicationTokenRefreshOptions	Alternativ för automatisk uppdatering av autentiseringsuppgifter för kommunikationstoken.
CommunicationUserIdentifier	En Azure Communication-användare.
CommunicationUserKind	IdentifierKind för en CommunicationUserIdentifier.
MicrosoftTeamsAppIdentifier	En Microsoft Teams-app.
MicrosoftTeamsAppKind	IdentifierKind för en MicrosoftTeamsAppIdentifier.
MicrosoftTeamsUserIdentifier	En Microsoft Teams-användare.
MicrosoftTeamsUserKind	IdentifierKind för en MicrosoftTeamsUserIdentifier.
PhoneNumberIdentifier	Ett telefonnummer.
PhoneNumberKind	IdentifierKind för en PhoneNumberIdentifier.
UnknownIdentifier	En okänd identifierare som inte passar någon av de andra identifierartyperna.
UnknownIdentifierKind	IdentifierKind för UnknownIdentifier.

Typalias

CommunicationIdentifier	Identifierar en kommunikationsdeltagare.
CommunicationIdentifierKind	CommunicationIdentifierKind är en diskriminerad union som lägger till en egenskap kind i en identifierare.

Funktioner

createIdentifierFromRawId(string)	Skapar en CommunicationIdentifierKind från ett givet rawId. När du lagrar rawIds använder du den här funktionen för att återställa identifieraren som kodades i rawId.
getIdentifierKind(CommunicationIdentifier)	Returnerar CommunicationIdentifierKind för en viss CommunicationIdentifier. Returnerar odefinierat om typen inte kunde härledas.
getIdentifierRawId(CommunicationIdentifier)	Returnerar rawId för en given CommunicationIdentifier. Du kan använda rawId för att koda identifieraren och sedan använda det som en nyckel i en databas.
isCommunicationUserIdentifier(CommunicationIdentifier)	Testar en identifierare för att avgöra om den implementerar CommunicationUserIdentifier.
isKeyCredential(unknown)	Kontrollerar om ett värde är en KeyCredential.
isMicrosoftTeamsAppIdentifier(CommunicationIdentifier)	Testar en identifierare för att avgöra om den implementerar MicrosoftTeamsAppIdentifier.
isMicrosoftTeamsUserIdentifier(CommunicationIdentifier)	Testar en identifierare för att avgöra om den implementerar MicrosoftTeamsUserIdentifier.
isPhoneNumberIdentifier(CommunicationIdentifier)	Testar en identifierare för att avgöra om den implementerar PhoneNumberIdentifier.
isUnknownIdentifier(CommunicationIdentifier)	Testar en identifierare för att avgöra om den implementerar UnknownIdentifier.

Funktionsinformation

createIdentifierFromRawId(string)

Skapar en CommunicationIdentifierKind från ett givet rawId. När du lagrar rawIds använder du den här funktionen för att återställa identifieraren som kodades i rawId.

function createIdentifierFromRawId(rawId: string): CommunicationIdentifierKind

Parametrar

rawId

string

RawId som ska översättas till dess identifierarrepresentation.

Returer

CommunicationIdentifierKind

getIdentifierKind(CommunicationIdentifier)

Returnerar CommunicationIdentifierKind för en viss CommunicationIdentifier. Returnerar odefinierat om typen inte kunde härledas.

function getIdentifierKind(identifier: CommunicationIdentifier): CommunicationIdentifierKind

Parametrar

identifier

CommunicationIdentifier

Den identifierare vars typ ska härledas.

Returer

CommunicationIdentifierKind

getIdentifierRawId(CommunicationIdentifier)

Returnerar rawId för en given CommunicationIdentifier. Du kan använda rawId för att koda identifieraren och sedan använda det som en nyckel i en databas.

function getIdentifierRawId(identifier: CommunicationIdentifier): string

Parametrar

identifier

CommunicationIdentifier

Identifieraren som ska översättas till dess rawId.

Returer

string

isCommunicationUserIdentifier(CommunicationIdentifier)

Testar en identifierare för att avgöra om den implementerar CommunicationUserIdentifier.

function isCommunicationUserIdentifier(identifier: CommunicationIdentifier): identifier

Parametrar

identifier

CommunicationIdentifier

Den förmodade CommunicationUserIdentifier som ska testas.

Returer

identifier

isKeyCredential(unknown)

Kontrollerar om ett värde är en KeyCredential.

function isKeyCredential(credential: unknown): credential

Parametrar

credential

unknown

Autentiseringsuppgifterna som kontrolleras.

Returer

credential

isMicrosoftTeamsAppIdentifier(CommunicationIdentifier)

Testar en identifierare för att avgöra om den implementerar MicrosoftTeamsAppIdentifier.

function isMicrosoftTeamsAppIdentifier(identifier: CommunicationIdentifier): identifier

Parametrar

identifier

CommunicationIdentifier

Den antagna tillgängliga som ska testas.

Returer

identifier

isMicrosoftTeamsUserIdentifier(CommunicationIdentifier)

Testar en identifierare för att avgöra om den implementerar MicrosoftTeamsUserIdentifier.

function isMicrosoftTeamsUserIdentifier(identifier: CommunicationIdentifier): identifier

Parametrar

identifier

CommunicationIdentifier

Den antagna tillgängliga som ska testas.

Returer

identifier

isPhoneNumberIdentifier(CommunicationIdentifier)

Testar en identifierare för att avgöra om den implementerar PhoneNumberIdentifier.

function isPhoneNumberIdentifier(identifier: CommunicationIdentifier): identifier

Parametrar

identifier

CommunicationIdentifier

Den antagna PhoneNumberIdentifier som ska testas.

Returer

identifier

isUnknownIdentifier(CommunicationIdentifier)

Testar en identifierare för att avgöra om den implementerar UnknownIdentifier.

function isUnknownIdentifier(identifier: CommunicationIdentifier): identifier

Parametrar

identifier

CommunicationIdentifier

Den antagna UnknownIdentifier som ska testas.

Returer

identifier