@azure/communication-common package

Klassen

AzureCommunicationTokenCredential

De CommunicationTokenCredential-implementatie met ondersteuning voor proactieve vernieuwing van tokens.

Interfaces

CommunicationGetTokenOptions	Opties voor CommunicationTokenCredentialgetToken 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.
EntraCommunicationTokenCredentialOptions	De opties voor Entra Communication Token.
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.
TeamsExtensionUserIdentifier	Een Microsoft Teams-telefoon-gebruiker die de Azure Communication Services-resource gebruikt om de instellingen van de Teams Phone uit te breiden.
TeamsExtensionUserKind	IdentifierKind voor een TeamsExtensionUserIdentifier.
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 aan een id toevoegt.

Functies

isRestError(unknown)

Typeguard voor RestError

Variabelen

RestError	Een aangepast fouttype voor mislukte pijplijnaanvragen.
createIdentifierFromRawId	Hiermee maakt u een CommunicationIdentifierKind op basis van een bepaalde rawId. Bij het opslaan van rawIds gebruikt u deze functie om de id te herstellen die is gecodeerd in de rawId.
getIdentifierKind	Retourneert de CommunicationIdentifierKind voor een bepaalde CommunicationIdentifier. Retourneert niet-gedefinieerd als het type niet kan worden afgeleid.
getIdentifierRawId	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	Hiermee wordt een id getest om te bepalen of communicationUserIdentifier wordt geïmplementeerd.
isKeyCredential	Hiermee wordt gecontroleerd of een waarde een KeyCredential is.
isMicrosoftTeamsAppIdentifier	Test een id om te bepalen of MicrosoftTeamsAppIdentifier wordt geïmplementeerd.
isMicrosoftTeamsUserIdentifier	Test een id om te bepalen of MicrosoftTeamsUserIdentifier wordt geïmplementeerd.
isPhoneNumberIdentifier	Hiermee wordt een id getest om te bepalen of PhoneNumberIdentifier wordt geïmplementeerd.
isTeamsExtensionUserIdentifier	Test een id om te bepalen of deze TeamsExtensionUserIdentifier implementeert.
isUnknownIdentifier	Hiermee wordt een id getest om te bepalen of UnknownIdentifier wordt geïmplementeerd.

Functiedetails

isRestError(unknown)

Typeguard voor RestError

function isRestError(e: unknown): e is RestError

Parameters

e

unknown

Iets betrapt door een catch-component.

Retouren

e is RestError

Variabele details

RestError

Een aangepast fouttype voor mislukte pijplijnaanvragen.

RestError: RestErrorConstructor

Type

RestErrorConstructor

createIdentifierFromRawId

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

createIdentifierFromRawId: (rawId: string) => CommunicationIdentifierKind

Type

(rawId: string) => CommunicationIdentifierKind

getIdentifierKind

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

getIdentifierKind: (identifier: CommunicationIdentifier) => CommunicationIdentifierKind

Type

(identifier: CommunicationIdentifier) => CommunicationIdentifierKind

getIdentifierRawId

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.

getIdentifierRawId: (identifier: CommunicationIdentifier) => string

Type

(identifier: CommunicationIdentifier) => string

isCommunicationUserIdentifier

Hiermee wordt een id getest om te bepalen of communicationUserIdentifier wordt geïmplementeerd.

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

Type

(identifier: CommunicationIdentifier) => identifier is CommunicationUserIdentifier

isKeyCredential

Hiermee wordt gecontroleerd of een waarde een KeyCredential is.

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

Type

(credential: unknown) => credential is KeyCredential

isMicrosoftTeamsAppIdentifier

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

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

Type

(identifier: CommunicationIdentifier) => identifier is MicrosoftTeamsAppIdentifier

isMicrosoftTeamsUserIdentifier

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

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

Type

(identifier: CommunicationIdentifier) => identifier is MicrosoftTeamsUserIdentifier

isPhoneNumberIdentifier

Hiermee wordt een id getest om te bepalen of PhoneNumberIdentifier wordt geïmplementeerd.

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

Type

(identifier: CommunicationIdentifier) => identifier is PhoneNumberIdentifier

isTeamsExtensionUserIdentifier

Test een id om te bepalen of deze TeamsExtensionUserIdentifier implementeert.

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

Type

(identifier: CommunicationIdentifier) => identifier is TeamsExtensionUserIdentifier

isUnknownIdentifier

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

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

Type

(identifier: CommunicationIdentifier) => identifier is UnknownIdentifier