@azure/communication-common package

Klassen

AzureCommunicationTokenCredential

Die CommunicationTokenCredential-Implementierung mit Unterstützung für proaktive Tokenaktualisierungen.

Schnittstellen

CommunicationGetTokenOptions	Optionen für CommunicationTokenCredentialdie getToken -Funktion.
CommunicationTokenCredential	Die Azure Communication Services Tokenanmeldeinformationen.
CommunicationTokenRefreshOptions	Optionen zum automatischen Aktualisieren von Kommunikationstokenanmeldeinformationen.
CommunicationUserIdentifier	Ein Azure Communication-Benutzer.
CommunicationUserKind	IdentifierKind für einen CommunicationUserIdentifier.
MicrosoftTeamsAppIdentifier	Eine Microsoft Teams-App.
MicrosoftTeamsAppKind	IdentifierKind für einen MicrosoftTeamsAppIdentifier.
MicrosoftTeamsUserIdentifier	Ein Microsoft Teams-Benutzer.
MicrosoftTeamsUserKind	IdentifierKind für einen MicrosoftTeamsUserIdentifier.
PhoneNumberIdentifier	Eine Telefonnummer.
PhoneNumberKind	IdentifierKind für einen PhoneNumberIdentifier.
UnknownIdentifier	Ein unbekannter Bezeichner, der keinem der anderen Bezeichnertypen entspricht.
UnknownIdentifierKind	IdentifierKind für UnknownIdentifier.

Typaliase

CommunicationIdentifier	Identifiziert einen Kommunikationsteilnehmer.
CommunicationIdentifierKind	CommunicationIdentifierKind ist eine diskriminierte Union, die einem Bezeichner eine Eigenschaft kind hinzufügt.

Functions

createIdentifierFromRawId(string)	Erstellt eine CommunicationIdentifierKind aus einer angegebenen rawId. Verwenden Sie beim Speichern von rawIds diese Funktion, um den Bezeichner wiederherzustellen, der in der rawId codiert wurde.
getIdentifierKind(CommunicationIdentifier)	Gibt communicationIdentifierKind für einen angegebenen CommunicationIdentifier zurück. Gibt undefined zurück, wenn die Art nicht abgeleitet werden konnte.
getIdentifierRawId(CommunicationIdentifier)	Gibt die rawId für einen bestimmten CommunicationIdentifier zurück. Sie können die rawId zum Codieren des Bezeichners und dann als Schlüssel in einer Datenbank verwenden.
isCommunicationUserIdentifier(CommunicationIdentifier)	Testet einen Bezeichner, um zu ermitteln, ob CommunicationUserIdentifier implementiert wird.
isKeyCredential(unknown)	Überprüft, ob ein Wert ein KeyCredential-Wert ist.
isMicrosoftTeamsAppIdentifier(CommunicationIdentifier)	Testet einen Bezeichner, um zu ermitteln, ob MicrosoftTeamsAppIdentifier implementiert wird.
isMicrosoftTeamsUserIdentifier(CommunicationIdentifier)	Testet einen Bezeichner, um zu ermitteln, ob MicrosoftTeamsUserIdentifier implementiert wird.
isPhoneNumberIdentifier(CommunicationIdentifier)	Testet einen Bezeichner, um zu ermitteln, ob PhoneNumberIdentifier implementiert wird.
isUnknownIdentifier(CommunicationIdentifier)	Testet einen Bezeichner, um zu ermitteln, ob UnknownIdentifier implementiert wird.

Details zur Funktion

createIdentifierFromRawId(string)

Erstellt eine CommunicationIdentifierKind aus einer angegebenen rawId. Verwenden Sie beim Speichern von rawIds diese Funktion, um den Bezeichner wiederherzustellen, der in der rawId codiert wurde.

function createIdentifierFromRawId(rawId: string): CommunicationIdentifierKind

Parameter

rawId

string

Die rawId, die in ihre Bezeichnerdarstellung übersetzt werden soll.

Gibt zurück

CommunicationIdentifierKind

getIdentifierKind(CommunicationIdentifier)

Gibt communicationIdentifierKind für einen angegebenen CommunicationIdentifier zurück. Gibt undefined zurück, wenn die Art nicht abgeleitet werden konnte.

function getIdentifierKind(identifier: CommunicationIdentifier): CommunicationIdentifierKind

Parameter

identifier

CommunicationIdentifier

Der Bezeichner, dessen Art abgeleitet werden soll.

Gibt zurück

CommunicationIdentifierKind

getIdentifierRawId(CommunicationIdentifier)

Gibt die rawId für einen bestimmten CommunicationIdentifier zurück. Sie können die rawId zum Codieren des Bezeichners und dann als Schlüssel in einer Datenbank verwenden.

function getIdentifierRawId(identifier: CommunicationIdentifier): string

Parameter

identifier

CommunicationIdentifier

Der Bezeichner, der in seine rawId übersetzt werden soll.

Gibt zurück

string

isCommunicationUserIdentifier(CommunicationIdentifier)

Testet einen Bezeichner, um zu ermitteln, ob CommunicationUserIdentifier implementiert wird.

function isCommunicationUserIdentifier(identifier: CommunicationIdentifier): identifier

Parameter

identifier

CommunicationIdentifier

Der angenommene CommunicationUserIdentifier, der getestet werden soll.

Gibt zurück

identifier

isKeyCredential(unknown)

Überprüft, ob ein Wert ein KeyCredential-Wert ist.

function isKeyCredential(credential: unknown): credential

Parameter

credential

unknown

Die anmeldeinformationen, die überprüft werden.

Gibt zurück

credential

isMicrosoftTeamsAppIdentifier(CommunicationIdentifier)

Testet einen Bezeichner, um zu ermitteln, ob MicrosoftTeamsAppIdentifier implementiert wird.

function isMicrosoftTeamsAppIdentifier(identifier: CommunicationIdentifier): identifier

Parameter

identifier

CommunicationIdentifier

Die angenommene Verfügbare, die getestet werden soll.

Gibt zurück

identifier

isMicrosoftTeamsUserIdentifier(CommunicationIdentifier)

Testet einen Bezeichner, um zu ermitteln, ob MicrosoftTeamsUserIdentifier implementiert wird.

function isMicrosoftTeamsUserIdentifier(identifier: CommunicationIdentifier): identifier

Parameter

identifier

CommunicationIdentifier

Die angenommene Verfügbare, die getestet werden soll.

Gibt zurück

identifier

isPhoneNumberIdentifier(CommunicationIdentifier)

Testet einen Bezeichner, um zu ermitteln, ob PhoneNumberIdentifier implementiert wird.

function isPhoneNumberIdentifier(identifier: CommunicationIdentifier): identifier

Parameter

identifier

CommunicationIdentifier

Der angenommene PhoneNumberIdentifier, der getestet werden soll.

Gibt zurück

identifier

isUnknownIdentifier(CommunicationIdentifier)

Testet einen Bezeichner, um zu ermitteln, ob UnknownIdentifier implementiert wird.

function isUnknownIdentifier(identifier: CommunicationIdentifier): identifier

Parameter

identifier

CommunicationIdentifier

Der angenommene UnknownIdentifier, der getestet werden soll.

Gibt zurück

identifier