Bibliothèque de client Azure Communication Network Traversal pour JavaScript - version 1.0.0
Azure Communication Network Traversal gère les jetons pour Azure Communication Services.
Il fournit des informations d’identification TURN à un utilisateur.
Prise en main
Prérequis
- Un abonnement Azure.
- Une ressource Communication Services existante. Si vous devez créer la ressource, vous pouvez utiliser le portail Azure, le Azure PowerShell ou Azure CLI.
Installation de
npm install @azure/communication-network-traversal
npm install @azure/communication-identity
Prise en charge des navigateurs
Ensemble JavaScript
Pour utiliser cette bibliothèque cliente dans le navigateur, vous devez d’abord utiliser un bundler. Pour plus d’informations sur la procédure à suivre, reportez-vous à notre documentation sur le regroupement.
Concepts clés
Exemples
Authentification
Vous pouvez obtenir une clé et/ou une chaîne de connexion à partir de votre ressource Communication Services dans le portail Azure. Une fois que vous avez une clé, vous pouvez authentifier avec l’une CommunicationRelayClient
des méthodes suivantes :
Créer KeyCredential
avec AzureKeyCredential
avant d’initialiser le client
import { AzureKeyCredential } from "@azure/core-auth";
import { CommunicationRelayClient } from "@azure/communication-network-traversal";
const credential = new AzureKeyCredential(KEY);
const client = new CommunicationRelayClient(ENDPOINT, credential);
A l'aide d'une chaîne de connexion
import { CommunicationRelayClient } from "@azure/communication-network-traversal";
const connectionString = `endpoint=ENDPOINT;accessKey=KEY`;
const client = new CommunicationRelayClient(connectionString);
Utilisation d’un TokenCredential
import { DefaultAzureCredential } from "@azure/identity";
import { CommunicationRelayClient } from "@azure/communication-network-traversal";
const credential = new DefaultAzureCredential();
const client = new CommunicationRelayClient(ENDPOINT, credential);
Si vous utilisez une clé pour initialiser le client, vous devez également fournir le point de terminaison approprié. Vous pouvez obtenir ce point de terminaison à partir de votre ressource Communication Services dans le portail Azure.
Utilisation
Création d’une instance de CommunicationRelayClient
import { CommunicationRelayClient } from "@azure/communication-network-traversal";
const client = new CommunicationRelayClient(CONNECTION_STRING);
Création d’une instance de CommunicationIdentityClient pour créer un utilisateur
import { CommunicationIdentityClient } from "@azure/communication-identity";
const client = new CommunicationIdentityClient(CONNECTION_STRING);
Utilisez la createUser
méthode pour créer un utilisateur.
const user = await client.createUser();
Obtention de la configurationRelay
Utilisez la getConfigurationRelay
méthode pour obtenir de nouvelles informations d’identification TURN fournissant un utilisateur
const config = relayClient.getRelayConfiguration(user);
Vous pouvez également appeler la getConfigurationRelay
méthode sans fournir d’utilisateur
const config = relayClient.getRelayConfiguration();
Vous pouvez spécifier un RouteType lors de l’appel getConfigurationRelay
const config = relayClient.getRelayConfiguration(user, "nearest");
Dépannage
Étapes suivantes
Consultez le répertoire d’exemples pour obtenir des exemples détaillés sur l’utilisation de cette bibliothèque.
Contribution
Si vous souhaitez contribuer à cette bibliothèque, lisez le guide de contribution pour en savoir plus sur la génération et le test du code.
Projets associés
Azure SDK for JavaScript