Compartilhar via


Biblioteca de clientes de Passagem de Rede de Comunicação do Azure para JavaScript – versão 1.0.0

A Passagem de Rede de Comunicação do Azure está gerenciando tokens para Serviços de Comunicação do Azure.

Ele fornecerá credenciais TURN a um usuário.

Introdução

Pré-requisitos

Instalando o

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

Suporte ao navegador

Pacote JavaScript

Para usar essa biblioteca de clientes no navegador, primeiro você precisa usar um empacotador. Para obter detalhes sobre como fazer isso, consulte nossa documentação de agrupamento.

Principais conceitos

Exemplos

Autenticação

Você pode obter uma chave e/ou uma cadeia de conexão do recurso dos Serviços de Comunicação no Portal do Azure. Depois de ter uma chave, você pode autenticar o CommunicationRelayClient com qualquer um dos seguintes métodos:

Criar KeyCredential com AzureKeyCredential antes de inicializar o 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);

Usando uma cadeia de conexão

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

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

Usando um TokenCredential

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

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

Se você usar uma chave para inicializar o cliente, também precisará fornecer o ponto de extremidade apropriado. Você pode obter esse ponto de extremidade do recurso dos Serviços de Comunicação no Portal do Azure.

Uso

Criando uma instância de CommunicationRelayClient

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

const client = new CommunicationRelayClient(CONNECTION_STRING);

Criando uma instância de CommunicationIdentityClient para criar um usuário

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

const client = new CommunicationIdentityClient(CONNECTION_STRING);

Use o createUser método para criar um novo usuário.

const user = await client.createUser();

Obtendo a configurationRelay

Usar o getConfigurationRelay método para obter novas credenciais TURN fornecendo um usuário

const config = relayClient.getRelayConfiguration(user);

Além disso, você pode chamar o getConfigurationRelay método sem fornecer um usuário

const config = relayClient.getRelayConfiguration();

Você pode especificar um RouteType ao chamar getConfigurationRelay

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

Solução de problemas

Próximas etapas

Dê uma olhada no diretório de exemplos para obter exemplos detalhados sobre como usar essa biblioteca.

Contribuição

Se você quiser contribuir com essa biblioteca, leia o guia de contribuição para saber como criar e testar o código.

Impressões