@azure/communication-common package

Classes

AzureCommunicationTokenCredential

A implementação communicationTokenCredential com suporte para atualização proativa de token.

Interfaces

CommunicationGetTokenOptions	Opções para CommunicationTokenCredentiala função de .getToken
CommunicationTokenCredential	A credencial de token dos Serviços de Comunicação do Azure.
CommunicationTokenRefreshOptions	Opções para atualizar automaticamente uma credencial de Token de Comunicação.
CommunicationUserIdentifier	Um usuário de Comunicação do Azure.
CommunicationUserKind	IdentifierKind para um CommunicationUserIdentifier.
MicrosoftTeamsAppIdentifier	Um aplicativo do Microsoft Teams.
MicrosoftTeamsAppKind	IdentifierKind para um MicrosoftTeamsAppIdentifier.
MicrosoftTeamsUserIdentifier	Um usuário do Microsoft Teams.
MicrosoftTeamsUserKind	IdentifierKind para um MicrosoftTeamsUserIdentifier.
PhoneNumberIdentifier	Um número de telefone.
PhoneNumberKind	IdentifierKind para um PhoneNumberIdentifier.
UnknownIdentifier	Um identificador desconhecido que não se ajusta a nenhum dos outros tipos de identificador.
UnknownIdentifierKind	IdentifierKind para UnknownIdentifier.

Aliases de tipo

CommunicationIdentifier	Identifica um participante de comunicação.
CommunicationIdentifierKind	CommunicationIdentifierKind é uma união discriminada que adiciona uma propriedade kind a um Identificador.

Funções

createIdentifierFromRawId(string)	Cria um CommunicationIdentifierKind de um determinado rawId. Ao armazenar rawIds, use essa função para restaurar o identificador que foi codificado no rawId.
getIdentifierKind(CommunicationIdentifier)	Retorna CommunicationIdentifierKind para um determinado CommunicationIdentifier. Retornará indefinido se o tipo não puder ser inferido.
getIdentifierRawId(CommunicationIdentifier)	Retorna o rawId de um determinado CommunicationIdentifier. Você pode usar rawId para codificar o identificador e usá-lo como uma chave em um banco de dados.
isCommunicationUserIdentifier(CommunicationIdentifier)	Testa um identificador para determinar se ele implementa CommunicationUserIdentifier.
isKeyCredential(unknown)	Verifica se um valor é um KeyCredential.
isMicrosoftTeamsAppIdentifier(CommunicationIdentifier)	Testa um Identificador para determinar se ele implementa MicrosoftTeamsAppIdentifier.
isMicrosoftTeamsUserIdentifier(CommunicationIdentifier)	Testa um Identificador para determinar se ele implementa MicrosoftTeamsUserIdentifier.
isPhoneNumberIdentifier(CommunicationIdentifier)	Testa um Identificador para determinar se ele implementa PhoneNumberIdentifier.
isUnknownIdentifier(CommunicationIdentifier)	Testa um Identificador para determinar se ele implementa UnknownIdentifier.

Detalhes da função

createIdentifierFromRawId(string)

Cria um CommunicationIdentifierKind de um determinado rawId. Ao armazenar rawIds, use essa função para restaurar o identificador que foi codificado no rawId.

function createIdentifierFromRawId(rawId: string): CommunicationIdentifierKind

Parâmetros

rawId

string

O rawId a ser traduzido para sua representação de identificador.

Retornos

CommunicationIdentifierKind

getIdentifierKind(CommunicationIdentifier)

Retorna CommunicationIdentifierKind para um determinado CommunicationIdentifier. Retornará indefinido se o tipo não puder ser inferido.

function getIdentifierKind(identifier: CommunicationIdentifier): CommunicationIdentifierKind

Parâmetros

identifier

CommunicationIdentifier

O identificador cujo tipo deve ser inferido.

Retornos

CommunicationIdentifierKind

getIdentifierRawId(CommunicationIdentifier)

Retorna o rawId de um determinado CommunicationIdentifier. Você pode usar rawId para codificar o identificador e usá-lo como uma chave em um banco de dados.

function getIdentifierRawId(identifier: CommunicationIdentifier): string

Parâmetros

identifier

CommunicationIdentifier

O identificador a ser convertido em sua rawId.

Retornos

string

isCommunicationUserIdentifier(CommunicationIdentifier)

Testa um identificador para determinar se ele implementa CommunicationUserIdentifier.

function isCommunicationUserIdentifier(identifier: CommunicationIdentifier): identifier

Parâmetros

identifier

CommunicationIdentifier

O CommunicationUserIdentifier assumido a ser testado.

Retornos

identifier

isKeyCredential(unknown)

Verifica se um valor é um KeyCredential.

function isKeyCredential(credential: unknown): credential

Parâmetros

credential

unknown

A credencial que está sendo verificada.

Retornos

credential

isMicrosoftTeamsAppIdentifier(CommunicationIdentifier)

Testa um Identificador para determinar se ele implementa MicrosoftTeamsAppIdentifier.

function isMicrosoftTeamsAppIdentifier(identifier: CommunicationIdentifier): identifier

Parâmetros

identifier

CommunicationIdentifier

O presumido disponível para ser testado.

Retornos

identifier

isMicrosoftTeamsUserIdentifier(CommunicationIdentifier)

Testa um Identificador para determinar se ele implementa MicrosoftTeamsUserIdentifier.

function isMicrosoftTeamsUserIdentifier(identifier: CommunicationIdentifier): identifier

Parâmetros

identifier

CommunicationIdentifier

O presumido disponível para ser testado.

Retornos

identifier

isPhoneNumberIdentifier(CommunicationIdentifier)

Testa um Identificador para determinar se ele implementa PhoneNumberIdentifier.

function isPhoneNumberIdentifier(identifier: CommunicationIdentifier): identifier

Parâmetros

identifier

CommunicationIdentifier

O PhoneNumberIdentifier assumido a ser testado.

Retornos

identifier

isUnknownIdentifier(CommunicationIdentifier)

Testa um Identificador para determinar se ele implementa UnknownIdentifier.

function isUnknownIdentifier(identifier: CommunicationIdentifier): identifier

Parâmetros

identifier

CommunicationIdentifier

O UnknownIdentifier assumido a ser testado.

Retornos

identifier