@azure/communication-common package

Classes

AzureCommunicationTokenCredential

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

Interfaces

CommunicationGetTokenOptions	Opções para a função CommunicationTokenCredential do 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.
EntraCommunicationTokenCredentialOptions	As opções de token de comunicação do Entra.
MicrosoftTeamsAppIdentifier	Um aplicativo 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.
TeamsExtensionUserIdentifier	Um usuário do Microsoft Teams Phone que está usando o recurso dos Serviços de Comunicação do Azure para estender sua configuração do Teams Phone.
TeamsExtensionUserKind	IdentifierKind para um TeamsExtensionUserIdentifier.
UnknownIdentifier	Um identificador desconhecido que não se encaixa em nenhum dos outros tipos de identificador.
UnknownIdentifierKind	IdentifierKind para UnknownIdentifier.

Aliases de Tipo

CommunicationIdentifier	Identifica um participante da comunicação.
CommunicationIdentifierKind	O CommunicationIdentifierKind é uma união discriminada que adiciona uma propriedade kind a um Identifier.

Funções

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

Detalhes de Função

createIdentifierFromRawId(string)

Cria um CommunicationIdentifierKind a partir 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 identificadora.

Devoluções

CommunicationIdentifierKind

getIdentifierKind(CommunicationIdentifier)

Retorna o CommunicationIdentifierKind para um determinado CommunicationIdentifier. Retorna 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.

Devoluções

CommunicationIdentifierKind

getIdentifierRawId(CommunicationIdentifier)

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

function getIdentifierRawId(identifier: CommunicationIdentifier): string

Parâmetros

identifier

CommunicationIdentifier

O identificador a ser traduzido para seu rawId.

Devoluções

string

isCommunicationUserIdentifier(CommunicationIdentifier)

Testa um Identifier para determinar se ele implementa CommunicationUserIdentifier.

function isCommunicationUserIdentifier(identifier: CommunicationIdentifier): identifier

Parâmetros

identifier

CommunicationIdentifier

O CommunicationUserIdentifier assumido a ser testado.

Devoluções

identifier

isKeyCredential(unknown)

Verifica se um valor é uma KeyCredential.

function isKeyCredential(credential: unknown): credential

Parâmetros

credential

unknown

A credencial que está sendo verificada.

Devoluções

credential

isMicrosoftTeamsAppIdentifier(CommunicationIdentifier)

Testa um Identifier para determinar se ele implementa MicrosoftTeamsAppIdentifier.

function isMicrosoftTeamsAppIdentifier(identifier: CommunicationIdentifier): identifier

Parâmetros

identifier

CommunicationIdentifier

O presumido disponível para ser testado.

Devoluções

identifier

isMicrosoftTeamsUserIdentifier(CommunicationIdentifier)

Testa um Identifier para determinar se ele implementa MicrosoftTeamsUserIdentifier.

function isMicrosoftTeamsUserIdentifier(identifier: CommunicationIdentifier): identifier

Parâmetros

identifier

CommunicationIdentifier

O presumido disponível para ser testado.

Devoluções

identifier

isPhoneNumberIdentifier(CommunicationIdentifier)

Testa um Identifier para determinar se ele implementa PhoneNumberIdentifier.

function isPhoneNumberIdentifier(identifier: CommunicationIdentifier): identifier

Parâmetros

identifier

CommunicationIdentifier

O PhoneNumberIdentifier assumido a ser testado.

Devoluções

identifier

isTeamsExtensionUserIdentifier(CommunicationIdentifier)

Testa um Identifier para determinar se ele implementa TeamsExtensionUserIdentifier.

function isTeamsExtensionUserIdentifier(identifier: CommunicationIdentifier): identifier

Parâmetros

identifier

CommunicationIdentifier

O presumido disponível para ser testado.

Devoluções

identifier

isUnknownIdentifier(CommunicationIdentifier)

Testa um Identifier para determinar se ele implementa UnknownIdentifier.

function isUnknownIdentifier(identifier: CommunicationIdentifier): identifier

Parâmetros

identifier

CommunicationIdentifier

O UnknownIdentifier assumido a ser testado.

Devoluções

identifier