JavaScript 的 Azure 通信信号客户端库

Azure通信信号客户端库允许开发者添加实时通知,用于接收新/更新/删除聊天消息事件,打入指标事件,读取接收事件,以及聊天线索事件.

更多信息,请访问 Azure 通信服务 这里

开始

先决条件

• 一个 Azure 订阅。 。 。 .
• 现有通信服务资源。 如果您需要创建资源, 您可以使用 Azure 门户,则 Azure 动力壳,或 阿苏尔CLI。 。 。 .
• 节点.js

安装

npm install @azure/communication-signaling

浏览器支持

Java 脚本套装

这个客户端库只在浏览器中支持. 要使用这个客户端库,首先需要使用捆绑器. 关于如何做到这一点的详情,请参见我们 捆绑文件。 。 。 .

关键概念

信号 客户端

SignalingClient 是开发者使用此客户端库的主要界面。 它提供了对不同事件的实时通知和注册听众的方法.

实例

初始化信号连接

使用用户访问令牌和Azurelogger来初始化信号客户端.

import { CommunicationSignalingClient } from '@azure/communication-signaling';
import { AzureCommunicationTokenCredential } from "@azure/communication-common";
import { createClientLogger } from "@azure/logger";

let userAccessToken = '<USER_ACCESS_TOKEN>';
let tokenCredential = new AzureCommunicationTokenCredential(userAccessToken);
let logger = createClientLogger("communication-signaling");
let signalingClient = new CommunicationSignalingClient(tokenCredential, logger);

启用实时通知

signalingClient.start();

禁用实时通知

signalingClient.stop();

事件注册听众

通过实时信号,可以订阅以收听新来的事件,并相应调用自己的业务逻辑.

// register listener to new incoming message event
signalingClient.on("chatMessageReceived", (payload) => {
    console.log("Notification chatMessageReceived!");
    // your code here
});

// register listener to typing indicator event
signalingClient.on("typingIndicatorReceived", (payload) => {
    console.log("Notification typingIndicatorReceived!");
    // your code here
});

// register listener to thread deleted event
signalingClient.on("chatThreadDeleted", (payload) => {
    console.log("Notification chatThreadDeleted!");
    // your code here
});