Partilhar via

Biblioteca de cliente do Azure Communication Network Traversal para JavaScript – versão 1.0.0

  • Artigo

O Azure Communication Network Traversal está a gerir tokens para Azure Communication Services.

Fornecerá credenciais TURN a um utilizador.

Introdução

Pré-requisitos

Instalação

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

Browser support (Suporte do browser)

Pacote JavaScript

Para utilizar esta biblioteca de cliente no browser, primeiro tem de utilizar um bundler. Para obter detalhes sobre como fazê-lo, consulte a nossa documentação de agrupamento.

Conceitos-chave

Exemplos

Autenticação

Pode obter uma chave e/ou cadeia de ligação a partir do recurso dos Serviços de Comunicação no Portal do Azure. Assim que tiver uma chave, pode autenticar com CommunicationRelayClient 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);

Utilizar uma cadeia de ligação

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

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

Utilizar 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 utilizar uma chave para inicializar o cliente, também terá de fornecer o ponto final adequado. Pode obter este ponto final a partir do recurso dos Serviços de Comunicação no Portal do Azure.

Utilização

Criar uma instância de CommunicationRelayClient

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

const client = new CommunicationRelayClient(CONNECTION_STRING);

Criar uma instância de CommunicationIdentityClient para criar um utilizador

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

const client = new CommunicationIdentityClient(CONNECTION_STRING);

Utilize o createUser método para criar um novo utilizador.

const user = await client.createUser();

Obter a configuraçãoRelay

Utilizar o getConfigurationRelay método para obter novas credenciais TURN que fornecem um utilizador

const config = relayClient.getRelayConfiguration(user);

Também pode chamar o getConfigurationRelay método sem fornecer um utilizador

const config = relayClient.getRelayConfiguration();

Pode especificar um RouteType ao chamar getConfigurationRelay

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

Resolução de problemas

Passos seguintes

Veja o diretório de exemplos para obter exemplos detalhados sobre como utilizar esta biblioteca.

Contribuir

Se quiser contribuir para esta biblioteca, leia o guia de contribuição para saber mais sobre como criar e testar o código.

Impressões