@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 |
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 da Comunicação do Azure. |
| CommunicationUserKind |
IdentifierKind para um CommunicationUserIdentifier. |
| EntraCommunicationTokenCredentialOptions |
As opções de token de comunicação do Entra. |
| 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. |
| TeamsExtensionUserIdentifier |
Um usuário do Telefone do Microsoft Teams que está usando o recurso dos Serviços de Comunicação do Azure para estender a configuração do Telefone do Teams. |
| 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 de comunicação. |
| CommunicationIdentifierKind |
O CommunicationIdentifierKind é uma união discriminada que adiciona uma propriedade |
Funções
| create |
Cria um CommunicationIdentifierKind de uma determinada rawId. Ao armazenar rawIds, use essa função para restaurar o identificador que foi codificado na rawId. |
| get |
Retorna o CommunicationIdentifierKind para um determinado CommunicationIdentifier. Retornará indefinido se o tipo não puder ser inferido. |
| get |
Retorna a rawId para um determinado CommunicationIdentifier. Você pode usar a rawId para codificar o identificador e usá-lo como uma chave em um banco de dados. |
| is |
Testa um identificador para determinar se ele implementa CommunicationUserIdentifier. |
| is |
Verifica se um valor é um KeyCredential. |
| is |
Testa um identificador para determinar se ele implementa o MicrosoftTeamsAppIdentifier. |
| is |
Testa um identificador para determinar se ele implementa o MicrosoftTeamsUserIdentifier. |
| is |
Testa um identificador para determinar se ele implementa PhoneNumberIdentifier. |
| is |
Testa um Identificador para determinar se ele implementa TeamsExtensionUserIdentifier. |
| is |
Testa um identificador para determinar se ele implementa UnknownIdentifier. |
Detalhes da função
createIdentifierFromRawId(string)
Cria um CommunicationIdentifierKind de uma determinada rawId. Ao armazenar rawIds, use essa função para restaurar o identificador que foi codificado na rawId.
function createIdentifierFromRawId(rawId: string): CommunicationIdentifierKindParâmetros
- rawId
-
string
A rawId a ser traduzida para sua representação de identificador.
Retornos
getIdentifierKind(CommunicationIdentifier)
Retorna o CommunicationIdentifierKind para um determinado CommunicationIdentifier. Retornará indefinido se o tipo não puder ser inferido.
function getIdentifierKind(identifier: CommunicationIdentifier): CommunicationIdentifierKindParâmetros
- identifier
- CommunicationIdentifier
O identificador cujo tipo deve ser inferido.
Retornos
getIdentifierRawId(CommunicationIdentifier)
Retorna a rawId para um determinado CommunicationIdentifier. Você pode usar a rawId para codificar o identificador e usá-lo como uma chave em um banco de dados.
function getIdentifierRawId(identifier: CommunicationIdentifier): stringParâmetros
- identifier
- CommunicationIdentifier
O identificador a ser traduzido para sua rawId.
Retornos
string
isCommunicationUserIdentifier(CommunicationIdentifier)
Testa um identificador para determinar se ele implementa CommunicationUserIdentifier.
function isCommunicationUserIdentifier(identifier: CommunicationIdentifier): identifierParâmetros
- identifier
- CommunicationIdentifier
O CommunicationUserIdentifier assumido a ser testado.
Retornos
identifier
isKeyCredential(unknown)
Verifica se um valor é um KeyCredential.
function isKeyCredential(credential: unknown): credentialParâmetros
- credential
-
unknown
A credencial que está sendo verificada.
Retornos
credential
isMicrosoftTeamsAppIdentifier(CommunicationIdentifier)
Testa um identificador para determinar se ele implementa o MicrosoftTeamsAppIdentifier.
function isMicrosoftTeamsAppIdentifier(identifier: CommunicationIdentifier): identifierParâmetros
- identifier
- CommunicationIdentifier
O presumido disponível para ser testado.
Retornos
identifier
isMicrosoftTeamsUserIdentifier(CommunicationIdentifier)
Testa um identificador para determinar se ele implementa o MicrosoftTeamsUserIdentifier.
function isMicrosoftTeamsUserIdentifier(identifier: CommunicationIdentifier): identifierParâ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): identifierParâmetros
- identifier
- CommunicationIdentifier
O PhoneNumberIdentifier assumido a ser testado.
Retornos
identifier
isTeamsExtensionUserIdentifier(CommunicationIdentifier)
Testa um Identificador para determinar se ele implementa TeamsExtensionUserIdentifier.
function isTeamsExtensionUserIdentifier(identifier: CommunicationIdentifier): identifierParâmetros
- identifier
- CommunicationIdentifier
O presumido disponível para ser testado.
Retornos
identifier
isUnknownIdentifier(CommunicationIdentifier)
Testa um identificador para determinar se ele implementa UnknownIdentifier.
function isUnknownIdentifier(identifier: CommunicationIdentifier): identifierParâmetros
- identifier
- CommunicationIdentifier
O UnknownIdentifier assumido a ser testado.
Retornos
identifier