gitee/cim
1
0
Fork 0
mirror of https://gitee.com/farsunset/cim.git synced 2025-07-27 02:20:32 +08:00
Code Issues Packages Projects Releases Wiki Activity

README.md文档更新

Browse Source
This commit is contained in:
zhuhailiang 2023-10-25 11:34:55 +08:00
parent c9177612ea
commit ce2377c72b
1 changed files with 8 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
cim-client-sdk/cim-uniapp-sdk/README.md
View File

@ -1,30 +1,17 @@
**文档最新更新时间：****2023年10月25日** **文档最新更新时间：****2023年10月25日**
## 前言 ## 1、常用功能接口
CIM是一套完善的消息推送框架，可应用于信令推送，即时聊天，移动设备指令推送等领域。开发者可沉浸于业务开发，不用关心消息通道长连接、消息编解码协议等繁杂处理。
CIM采用业内主流开源技术构建，易于扩展和使用，并完美支持集群部署支持海量链接，目前支持websocket，android，ios，桌面应用，系统应用等多端接入持,可应用于移动应用，物联网，智能家居，嵌入式开发，桌面应用，WEB应用即时消服务。
和信是基于CIM组件开发的一整套完整的产品,面向所有人开放注册的试用场景。具有丰富的功能，聊天、群组、好友列表、黑名单、公众号、朋友圈等功能。不依赖任何第三方服务，可以私有化部署。
该软件为uniapp版本，支持多端适配，如有需要请联系作者购买。
[CIM协议开源地址：](https://gitee.com/farsunset/cim)
## 2、常用功能接口
所有开放外部接口都集中在uni.socket.js 所有开放外部接口都集中在uni.socket.js
服务端配置地址配置以及客户端相关配置都在这里面 服务端配置地址配置以及客户端相关配置都在这里面
### 2.0连接服务器 ### 1.0连接服务器
初始化完成后，调用连接服务器 初始化完成后，调用连接服务器
```javascript ```javascript
const uniSocket new UniSocket({ const uniSocket new UniSocket({
url: 'websocketUrl' url: 'websocketUrl'
}); });
``` ```
### 2.1绑定账号 ### 1.1绑定账号
在页面定义 function sendBufferRegister 在页面定义 function sendBufferRegister
当socket连接成功回调，然后绑定用户ID 当socket连接成功回调，然后绑定用户ID
```javascript ```javascript
@ -39,24 +26,24 @@ uniSocket.on('*', async (message) => {
}) })
``` ```
### 2.3停止接收消息 ### 1.3停止接收消息
停止接受推送，将会退出当前账号登录，端口与服务端的连接 停止接受推送，将会退出当前账号登录，端口与服务端的连接
```javascript ```javascript
uniSocket.close(); uniSocket.close();
``` ```
### 2.4恢复接收消息 ### 1.4恢复接收消息
重新恢复接收推送，重新连接服务端，并登录当前账号 重新恢复接收推送，重新连接服务端，并登录当前账号
```javascript ```javascript
uniSocket.reconnection(); uniSocket.reconnection();
``` ```
### 2.5发送SentBody请求 ### 1.5发送SentBody请求
支持通过长连接发送一个异步请求到服务的进行处理 支持通过长连接发送一个异步请求到服务的进行处理
例如发送一个位置上报请求 例如发送一个位置上报请求
key ：client_cycle_location 需要在服务端创建一个实现的handler参照BindHandler key ：client_cycle_location 需要在服务端创建一个实现的handler参照BindHandler
#### 2.5.1 protobuf序列化 #### 1.5.1 protobuf序列化
```javascript ```javascript
const SENT_BODY = 3 const SENT_BODY = 3
var body = new proto.com.farsunset.cim.sdk.web.model.SentBody(); var body = new proto.com.farsunset.cim.sdk.web.model.SentBody();
@ -79,7 +66,7 @@ success: (res) => {
}); });
``` ```
#### 2.5.1 json序列化 #### 1.5.2 json序列化
```javascript ```javascript
let body = {}; let body = {};
body.key ="client_cycle_location"; body.key ="client_cycle_location";