@azure/communication-common package

Klassen

AzureCommunicationTokenCredential

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

Schnittstellen

CommunicationGetTokenOptions	Optionen für CommunicationTokenCredential'getToken-Funktion.
CommunicationTokenCredential	Die Azure Communication Services-Tokenanmeldeinformationen.
CommunicationTokenRefreshOptions	Optionen zum automatischen Aktualisieren von Anmeldeinformationen für Kommunikationstoken.
CommunicationUserIdentifier	Ein Azure Communication-Benutzer.
CommunicationUserKind	IdentifierKind für einen CommunicationUserIdentifier.
EntraCommunicationTokenCredentialOptions	Die Optionen für den Entra Communication Token.
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.
TeamsExtensionUserIdentifier	Ein Microsoft Teams Telefon-Benutzer, der die Azure Communication Services-Ressource verwendet, um seine Teams Phone-Einrichtung zu erweitern.
TeamsExtensionUserKind	IdentifierKind für einen TeamsExtensionUserIdentifier.
UnknownIdentifier	Ein unbekannter Bezeichner, der nicht in einen der anderen Bezeichnertypen passt.
UnknownIdentifierKind	IdentifierKind für UnknownIdentifier.

Typaliase

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

Functions

isRestError(unknown)

Typeguard für RestError

Variablen

RestError	Ein benutzerdefinierter Fehlertyp für fehlgeschlagene Pipelineanforderungen.
createIdentifierFromRawId	Erstellt eine CommunicationIdentifierKind aus einer gegebenen rawId. Verwenden Sie beim Speichern von rawIds diese Funktion, um den Bezeichner wiederherzustellen, der in der rawId codiert wurde.
getIdentifierKind	Gibt "CommunicationIdentifierKind" für einen bestimmten CommunicationIdentifier zurück. Gibt nicht definiert zurück, wenn die Art nicht abgeleitet werden konnte.
getIdentifierRawId	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	Testet einen Bezeichner, um festzustellen, ob communicationUserIdentifier implementiert wird.
isKeyCredential	Überprüft, ob ein Wert ein KeyCredential-Wert ist.
isMicrosoftTeamsAppIdentifier	Testet einen Bezeichner, um festzustellen, ob microsoftTeamsAppIdentifier implementiert wird.
isMicrosoftTeamsUserIdentifier	Testet einen Bezeichner, um zu bestimmen, ob microsoftTeamsUserIdentifier implementiert wird.
isPhoneNumberIdentifier	Testet einen Bezeichner, um zu bestimmen, ob phoneNumberIdentifier implementiert wird.
isTeamsExtensionUserIdentifier	Testet einen Bezeichner, um zu bestimmen, ob TeamsExtensionUserIdentifier implementiert wird.
isUnknownIdentifier	Testet einen Bezeichner, um zu ermitteln, ob UnbekanntIdentifier implementiert wird.

Details zur Funktion

isRestError(unknown)

Typeguard für RestError

function isRestError(e: unknown): e is RestError

Parameter

e

unknown

Etwas, das von einer Catch-Klausel abgefangen wird.

Gibt zurück

e is RestError

Details zu Variablen

RestError

Ein benutzerdefinierter Fehlertyp für fehlgeschlagene Pipelineanforderungen.

RestError: RestErrorConstructor

Typ

RestErrorConstructor

createIdentifierFromRawId

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

createIdentifierFromRawId: (rawId: string) => CommunicationIdentifierKind

Typ

(rawId: string) => CommunicationIdentifierKind

getIdentifierKind

Gibt "CommunicationIdentifierKind" für einen bestimmten CommunicationIdentifier zurück. Gibt nicht definiert zurück, wenn die Art nicht abgeleitet werden konnte.

getIdentifierKind: (identifier: CommunicationIdentifier) => CommunicationIdentifierKind

Typ

(identifier: CommunicationIdentifier) => CommunicationIdentifierKind

getIdentifierRawId

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.

getIdentifierRawId: (identifier: CommunicationIdentifier) => string

Typ

(identifier: CommunicationIdentifier) => string

isCommunicationUserIdentifier

Testet einen Bezeichner, um festzustellen, ob communicationUserIdentifier implementiert wird.

isCommunicationUserIdentifier: (identifier: CommunicationIdentifier) => identifier is CommunicationUserIdentifier

Typ

(identifier: CommunicationIdentifier) => identifier is CommunicationUserIdentifier

isKeyCredential

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

isKeyCredential: (credential: unknown) => credential is KeyCredential

Typ

(credential: unknown) => credential is KeyCredential

isMicrosoftTeamsAppIdentifier

Testet einen Bezeichner, um festzustellen, ob microsoftTeamsAppIdentifier implementiert wird.

isMicrosoftTeamsAppIdentifier: (identifier: CommunicationIdentifier) => identifier is MicrosoftTeamsAppIdentifier

Typ

(identifier: CommunicationIdentifier) => identifier is MicrosoftTeamsAppIdentifier

isMicrosoftTeamsUserIdentifier

Testet einen Bezeichner, um zu bestimmen, ob microsoftTeamsUserIdentifier implementiert wird.

isMicrosoftTeamsUserIdentifier: (identifier: CommunicationIdentifier) => identifier is MicrosoftTeamsUserIdentifier

Typ

(identifier: CommunicationIdentifier) => identifier is MicrosoftTeamsUserIdentifier

isPhoneNumberIdentifier

Testet einen Bezeichner, um zu bestimmen, ob phoneNumberIdentifier implementiert wird.

isPhoneNumberIdentifier: (identifier: CommunicationIdentifier) => identifier is PhoneNumberIdentifier

Typ

(identifier: CommunicationIdentifier) => identifier is PhoneNumberIdentifier

isTeamsExtensionUserIdentifier

Testet einen Bezeichner, um zu bestimmen, ob TeamsExtensionUserIdentifier implementiert wird.

isTeamsExtensionUserIdentifier: (identifier: CommunicationIdentifier) => identifier is TeamsExtensionUserIdentifier

Typ

(identifier: CommunicationIdentifier) => identifier is TeamsExtensionUserIdentifier

isUnknownIdentifier

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

isUnknownIdentifier: (identifier: CommunicationIdentifier) => identifier is UnknownIdentifier

Typ

(identifier: CommunicationIdentifier) => identifier is UnknownIdentifier