open-soure / cim · 提交

转到一个项目

作者 crossoverJie
提交 90929fe1d04d88b0cae7a6ea3594e486101496bf 1 个父辈 19f7500d

:memo: Writing docs.

内嵌 并排对比
正在显示 1 个修改的文件 包含 36 行增加 和 11 行删除
@@ -64,6 +64,7 @@ @@ -64,6 +64,7 @@
64 * [x] 路由(`cim-forward-route`)服务自身是无状态，可用 `Nginx` 代理支持高可用。 64 * [x] 路由(`cim-forward-route`)服务自身是无状态，可用 `Nginx` 代理支持高可用。
65 * [x] 聊天记录查询。 65 * [x] 聊天记录查询。
66 * [x] 服务端自动剔除离线客户端。 66 * [x] 服务端自动剔除离线客户端。
  67 +* [x] 一键开启价值 2 亿的 `AI` 模式。
67 * [ ] 弱网环境下客户端自动重连。 68 * [ ] 弱网环境下客户端自动重连。
68 * [ ] 分组群聊。 69 * [ ] 分组群聊。
69 * [ ] 离线消息。 70 * [ ] 离线消息。
@@ -148,15 +149,15 @@ curl -X POST --header 'Content-Type: application/json' --header 'Accept: applica @@ -148,15 +149,15 @@ curl -X POST --header 'Content-Type: application/json' --header 'Accept: applica
148 149
149 从返回结果中获取 `userId` 150 从返回结果中获取 `userId`
150 151
151 -```shell 152 +```json
152 { 153 {
153 - "code": "9000",  
154 - "message": "成功",  
155 - "reqNo": null,  
156 - "dataBody": {  
157 - "userId": 1547028929406,  
158 - "userName": "zhangsan"  
159 - } 154 + "code":"9000",
  155 + "message":"成功",
  156 + "reqNo":null,
  157 + "dataBody":{
  158 + "userId":1547028929407,
  159 + "userName":"test"
  160 + }
160 } 161 }
161 ``` 162 ```
162 163
@@ -183,6 +184,32 @@ java -jar cim-client-1.0.0-SNAPSHOT.jar --server.port=8084 --cim.user.id=上方 @@ -183,6 +184,32 @@ java -jar cim-client-1.0.0-SNAPSHOT.jar --server.port=8084 --cim.user.id=上方
183 184
184 ![](https://ws3.sinaimg.cn/large/006tNbRwly1fylh7bdlo6g30go01shdt.gif) 185 ![](https://ws3.sinaimg.cn/large/006tNbRwly1fylh7bdlo6g30go01shdt.gif)
185 186
  187 +### 聊天记录查询
  188 +
  189 +![](https://ws2.sinaimg.cn/large/006tNc79gy1fz3uwmb5hsj30s8046wm3.jpg)
  190 +
  191 +使用命令 `:q 关键字` 即可查询与个人相关的聊天记录。
  192 +
  193 +> 客户端聊天记录默认存放在 `/opt/logs/cim/`，所以需要这个目录的写入权限。也可在启动命令中加入 `--cim.msg.logger.path = /自定义` 参数自定义目录。
  194 +
  195 +
  196 +
  197 +### AI 模式
  198 +
  199 +![](https://ws3.sinaimg.cn/large/006tNc79gy1fz3vf3nsq3j31dc0j01ky.jpg)
  200 +
  201 +使用命令 `:ai` 开启 AI 模式，之后所有的消息都会由 `AI` 响应。
  202 +
  203 +`:qai` 退出 AI 模式。
  204 +
  205 +### 前缀匹配用户名
  206 +
  207 +![](https://ws4.sinaimg.cn/large/006tNc79gy1fz3vo4tgkjj31ni09s41u.jpg)
  208 +
  209 +使用命令 `:qu prefix` 可以按照前缀的方式重新用户信息。
  210 +
  211 +> 该功能主要用于在移动端中的输入框中搜索用户。
  212 +
186 ## 群聊/私聊 213 ## 群聊/私聊
187 214
188 ### 群聊 215 ### 群聊
@@ -208,7 +235,7 @@ java -jar cim-client-1.0.0-SNAPSHOT.jar --server.port=8084 --cim.user.id=上方 @@ -208,7 +235,7 @@ java -jar cim-client-1.0.0-SNAPSHOT.jar --server.port=8084 --cim.user.id=上方
208 ![](https://ws3.sinaimg.cn/large/006tNbRwly1fylicmjj6cj31wg07c4qp.jpg) 235 ![](https://ws3.sinaimg.cn/large/006tNbRwly1fylicmjj6cj31wg07c4qp.jpg)
209 ![](https://ws1.sinaimg.cn/large/006tNbRwly1fylicwhe04j31ua03ejsv.jpg) 236 ![](https://ws1.sinaimg.cn/large/006tNbRwly1fylicwhe04j31ua03ejsv.jpg)
210 237
211 -同时另一个账号是收不到消息的。 238 +同时另一个账号收不到消息。
212 ![](https://ws3.sinaimg.cn/large/006tNbRwly1fylie727jaj31t20dq1ky.jpg) 239 ![](https://ws3.sinaimg.cn/large/006tNbRwly1fylie727jaj31t20dq1ky.jpg)
213 240
214 241
@@ -223,7 +250,5 @@ java -jar cim-client-1.0.0-SNAPSHOT.jar --server.port=8084 --cim.user.id=上方 @@ -223,7 +250,5 @@ java -jar cim-client-1.0.0-SNAPSHOT.jar --server.port=8084 --cim.user.id=上方
223 ![](https://ws1.sinaimg.cn/large/006tKfTcly1ftmfdo6mhmj30760760t7.jpg) 250 ![](https://ws1.sinaimg.cn/large/006tKfTcly1ftmfdo6mhmj30760760t7.jpg)
224 251
225 # Code Visualization 252 # Code Visualization
226 -=========================  
227 -感谢`gitviscode`组织制作的`commit history`视频，记录从15年萌芽发展，有那么多开发者加入完善。1'50的时候，以为项目都停止更新了，然后突然如烟花绽放的感觉，我他妈都感动得要哭了  
228 253
229 [![Watch the video](https://img.youtube.com/vi/NhV_brPIG74/maxresdefault.jpg)](https://youtu.be/NhV_brPIG74) 254 [![Watch the video](https://img.youtube.com/vi/NhV_brPIG74/maxresdefault.jpg)](https://youtu.be/NhV_brPIG74)