@azure/communication-common package

Classi

AzureCommunicationTokenCredential

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

Interfacce

CommunicationGetTokenOptions	Opzioni per CommunicationTokenCredentialla funzione di getToken .
CommunicationTokenCredential	Credenziali del token Servizi di comunicazione di Azure.
CommunicationTokenRefreshOptions	Opzioni per l'aggiornamento automatico di una credenziale del token di comunicazione.
CommunicationUserIdentifier	Un utente di Comunicazione di Azure.
CommunicationUserKind	IdentifierKind per communicationUserIdentifier.
MicrosoftTeamsAppIdentifier	Un'app di Microsoft Teams.
MicrosoftTeamsAppKind	IdentifierKind per MicrosoftTeamsAppIdentifier.
MicrosoftTeamsUserIdentifier	Utente di Microsoft Teams.
MicrosoftTeamsUserKind	IdentifierKind per MicrosoftTeamsUserIdentifier.
PhoneNumberIdentifier	Numero di telefono.
PhoneNumberKind	IdentifierKind per phoneNumberIdentifier.
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

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

Dettagli funzione

createIdentifierFromRawId(string)

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

function createIdentifierFromRawId(rawId: string): CommunicationIdentifierKind

Parametri

rawId

string

RawId da convertire nella relativa rappresentazione dell'identificatore.

Restituisce

CommunicationIdentifierKind

getIdentifierKind(CommunicationIdentifier)

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

function getIdentifierKind(identifier: CommunicationIdentifier): CommunicationIdentifierKind

Parametri

identifier

CommunicationIdentifier

Identificatore il cui tipo deve essere dedotto.

Restituisce

CommunicationIdentifierKind

getIdentifierRawId(CommunicationIdentifier)

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

function getIdentifierRawId(identifier: CommunicationIdentifier): string

Parametri

identifier

CommunicationIdentifier

Identificatore da convertire nel relativo rawId.

Restituisce

string

isCommunicationUserIdentifier(CommunicationIdentifier)

Verifica un identificatore per determinare se implementa CommunicationUserIdentifier.

function isCommunicationUserIdentifier(identifier: CommunicationIdentifier): identifier

Parametri

identifier

CommunicationIdentifier

Si presuppone che CommunicationUserIdentifier venga testato.

Restituisce

identifier

isKeyCredential(unknown)

Controlla se un valore è KeyCredential.

function isKeyCredential(credential: unknown): credential

Parametri

credential

unknown

Credenziali controllate.

Restituisce

credential

isMicrosoftTeamsAppIdentifier(CommunicationIdentifier)

Verifica un identificatore per determinare se implementa MicrosoftTeamsAppIdentifier.

function isMicrosoftTeamsAppIdentifier(identifier: CommunicationIdentifier): identifier

Parametri

identifier

CommunicationIdentifier

Oggetto che si presuppone che sia disponibile per il test.

Restituisce

identifier

isMicrosoftTeamsUserIdentifier(CommunicationIdentifier)

Verifica un identificatore per determinare se implementa MicrosoftTeamsUserIdentifier.

function isMicrosoftTeamsUserIdentifier(identifier: CommunicationIdentifier): identifier

Parametri

identifier

CommunicationIdentifier

Oggetto che si presuppone che sia disponibile per il test.

Restituisce

identifier

isPhoneNumberIdentifier(CommunicationIdentifier)

Verifica un identificatore per determinare se implementa PhoneNumberIdentifier.

function isPhoneNumberIdentifier(identifier: CommunicationIdentifier): identifier

Parametri

identifier

CommunicationIdentifier

Oggetto PhoneNumberIdentifier da testare.

Restituisce

identifier

isUnknownIdentifier(CommunicationIdentifier)

Verifica un identificatore per determinare se implementa UnknownIdentifier.

function isUnknownIdentifier(identifier: CommunicationIdentifier): identifier

Parametri

identifier

CommunicationIdentifier

Si presuppone che UnknownIdentifier venga testato.

Restituisce

identifier