Skip to content

Commit

Permalink
doc: 更新nodesdk介绍页
Browse files Browse the repository at this point in the history
  • Loading branch information
zoswing committed Dec 25, 2021
1 parent 2f1b254 commit 98a8d94
Showing 1 changed file with 8 additions and 13 deletions.
21 changes: 8 additions & 13 deletions docs/develop/nodesdk/README.md
@@ -1,28 +1,23 @@
# SDK 接入指南
# NodeSDK 接入指南

## 介绍

`NodeSDK`主要基于[基础 API ](../api/README.md)封装,提供给用户一种简单、高效的使用方式。

整体而言 SDK 包含了以下功能
整个 SDK 设计与实现基于**两条主线**

- 发送 **http** 请求进行频道操作,包括频道增删改、用户增删改和消息发送等。
- 通过 websocket 与服务端建立 **⻓连接**,监听频道事件。
- **主动的事件触发**
- 频道操作能力:子频道增删改、身份组增删改、成员增删改等。
- 主动消息推送能力。
- **被动的事件监听**
- 通过 `websocket` 监听事件。

### SDK 底层架构设计

整个 SDK 分三层设计:`应用层``框架层``基础层`,具体结构如下图所示:
SDK 分三层设计:`应用层``框架层``基础层`,具体结构如下图所示:

<img :src="$withBotBase('/images/node-sdk/framework.png')" alt="SDK 底层架构设计">

整个 SDK 设计与实现基于**两条主线**

- 主动的事件触发
- 频道操作能力:子频道增删改、身份组增删改、成员增删改等。
- 主动消息推送能力。
- 被动的事件监听
- 通过 websocket 监听事件。

## 安装

### 当前版本
Expand Down

0 comments on commit 98a8d94

Please sign in to comment.