@azure/communication-common package
Clases
| AzureCommunicationTokenCredential |
La implementación communicationTokenCredential con compatibilidad con la actualización proactiva de tokens. |
Interfaces
| CommunicationGetTokenOptions |
Opciones de |
| CommunicationTokenCredential |
Credencial del token de Azure Communication Services. |
| CommunicationTokenRefreshOptions |
Opciones para actualizar automáticamente una credencial de token de comunicación. |
| CommunicationUserIdentifier |
Un usuario de Azure Communication. |
| CommunicationUserKind |
IdentifierKind para communicationUserIdentifier. |
| EntraCommunicationTokenCredentialOptions |
Las opciones del token de comunicación Entra. |
| MicrosoftTeamsAppIdentifier |
Una aplicación de Microsoft Teams. |
| MicrosoftTeamsAppKind |
IdentifierKind para microsoftTeamsAppIdentifier. |
| MicrosoftTeamsUserIdentifier |
Un usuario de Microsoft Teams. |
| MicrosoftTeamsUserKind |
IdentifierKind para microsoftTeamsUserIdentifier. |
| PhoneNumberIdentifier |
Número de teléfono. |
| PhoneNumberKind |
IdentifierKind para phoneNumberIdentifier. |
| TeamsExtensionUserIdentifier |
Un usuario de teléfono de Microsoft Teams que usa el recurso de Azure Communication Services para ampliar la configuración de su teléfono de Teams. |
| TeamsExtensionUserKind |
IdentifierKind para TeamsExtensionUserIdentifier. |
| UnknownIdentifier |
Identificador desconocido que no se ajusta a ninguno de los otros tipos de identificador. |
| UnknownIdentifierKind |
IdentifierKind para UnknownIdentifier. |
Alias de tipos
| CommunicationIdentifier |
Identifica un participante de comunicación. |
| CommunicationIdentifierKind |
CommunicationIdentifierKind es una unión discriminada que agrega una propiedad |
Funciones
| is |
Typeguard para RestError |
Variables
| Rest |
Tipo de error personalizado para solicitudes de canalización con error. |
| create |
Crea un objeto CommunicationIdentifierKind a partir de un rawId determinado. Al almacenar rawIds, use esta función para restaurar el identificador codificado en rawId. |
| get |
Devuelve CommunicationIdentifierKind para un communicationIdentifier determinado. Devuelve undefined si no se pudo deducir el tipo. |
| get |
Devuelve el valor rawId de un objeto CommunicationIdentifier determinado. Puede usar rawId para codificar el identificador y, a continuación, usarlo como clave en una base de datos. |
| is |
Prueba un identificador para determinar si implementa CommunicationUserIdentifier. |
| is |
Comprueba si un valor es KeyCredential. |
| is |
Prueba un identificador para determinar si implementa MicrosoftTeamsAppIdentifier. |
| is |
Comprueba un identificador para determinar si implementa MicrosoftTeamsUserIdentifier. |
| is |
Prueba un identificador para determinar si implementa PhoneNumberIdentifier. |
| is |
Prueba un identificador para determinar si implementa TeamsExtensionUserIdentifier. |
| is |
Prueba un identificador para determinar si implementa UnknownIdentifier. |
Detalles de la función
isRestError(unknown)
Typeguard para RestError
function isRestError(e: unknown): e is RestErrorParámetros
- e
-
unknown
Algo capturado por una cláusula catch.
Devoluciones
e is RestError
Detalles de variables
RestError
Tipo de error personalizado para solicitudes de canalización con error.
RestError: RestErrorConstructorTipo
createIdentifierFromRawId
Crea un objeto CommunicationIdentifierKind a partir de un rawId determinado. Al almacenar rawIds, use esta función para restaurar el identificador codificado en rawId.
createIdentifierFromRawId: (rawId: string) => CommunicationIdentifierKindTipo
(rawId: string) => CommunicationIdentifierKind
getIdentifierKind
Devuelve CommunicationIdentifierKind para un communicationIdentifier determinado. Devuelve undefined si no se pudo deducir el tipo.
getIdentifierKind: (identifier: CommunicationIdentifier) => CommunicationIdentifierKindTipo
(identifier: CommunicationIdentifier) => CommunicationIdentifierKind
getIdentifierRawId
Devuelve el valor rawId de un objeto CommunicationIdentifier determinado. Puede usar rawId para codificar el identificador y, a continuación, usarlo como clave en una base de datos.
getIdentifierRawId: (identifier: CommunicationIdentifier) => stringTipo
(identifier: CommunicationIdentifier) => string
isCommunicationUserIdentifier
Prueba un identificador para determinar si implementa CommunicationUserIdentifier.
isCommunicationUserIdentifier: (identifier: CommunicationIdentifier) => identifier is CommunicationUserIdentifierTipo
(identifier: CommunicationIdentifier) => identifier is CommunicationUserIdentifier
isKeyCredential
Comprueba si un valor es KeyCredential.
isKeyCredential: (credential: unknown) => credential is KeyCredentialTipo
(credential: unknown) => credential is KeyCredential
isMicrosoftTeamsAppIdentifier
Prueba un identificador para determinar si implementa MicrosoftTeamsAppIdentifier.
isMicrosoftTeamsAppIdentifier: (identifier: CommunicationIdentifier) => identifier is MicrosoftTeamsAppIdentifierTipo
(identifier: CommunicationIdentifier) => identifier is MicrosoftTeamsAppIdentifier
isMicrosoftTeamsUserIdentifier
Comprueba un identificador para determinar si implementa MicrosoftTeamsUserIdentifier.
isMicrosoftTeamsUserIdentifier: (identifier: CommunicationIdentifier) => identifier is MicrosoftTeamsUserIdentifierTipo
(identifier: CommunicationIdentifier) => identifier is MicrosoftTeamsUserIdentifier
isPhoneNumberIdentifier
Prueba un identificador para determinar si implementa PhoneNumberIdentifier.
isPhoneNumberIdentifier: (identifier: CommunicationIdentifier) => identifier is PhoneNumberIdentifierTipo
(identifier: CommunicationIdentifier) => identifier is PhoneNumberIdentifier
isTeamsExtensionUserIdentifier
Prueba un identificador para determinar si implementa TeamsExtensionUserIdentifier.
isTeamsExtensionUserIdentifier: (identifier: CommunicationIdentifier) => identifier is TeamsExtensionUserIdentifierTipo
(identifier: CommunicationIdentifier) => identifier is TeamsExtensionUserIdentifier
isUnknownIdentifier
Prueba un identificador para determinar si implementa UnknownIdentifier.
isUnknownIdentifier: (identifier: CommunicationIdentifier) => identifier is UnknownIdentifierTipo
(identifier: CommunicationIdentifier) => identifier is UnknownIdentifier