Share via

Biblioteca cliente de Azure Communication Network Traversal para JavaScript: versión 1.0.0

  • Artículo

Azure Communication Network Traversal administra tokens para Azure Communication Services.

Proporcionará credenciales TURN a un usuario.

Introducción

Requisitos previos

Instalación de

npm install @azure/communication-network-traversal
npm install @azure/communication-identity

Compatibilidad con exploradores

Paquete de JavaScript

Para usar esta biblioteca cliente en el explorador, primero debe usar un empaquetador. Para más información sobre cómo hacerlo, consulte nuestra documentación de agrupación.

Conceptos clave

Ejemplos

Authentication

Puede obtener una clave o una cadena de conexión del recurso de Communication Services en Azure Portal. Una vez que tenga una clave, puede autenticarse CommunicationRelayClient con cualquiera de los métodos siguientes:

Crear KeyCredential con AzureKeyCredential antes de inicializar el cliente

import { AzureKeyCredential } from "@azure/core-auth";
import { CommunicationRelayClient } from "@azure/communication-network-traversal";

const credential = new AzureKeyCredential(KEY);
const client = new CommunicationRelayClient(ENDPOINT, credential);

Uso de una cadena de conexión

import { CommunicationRelayClient } from "@azure/communication-network-traversal";

const connectionString = `endpoint=ENDPOINT;accessKey=KEY`;
const client = new CommunicationRelayClient(connectionString);

Uso de TokenCredential

import { DefaultAzureCredential } from "@azure/identity";
import { CommunicationRelayClient } from "@azure/communication-network-traversal";

const credential = new DefaultAzureCredential();
const client = new CommunicationRelayClient(ENDPOINT, credential);

Si usa una clave para inicializar el cliente, también deberá proporcionar el punto de conexión adecuado. Puede obtener este punto de conexión del recurso de Communication Services en Azure Portal.

Uso

Creación de una instancia de CommunicationRelayClient

import { CommunicationRelayClient } from "@azure/communication-network-traversal";

const client = new CommunicationRelayClient(CONNECTION_STRING);

Creación de una instancia de CommunicationIdentityClient para crear un usuario

import { CommunicationIdentityClient } from "@azure/communication-identity";

const client = new CommunicationIdentityClient(CONNECTION_STRING);

Use el createUser método para crear un nuevo usuario.

const user = await client.createUser();

Obtención de configurationRelay

Use el getConfigurationRelay método para obtener las nuevas credenciales TURN que proporcionan un usuario.

const config = relayClient.getRelayConfiguration(user);

También puede llamar al getConfigurationRelay método sin proporcionar un usuario.

const config = relayClient.getRelayConfiguration();

Puede especificar un RouteType al llamar a . getConfigurationRelay

const config = relayClient.getRelayConfiguration(user, "nearest");

Solución de problemas

Pasos siguientes

Eche un vistazo al directorio de ejemplos para obtener ejemplos detallados sobre cómo usar esta biblioteca.

Contribuciones

Si desea contribuir a esta biblioteca, lea la guía de contribución para obtener más información sobre cómo compilar y probar el código.

Impresiones