@azure/communication-common package

Clases

AzureCommunicationTokenCredential

La implementación communicationTokenCredential con compatibilidad con la actualización proactiva de tokens.

Interfaces

CommunicationGetTokenOptions	Opciones de CommunicationTokenCredentialla función de getToken .
CommunicationTokenCredential	Credencial de token de Azure Communication Services.
CommunicationTokenRefreshOptions	Opciones para actualizar automáticamente una credencial de token de comunicación.
CommunicationUserIdentifier	Un usuario de Comunicación de Azure.
CommunicationUserKind	IdentifierKind para communicationUserIdentifier.
MicrosoftTeamsAppIdentifier	Una aplicación de Microsoft Teams.
MicrosoftTeamsAppKind	IdentifierKind para un MicrosoftTeamsAppIdentifier.
MicrosoftTeamsUserIdentifier	Un usuario de Microsoft Teams.
MicrosoftTeamsUserKind	IdentifierKind para microsoftTeamsUserIdentifier.
PhoneNumberIdentifier	Un número de teléfono.
PhoneNumberKind	IdentifierKind para phoneNumberIdentifier.
UnknownIdentifier	Identificador desconocido que no se ajusta a ninguno de los otros tipos de identificador.
UnknownIdentifierKind	IdentifierKind para UnknownIdentifier.

Alias de tipos

CommunicationIdentifier	Identifica un participante de comunicación.
CommunicationIdentifierKind	CommunicationIdentifierKind es una unión discriminada que agrega una propiedad kind a un identificador.

Funciones

createIdentifierFromRawId(string)	Crea un elemento CommunicationIdentifierKind a partir de un rawId determinado. Al almacenar rawIds, use esta función para restaurar el identificador codificado en rawId.
getIdentifierKind(CommunicationIdentifier)	Devuelve CommunicationIdentifierKind para un communicationIdentifier determinado. Devuelve undefined si el tipo no se pudo deducir.
getIdentifierRawId(CommunicationIdentifier)	Devuelve el valor rawId de un communicationIdentifier determinado. Puede usar rawId para codificar el identificador y, a continuación, usarlo como clave en una base de datos.
isCommunicationUserIdentifier(CommunicationIdentifier)	Prueba un identificador para determinar si implementa CommunicationUserIdentifier.
isKeyCredential(unknown)	Comprueba si un valor es keyCredential.
isMicrosoftTeamsAppIdentifier(CommunicationIdentifier)	Prueba un identificador para determinar si implementa MicrosoftTeamsAppIdentifier.
isMicrosoftTeamsUserIdentifier(CommunicationIdentifier)	Prueba un identificador para determinar si implementa MicrosoftTeamsUserIdentifier.
isPhoneNumberIdentifier(CommunicationIdentifier)	Prueba un identificador para determinar si implementa PhoneNumberIdentifier.
isUnknownIdentifier(CommunicationIdentifier)	Prueba un identificador para determinar si implementa UnknownIdentifier.

Detalles de la función

createIdentifierFromRawId(string)

Crea un elemento CommunicationIdentifierKind a partir de un rawId determinado. Al almacenar rawIds, use esta función para restaurar el identificador codificado en rawId.

function createIdentifierFromRawId(rawId: string): CommunicationIdentifierKind

Parámetros

rawId

string

RawId que se va a traducir a su representación de identificador.

Devoluciones

CommunicationIdentifierKind

getIdentifierKind(CommunicationIdentifier)

Devuelve CommunicationIdentifierKind para un communicationIdentifier determinado. Devuelve undefined si el tipo no se pudo deducir.

function getIdentifierKind(identifier: CommunicationIdentifier): CommunicationIdentifierKind

Parámetros

identifier

CommunicationIdentifier

Identificador cuyo tipo se va a deducir.

Devoluciones

CommunicationIdentifierKind

getIdentifierRawId(CommunicationIdentifier)

Devuelve el valor rawId de un communicationIdentifier determinado. Puede usar rawId para codificar el identificador y, a continuación, usarlo como clave en una base de datos.

function getIdentifierRawId(identifier: CommunicationIdentifier): string

Parámetros

identifier

CommunicationIdentifier

Identificador que se va a traducir a su rawId.

Devoluciones

string

isCommunicationUserIdentifier(CommunicationIdentifier)

Prueba un identificador para determinar si implementa CommunicationUserIdentifier.

function isCommunicationUserIdentifier(identifier: CommunicationIdentifier): identifier

Parámetros

identifier

CommunicationIdentifier

Se supone que communicationUserIdentifier se va a probar.

Devoluciones

identifier

isKeyCredential(unknown)

Comprueba si un valor es keyCredential.

function isKeyCredential(credential: unknown): credential

Parámetros

credential

unknown

Credencial que se está comprobando.

Devoluciones

credential

isMicrosoftTeamsAppIdentifier(CommunicationIdentifier)

Prueba un identificador para determinar si implementa MicrosoftTeamsAppIdentifier.

function isMicrosoftTeamsAppIdentifier(identifier: CommunicationIdentifier): identifier

Parámetros

identifier

CommunicationIdentifier

Se supone que está disponible para probarse.

Devoluciones

identifier

isMicrosoftTeamsUserIdentifier(CommunicationIdentifier)

Prueba un identificador para determinar si implementa MicrosoftTeamsUserIdentifier.

function isMicrosoftTeamsUserIdentifier(identifier: CommunicationIdentifier): identifier

Parámetros

identifier

CommunicationIdentifier

Se supone que está disponible para probarse.

Devoluciones

identifier

isPhoneNumberIdentifier(CommunicationIdentifier)

Prueba un identificador para determinar si implementa PhoneNumberIdentifier.

function isPhoneNumberIdentifier(identifier: CommunicationIdentifier): identifier

Parámetros

identifier

CommunicationIdentifier

Se supone que se va a probar PhoneNumberIdentifier.

Devoluciones

identifier

isUnknownIdentifier(CommunicationIdentifier)

Prueba un identificador para determinar si implementa UnknownIdentifier.

function isUnknownIdentifier(identifier: CommunicationIdentifier): identifier

Parámetros

identifier

CommunicationIdentifier

Se supone que UnknownIdentifier se va a probar.

Devoluciones

identifier