@azure/communication-common package

Classes

AzureCommunicationTokenCredential

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

Interfaces

CommunicationGetTokenOptions	Opções para CommunicationTokenCredentiala função 's getToken '.
CommunicationTokenCredential	A credencial do token de Azure Communication Services.
CommunicationTokenRefreshOptions	Opções para atualizar automaticamente uma credencial do Token de Comunicação.
CommunicationUserIdentifier	Um utilizador do Azure Communication.
CommunicationUserKind	IdentifierKind para um CommunicationUserIdentifier.
MicrosoftTeamsAppIdentifier	Uma aplicação do Microsoft Teams.
MicrosoftTeamsAppKind	IdentifierKind para um MicrosoftTeamsAppIdentifier.
MicrosoftTeamsUserIdentifier	Um utilizador 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 adequa a nenhum dos outros tipos de identificador.
UnknownIdentifierKind	IdentifierKind para UnknownIdentifier.

Aliases de Tipo

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

Funções

createIdentifierFromRawId(string)	Cria um CommunicationIdentifierKind a partir de um determinado rawId. Ao armazenar rawIds, utilize esta função para restaurar o identificador que foi codificado no rawId.
getIdentifierKind(CommunicationIdentifier)	Devolve CommunicationIdentifierKind para um determinado CommunicationIdentifier. Devolve indefinido se não for possível inferir o tipo.
getIdentifierRawId(CommunicationIdentifier)	Devolve o rawId de um determinado CommunicationIdentifier. Pode utilizar o rawId para codificar o identificador e, em seguida, utilizá-lo como uma chave numa base de dados.
isCommunicationUserIdentifier(CommunicationIdentifier)	Testa um Identificador para determinar se implementa CommunicationUserIdentifier.
isKeyCredential(unknown)	Verifica se um valor é um KeyCredential.
isMicrosoftTeamsAppIdentifier(CommunicationIdentifier)	Testa um Identificador para determinar se implementa o MicrosoftTeamsAppIdentifier.
isMicrosoftTeamsUserIdentifier(CommunicationIdentifier)	Testa um Identificador para determinar se implementa o MicrosoftTeamsUserIdentifier.
isPhoneNumberIdentifier(CommunicationIdentifier)	Testa um Identificador para determinar se implementa PhoneNumberIdentifier.
isUnknownIdentifier(CommunicationIdentifier)	Testa um Identificador para determinar se implementa UnknownIdentifier.

Detalhes de Função

createIdentifierFromRawId(string)

Cria um CommunicationIdentifierKind a partir de um determinado rawId. Ao armazenar rawIds, utilize esta 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 a representação do identificador.

Devoluções

CommunicationIdentifierKind

getIdentifierKind(CommunicationIdentifier)

Devolve CommunicationIdentifierKind para um determinado CommunicationIdentifier. Devolve indefinido se não for possível inferir o tipo.

function getIdentifierKind(identifier: CommunicationIdentifier): CommunicationIdentifierKind

Parâmetros

identifier

CommunicationIdentifier

O identificador cujo tipo deve ser inferido.

Devoluções

CommunicationIdentifierKind

getIdentifierRawId(CommunicationIdentifier)

Devolve o rawId de um determinado CommunicationIdentifier. Pode utilizar o rawId para codificar o identificador e, em seguida, utilizá-lo como uma chave numa base de dados.

function getIdentifierRawId(identifier: CommunicationIdentifier): string

Parâmetros

identifier

CommunicationIdentifier

O identificador a traduzir para o respetivo rawId.

Devoluções

string

isCommunicationUserIdentifier(CommunicationIdentifier)

Testa um Identificador para determinar se 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 é um KeyCredential.

function isKeyCredential(credential: unknown): credential

Parâmetros

credential

unknown

A credencial a ser verificada.

Devoluções

credential

isMicrosoftTeamsAppIdentifier(CommunicationIdentifier)

Testa um Identificador para determinar se implementa o MicrosoftTeamsAppIdentifier.

function isMicrosoftTeamsAppIdentifier(identifier: CommunicationIdentifier): identifier

Parâmetros

identifier

CommunicationIdentifier

O assumido disponível para ser testado.

Devoluções

identifier

isMicrosoftTeamsUserIdentifier(CommunicationIdentifier)

Testa um Identificador para determinar se implementa o MicrosoftTeamsUserIdentifier.

function isMicrosoftTeamsUserIdentifier(identifier: CommunicationIdentifier): identifier

Parâmetros

identifier

CommunicationIdentifier

O assumido disponível para ser testado.

Devoluções

identifier

isPhoneNumberIdentifier(CommunicationIdentifier)

Testa um Identificador para determinar se implementa PhoneNumberIdentifier.

function isPhoneNumberIdentifier(identifier: CommunicationIdentifier): identifier

Parâmetros

identifier

CommunicationIdentifier

O PhoneNumberIdentifier assumido a ser testado.

Devoluções

identifier

isUnknownIdentifier(CommunicationIdentifier)

Testa um Identificador para determinar se implementa UnknownIdentifier.

function isUnknownIdentifier(identifier: CommunicationIdentifier): identifier

Parâmetros

identifier

CommunicationIdentifier

O desconhecidoidentificador assumido a ser testado.

Devoluções

identifier