@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 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 Telefone do Microsoft Teams 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 |
Funções
| is |
Typeguard para RestError |
Variáveis
| Rest |
Um tipo de erro personalizado para solicitações de pipeline com falha. |
| create |
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. |
| get |
Retorna o CommunicationIdentifierKind para um determinado CommunicationIdentifier. Retorna indefinido se o tipo não puder ser inferido. |
| get |
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. |
| is |
Testa um Identifier para determinar se ele implementa CommunicationUserIdentifier. |
| is |
Verifica se um valor é uma KeyCredential. |
| is |
Testa um Identifier para determinar se ele implementa MicrosoftTeamsAppIdentifier. |
| is |
Testa um Identifier para determinar se ele implementa MicrosoftTeamsUserIdentifier. |
| is |
Testa um Identifier para determinar se ele implementa PhoneNumberIdentifier. |
| is |
Testa um Identifier para determinar se ele implementa TeamsExtensionUserIdentifier. |
| is |
Testa um Identifier para determinar se ele implementa UnknownIdentifier. |
Detalhes de Função
isRestError(unknown)
Typeguard para RestError
function isRestError(e: unknown): e is RestErrorParâmetros
- e
-
unknown
Algo apanhado por uma cláusula de captura.
Devoluções
e is RestError
Detalhes das variáveis
RestError
Um tipo de erro personalizado para solicitações de pipeline com falha.
RestError: RestErrorConstructorTipo
createIdentifierFromRawId
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.
createIdentifierFromRawId: (rawId: string) => CommunicationIdentifierKindTipo
(rawId: string) => CommunicationIdentifierKind
getIdentifierKind
Retorna o CommunicationIdentifierKind para um determinado CommunicationIdentifier. Retorna indefinido se o tipo não puder ser inferido.
getIdentifierKind: (identifier: CommunicationIdentifier) => CommunicationIdentifierKindTipo
(identifier: CommunicationIdentifier) => CommunicationIdentifierKind
getIdentifierRawId
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.
getIdentifierRawId: (identifier: CommunicationIdentifier) => stringTipo
(identifier: CommunicationIdentifier) => string
isCommunicationUserIdentifier
Testa um Identifier para determinar se ele implementa CommunicationUserIdentifier.
isCommunicationUserIdentifier: (identifier: CommunicationIdentifier) => identifier is CommunicationUserIdentifierTipo
(identifier: CommunicationIdentifier) => identifier is CommunicationUserIdentifier
isKeyCredential
Verifica se um valor é uma KeyCredential.
isKeyCredential: (credential: unknown) => credential is KeyCredentialTipo
(credential: unknown) => credential is KeyCredential
isMicrosoftTeamsAppIdentifier
Testa um Identifier para determinar se ele implementa MicrosoftTeamsAppIdentifier.
isMicrosoftTeamsAppIdentifier: (identifier: CommunicationIdentifier) => identifier is MicrosoftTeamsAppIdentifierTipo
(identifier: CommunicationIdentifier) => identifier is MicrosoftTeamsAppIdentifier
isMicrosoftTeamsUserIdentifier
Testa um Identifier para determinar se ele implementa MicrosoftTeamsUserIdentifier.
isMicrosoftTeamsUserIdentifier: (identifier: CommunicationIdentifier) => identifier is MicrosoftTeamsUserIdentifierTipo
(identifier: CommunicationIdentifier) => identifier is MicrosoftTeamsUserIdentifier
isPhoneNumberIdentifier
Testa um Identifier para determinar se ele implementa PhoneNumberIdentifier.
isPhoneNumberIdentifier: (identifier: CommunicationIdentifier) => identifier is PhoneNumberIdentifierTipo
(identifier: CommunicationIdentifier) => identifier is PhoneNumberIdentifier
isTeamsExtensionUserIdentifier
Testa um Identifier para determinar se ele implementa TeamsExtensionUserIdentifier.
isTeamsExtensionUserIdentifier: (identifier: CommunicationIdentifier) => identifier is TeamsExtensionUserIdentifierTipo
(identifier: CommunicationIdentifier) => identifier is TeamsExtensionUserIdentifier
isUnknownIdentifier
Testa um Identifier para determinar se ele implementa UnknownIdentifier.
isUnknownIdentifier: (identifier: CommunicationIdentifier) => identifier is UnknownIdentifierTipo
(identifier: CommunicationIdentifier) => identifier is UnknownIdentifier