@azure/communication-common package

Classi

AzureCommunicationTokenCredential

Implementazione communicationTokenCredential con supporto per l'aggiornamento proattivo del token.

Interfacce

CommunicationGetTokenOptions	Opzioni per CommunicationTokenCredentialfunzione di getToken.
CommunicationTokenCredential	Credenziali del token di Servizi di comunicazione di Azure.
CommunicationTokenRefreshOptions	Opzioni per l'aggiornamento automatico delle credenziali di un token di comunicazione.
CommunicationUserIdentifier	Un utente di Comunicazione di Azure.
CommunicationUserKind	IdentifierKind per communicationUserIdentifier.
EntraCommunicationTokenCredentialOptions	Le opzioni del token di comunicazione Entra.
MicrosoftTeamsAppIdentifier	Un'app di Microsoft Teams.
MicrosoftTeamsAppKind	IdentifierKind per MicrosoftTeamsAppIdentifier.
MicrosoftTeamsUserIdentifier	Un utente di Microsoft Teams.
MicrosoftTeamsUserKind	IdentifierKind per MicrosoftTeamsUserIdentifier.
PhoneNumberIdentifier	Numero di telefono.
PhoneNumberKind	IdentifierKind per phoneNumberIdentifier.
TeamsExtensionUserIdentifier	Un utente di Telefono di Microsoft Teams che usa la risorsa Servizi di comunicazione di Azure per estendere la configurazione di Teams Phone.
TeamsExtensionUserKind	IdentifierKind per un TeamsExtensionUserIdentifier.
UnknownIdentifier	Identificatore sconosciuto che non rientra in alcun altro tipo di identificatore.
UnknownIdentifierKind	IdentifierKind per UnknownIdentifier.

Alias tipo

CommunicationIdentifier	Identifica un partecipante alla comunicazione.
CommunicationIdentifierKind	CommunicationIdentifierKind è un'unione discriminata che aggiunge una proprietà kind a un identificatore.

Funzioni

isRestError(unknown)

Typeguard per RestError

Variabili

RestError	Tipo di errore personalizzato per le richieste di pipeline non riuscite.
createIdentifierFromRawId	Crea un elemento CommunicationIdentifierKind da un valore rawId specificato. Quando si archiviano rawIds, usare questa funzione per ripristinare l'identificatore codificato in rawId.
getIdentifierKind	Restituisce CommunicationIdentifierKind per un oggetto CommunicationIdentifier specificato. Restituisce undefined se non è stato possibile dedurre il tipo.
getIdentifierRawId	Restituisce il rawId per un oggetto CommunicationIdentifier specificato. È possibile usare il rawId per codificare l'identificatore e quindi usarlo come chiave in un database.
isCommunicationUserIdentifier	Verifica un identificatore per determinare se implementa CommunicationUserIdentifier.
isKeyCredential	Controlla se un valore è KeyCredential.
isMicrosoftTeamsAppIdentifier	Verifica un identificatore per determinare se implementa MicrosoftTeamsAppIdentifier.
isMicrosoftTeamsUserIdentifier	Verifica un identificatore per determinare se implementa MicrosoftTeamsUserIdentifier.
isPhoneNumberIdentifier	Verifica un identificatore per determinare se implementa PhoneNumberIdentifier.
isTeamsExtensionUserIdentifier	Verifica un identificatore per determinare se implementa TeamsExtensionUserIdentifier.
isUnknownIdentifier	Verifica un identificatore per determinare se implementa UnknownIdentifier.

Dettagli funzione

isRestError(unknown)

Typeguard per RestError

function isRestError(e: unknown): e is RestError

Parametri

e

unknown

Un elemento rilevato da una clausola catch.

Valori restituiti

e is RestError

Dettagli delle variabili

RestError

Tipo di errore personalizzato per le richieste di pipeline non riuscite.

RestError: RestErrorConstructor

Tipo

RestErrorConstructor

createIdentifierFromRawId

Crea un elemento CommunicationIdentifierKind da un valore rawId specificato. Quando si archiviano rawIds, usare questa funzione per ripristinare l'identificatore codificato in rawId.

createIdentifierFromRawId: (rawId: string) => CommunicationIdentifierKind

Tipo

(rawId: string) => CommunicationIdentifierKind

getIdentifierKind

Restituisce CommunicationIdentifierKind per un oggetto CommunicationIdentifier specificato. Restituisce undefined se non è stato possibile dedurre il tipo.

getIdentifierKind: (identifier: CommunicationIdentifier) => CommunicationIdentifierKind

Tipo

(identifier: CommunicationIdentifier) => CommunicationIdentifierKind

getIdentifierRawId

Restituisce il rawId per un oggetto CommunicationIdentifier specificato. È possibile usare il rawId per codificare l'identificatore e quindi usarlo come chiave in un database.

getIdentifierRawId: (identifier: CommunicationIdentifier) => string

Tipo

(identifier: CommunicationIdentifier) => string

isCommunicationUserIdentifier

Verifica un identificatore per determinare se implementa CommunicationUserIdentifier.

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

Tipo

(identifier: CommunicationIdentifier) => identifier is CommunicationUserIdentifier

isKeyCredential

Controlla se un valore è KeyCredential.

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

Tipo

(credential: unknown) => credential is KeyCredential

isMicrosoftTeamsAppIdentifier

Verifica un identificatore per determinare se implementa MicrosoftTeamsAppIdentifier.

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

Tipo

(identifier: CommunicationIdentifier) => identifier is MicrosoftTeamsAppIdentifier

isMicrosoftTeamsUserIdentifier

Verifica un identificatore per determinare se implementa MicrosoftTeamsUserIdentifier.

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

Tipo

(identifier: CommunicationIdentifier) => identifier is MicrosoftTeamsUserIdentifier

isPhoneNumberIdentifier

Verifica un identificatore per determinare se implementa PhoneNumberIdentifier.

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

Tipo

(identifier: CommunicationIdentifier) => identifier is PhoneNumberIdentifier

isTeamsExtensionUserIdentifier

Verifica un identificatore per determinare se implementa TeamsExtensionUserIdentifier.

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

Tipo

(identifier: CommunicationIdentifier) => identifier is TeamsExtensionUserIdentifier

isUnknownIdentifier

Verifica un identificatore per determinare se implementa UnknownIdentifier.

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

Tipo

(identifier: CommunicationIdentifier) => identifier is UnknownIdentifier