適用于 JavaScript 的 Azure 通訊網路周遊用戶端程式庫 - 1.0.0 版
Azure 通訊網路周遊正在管理Azure 通訊服務的權杖。
它會提供 TURN 認證給使用者。
開始使用
Prerequisites
- Azure 訂用帳戶。
- 現有的通訊服務資源。 如果您需要建立資源,您可以使用Azure 入口網站、Azure PowerShell或Azure CLI。
安裝
npm install @azure/communication-network-traversal
npm install @azure/communication-identity
瀏覽器支援
JavaScript 套件組合
若要在瀏覽器中使用此用戶端程式庫,您必須先使用套件組合器。 如需如何執行這項操作的詳細資訊,請參閱我們的 統合檔。
重要概念
範例
驗證
您可以從 Azure入口網站中的通訊服務資源取得金鑰和/或連接字串。 取得金鑰之後,您可以使用下列任何方法驗證 CommunicationRelayClient
:
在初始化用戶端之前先建立 KeyCredential
AzureKeyCredential
import { AzureKeyCredential } from "@azure/core-auth";
import { CommunicationRelayClient } from "@azure/communication-network-traversal";
const credential = new AzureKeyCredential(KEY);
const client = new CommunicationRelayClient(ENDPOINT, credential);
使用連接字串
import { CommunicationRelayClient } from "@azure/communication-network-traversal";
const connectionString = `endpoint=ENDPOINT;accessKey=KEY`;
const client = new CommunicationRelayClient(connectionString);
使用 TokenCredential
import { DefaultAzureCredential } from "@azure/identity";
import { CommunicationRelayClient } from "@azure/communication-network-traversal";
const credential = new DefaultAzureCredential();
const client = new CommunicationRelayClient(ENDPOINT, credential);
如果您使用金鑰來初始化用戶端,您也需要提供適當的端點。 您可以從 Azure入口網站中的通訊服務資源取得此端點。
使用方式
建立 CommunicationRelayClient 的實例
import { CommunicationRelayClient } from "@azure/communication-network-traversal";
const client = new CommunicationRelayClient(CONNECTION_STRING);
建立 CommunicationIdentityClient 實例以建立使用者
import { CommunicationIdentityClient } from "@azure/communication-identity";
const client = new CommunicationIdentityClient(CONNECTION_STRING);
createUser
使用 方法來建立新的使用者。
const user = await client.createUser();
取得 configurationRelay
getConfigurationRelay
使用 方法來取得提供使用者的新 TURN 認證
const config = relayClient.getRelayConfiguration(user);
您也可以呼叫 getConfigurationRelay
方法,而不需提供使用者
const config = relayClient.getRelayConfiguration();
您可以在呼叫時指定 RouteType getConfigurationRelay
const config = relayClient.getRelayConfiguration(user, "nearest");
疑難排解
後續步驟
如需如何使用此程式庫的詳細 範例 ,請參閱範例目錄。
參與
如果您希望向此程式庫投稿,請參閱投稿指南,深入瞭解如何組建與測試程式碼。
相關專案