mirror of
https://github.com/WuKongIM/WuKongIMDocs
synced 2025-06-03 07:42:48 +00:00
docs: update
This commit is contained in:
parent
56c24f7088
commit
a1c44c29cf
@ -27,6 +27,7 @@ export const sidebar: DefaultTheme.Sidebar = {
|
||||
text: "进阶",
|
||||
collapsed: false,
|
||||
items: [
|
||||
{ text: "离线消息说明", link: "/guide/offlinemsg" },
|
||||
{ text: "集成到自己系统", link: "/guide/integration" },
|
||||
{ text: "最佳实践", link: "/guide/practice" },
|
||||
{ text: "配置说明", link: "/guide/fullconfig" },
|
||||
|
BIN
src/guide/diffusion.png
Normal file
BIN
src/guide/diffusion.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 219 KiB |
@ -89,4 +89,4 @@ webhook
|
||||
WK_WEBHOOK_HTTPADDR: http://xxxxxx
|
||||
```
|
||||
|
||||
规则 WK*为固定前缀,层级关系通过 "*"符号隔开,全都大写
|
||||
规则 WK为固定前缀,层级关系通过 "_"符号隔开,全都大写
|
||||
|
@ -5,77 +5,32 @@ title: 介绍
|
||||
|
||||
# 文档阅读引导
|
||||
|
||||
## 1. 部署服务端
|
||||
## 在线体验
|
||||
|
||||
聊天Demo:http://imdemo.githubim.com
|
||||
|
||||
监控系统:http://monitor.githubim.com/web/
|
||||
|
||||
## 部署服务端
|
||||
|
||||
服务端部署:[一分钟部署](/guide/quickstart)
|
||||
|
||||
## 2. 运行客户端 Demo
|
||||
部署后打开 http://127.0.0.1:5172/chatdemo 即可体验
|
||||
|
||||
下载以下任意源码跑起来 Demo,API 基地址填写自己服务器地址即可。(`格式:http://xxx.xxx.xxx.xx:5001`)
|
||||
|
||||
[iOS Demo 和 SDK 源码](https://github.com/WuKongIM/WuKongIMiOSSDK)
|
||||
|
||||
[Android Demo 和 SDK 源码](https://github.com/WuKongIM/WuKongIMAndroidSDK)
|
||||
## SDK源码(SDK源码内附有Demo)与文档
|
||||
|
||||
[Web Demo 和 SDK 源码](https://github.com/WuKongIM/WuKongIMJSSDK)
|
||||
| 项目名 | Github地址 | Gitee地址 | 文档 | 说明 |
|
||||
| ---- | ---------- | --------- | ---- | ---- |
|
||||
| WuKongIMAndroidSDK | [Github](https://github.com/WuKongIM/WuKongIMAndroidSDK) | [Gitee](https://gitee.com/WuKongDev/WuKongIMAndroidSDK) | [文档](/sdk/android) | 悟空IM的Android SDK |
|
||||
| WuKongIMiOSSDK | [Github](https://github.com/WuKongIM/WuKongIMiOSSDK) | [Gitee](https://gitee.com/WuKongDev/WuKongIMiOSSDK) | [文档](/sdk/ios) | 悟空IM的iOS SDK |
|
||||
| WuKongIMUniappSDK | [Github](https://github.com/WuKongIM/WuKongIMUniappSDK) | [Gitee](https://gitee.com/WuKongDev/WuKongIMUniappSDK) | [文档](/sdk/uniapp) | 悟空IM的 Uniapp SDK |
|
||||
| WuKongIMJSSDK | [Github](https://github.com/WuKongIM/WuKongIMJSSDK) | [Gitee](https://gitee.com/WuKongDev/WuKongIMJSSDK) | [文档](/sdk/javascript) | 悟空IM的 JS SDK |
|
||||
| WuKongIMFlutterSDK | [Github](https://github.com/WuKongIM/WuKongIMFlutterSDK) | [Gitee](https://gitee.com/WuKongDev/WuKongIMFlutterSDK) | 编写中 | 悟空IM的 Flutter SDK |
|
||||
| WuKongIMReactNativeDemo | [Github](https://github.com/wengqianshan/WuKongIMReactNative) | 无 | Apache2.0 | 悟空IM的 React Native Demo(由贡献者 [wengqianshan](https://github.com/wengqianshan) 提供) |
|
||||
|
||||
[Uniapp Demo 和 SDK 源码](https://github.com/WuKongIM/WuKongIMUniappSDK)
|
||||
|
||||
[React Native Demo 源码](https://github.com/wengqianshan/WuKongIMReactNative)
|
||||
|
||||
`微信小程序还没有Demo,微信小程序SDK可以使用JS SDK,JS SDK做了微信小程序的兼容`
|
||||
|
||||
<!-- [Flutter Demo 和 SDK 源码(待完善)](https://github.com/WuKongIM/WuKongIMFlutterSDK) -->
|
||||
|
||||
如果你只是想体验一下,可以直接使用我们的 Demo,Demo 中的 API 基地址也可以修改为你自己服务器的地址
|
||||
|
||||
Web 在线演示:http://imdemo.githubim.com
|
||||
|
||||
## 3. 详细的使用指南
|
||||
|
||||
### 后端程序员
|
||||
|
||||
第一步:了解下服务端的配置文件:[配置说明](/guide/fullconfig)
|
||||
|
||||
第二步:了解下服务端的 API:[API 文档](/api)
|
||||
|
||||
第三步:了解下 webhook:[webhook 机制](/api/webhook)
|
||||
|
||||
`上面三步做完,祝你玩的飞起。`
|
||||
|
||||
还有问题提[issue](https://github.com/WuKongIM/WuKongIM/issues)
|
||||
|
||||
### iOS 程序员
|
||||
|
||||
第一步:跑通 Demo: [iOS Demo 和 SDK 源码](https://github.com/WuKongIM/WuKongIMiOSSDK)
|
||||
|
||||
第二步:了解下 iOS SDK 的使用:[iOS SDK 使用指南](/sdk/i-os)
|
||||
|
||||
还有问题提[issue](https://github.com/WuKongIM/WuKongIMiOSSDK/issues)
|
||||
|
||||
### Android 程序员
|
||||
|
||||
第一步:跑通 Demo: [Android Demo 和 SDK 源码](https://github.com/WuKongIM/WuKongIMAndroidSDK)
|
||||
|
||||
第二步:了解下 Android SDK 的使用:[Android SDK 使用指南](/sdk/android)
|
||||
|
||||
还有问题提[issue](https://github.com/WuKongIM/WuKongIMAndroidSDK/issues)
|
||||
|
||||
### Uniapp 程序员
|
||||
|
||||
第一步:Uniapp Demo: [Uniapp Demo 和 SDK 源码](https://github.com/WuKongIM/WuKongIMUniappSDK)
|
||||
|
||||
第二步:了解下 Uniapp SDK 的使用:[Uniapp SDK 使用指南](/sdk/uniapp)
|
||||
|
||||
还有问题提[issue](https://github.com/WuKongIM/WuKongIMUniappSDK/issues)
|
||||
|
||||
### Web 程序员
|
||||
|
||||
第一步:Web Demo: [Javascript Demo 和 SDK 源码](https://github.com/WuKongIM/WuKongIMJSSDK)
|
||||
|
||||
第二步:了解下 Javascript SDK 的使用:[Javascript SDK 使用指南](/sdk/javascript)
|
||||
|
||||
还有问题提[issue](https://github.com/WuKongIM/WuKongIMJSSDK/issues)
|
||||
|
||||
有需要加微信群交流:
|
||||
|
||||
|
@ -32,4 +32,4 @@
|
||||
|
||||
### 最近会话
|
||||
|
||||
最近会话是用户与用户或用户与群之间的一次会话,最近会话包含会话 ID,会话类型,会话名称,会话头像,会话最后一条消息,会话最后一条消息发送时间等字段。
|
||||
最近会话是用户与用户或用户与群之间的一次会话,最近会话包含会话 ID,会话类型,会话名称,会话头像,会话最后一条消息,未读消息数量,会话最后一条消息发送时间等字段。
|
||||
|
15
src/guide/offlinemsg.md
Normal file
15
src/guide/offlinemsg.md
Normal file
@ -0,0 +1,15 @@
|
||||
# 离线消息
|
||||
|
||||
*悟空IM* 采用读扩散模式, 什么是读扩散和写扩散? 参考文章:[链接](https://blog.csdn.net/m0_53246313/article/details/122674197)
|
||||
|
||||
*悟空IM*开启最近会话配置后,*悟空IM*会在服务端为每个用户维护一份属于自己的最近会话列表。([什么是最近会话?](/guide/initialize.html#%E6%9C%80%E8%BF%91%E4%BC%9A%E8%AF%9D))
|
||||
|
||||
1. 应用由离线变成在线后,需要同步最近会话列表,如下图
|
||||
|
||||

|
||||
|
||||
2. 应用在线后,应用应该在线维护最近会话列表。
|
||||
|
||||
3. 当点击某个会话(频道)进入到聊天界面时,需要同步该会话(频道)的消息,如下图(同时需要将最近会话的红点数清空 `/conversations/setUnread`)
|
||||
|
||||

|
BIN
src/guide/offlinemsg1.png
Normal file
BIN
src/guide/offlinemsg1.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 137 KiB |
BIN
src/guide/offlinemsg2.png
Normal file
BIN
src/guide/offlinemsg2.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 141 KiB |
@ -22,7 +22,7 @@
|
||||
|
||||
- 第三方服务器可决定分配指定的订阅者成组投递
|
||||
|
||||
`(整体逻辑: 访客发消息 -> 空频道 -> 业务路由 -> 拉客服和访客到此频道 ->开始聊天 )`
|
||||
`(整体逻辑: 访客发消息 -> 空频道 -> 第三方服务器监听空频道消息(通过webhook) -> 匹配客服 -> 拉客服和访客到此频道 ->开始聊天 )`
|
||||
|
||||
## 游戏聊天室
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user