Skip to content

Commit

Permalink
Merge pull request #232 from JadenatZEGO/main
Browse files Browse the repository at this point in the history
更新 ZIM 文档
  • Loading branch information
JadenatZEGO authored Jan 10, 2025
2 parents f632339 + f5b3c92 commit 23559c6
Show file tree
Hide file tree
Showing 3 changed files with 69 additions and 67 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ To know how many unread messages you currently have after login, listen for the

After a successful login, the client user is notified of the update of the total number of unread messages through the callback in any of the following situations:

- Immediately receive the total number of unread messages stored in the local database.
- The user receives a new message and the message notification is enabled for the current conversation.
- The user proactively clears the number of unread conversation messages. For details, see the chapter above **Clear the number of unread conversation messages**.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ export const onConversationTotalUnreadMessageCountUpdatedMap = {
'mac': <a href='https://docs.zegocloud.com/article/api?doc=zim_API~objective-c_macos~protocol~ZIMEventHandler#zim-conversation-total-unread-message-count-updated' target='_blank'>conversationTotalUnreadMessageCountUpdated</a>,
}
export const setEventHandlerMap = {
'Android': <span> of the<a href='@setEventHandler' target='_blank'>setEventHandler</a>method</span>,
'Web': <span> of the<a href='@on' target='_blank'>on</a> method</span>,
'Android': <a href='@setEventHandler' target='_blank'>setEventHandler</a>,
'Web': <a href='@on' target='_blank'>on</a>,
"Flutter":" ",
}
export const clearConversationUnreadMessageCountMap = {
Expand Down Expand Up @@ -74,6 +74,7 @@ ZIM 支持主动或被动获取某个会话的未读数。

用户登录成功后,以下情况出现时,均会通过该接口,获取消息未读总数更新的通知:

- 立即收到一次存储于本地数据库中的未读总数。
- 用户接收到新消息、且当前会话没有开启消息免打扰。
- 用户主动清理了会话未读数量,具体请参考 [清除会话消息未读数](./Get%20the%20conversation%20list.mdx)

Expand Down
130 changes: 65 additions & 65 deletions core_products/zim/zh/docs_zim_miniprogram_zh/Sample code.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,228 +49,228 @@
</tr>
<tr>
<td rowspan="20">socket 合法域名</td>
<td>wss://webzim-sh2.zego.im</td>
<td><code>wss://webzim-sh2.zego.im</code></td>
<td rowspan="2">1.2.0 ~ 2.1.5</td>
<td rowspan="13">接入域名:ZEGO 服务器的 WebSocket 通信地址。</td>
</tr>
<tr>
<td>wss://webzim-sh2-bak.zego.im</td>
<td><code>wss://webzim-sh2-bak.zego.im</code></td>
</tr>
<tr>
<td>wss://accesshub-wss.zego.im</td>
<td><code>wss://accesshub-wss.zego.im</code></td>
<td>2.2.0 ~ 2.12.0</td>
</tr>
<tr>
<td>wss://accesshub-wss.coolbcloud.com</td>
<td><code>wss://accesshub-wss.coolbcloud.com</code></td>
<td rowspan="10">2.13.0 及以上</td>
</tr>
<tr>
<td>wss://accesshub-wss.coolccloud.com</td>
<td><code>wss://accesshub-wss.coolccloud.com</code></td>
</tr>
<tr>
<td>wss://accesshub-wss.coolgcloud.com</td>
<td><code>wss://accesshub-wss.coolgcloud.com</code></td>
</tr>
<tr>
<td>wss://accesshub-wss.coolhcloud.com</td>
<td><code>wss://accesshub-wss.coolhcloud.com</code></td>
</tr>
<tr>
<td>wss://accesshub-wss.coolzcloud.com</td>
<td><code>wss://accesshub-wss.coolzcloud.com</code></td>
</tr>
<tr>
<td>wss://accesshub-global.coolbcloud.com</td>
<td><code>wss://accesshub-global.coolbcloud.com</code></td>
</tr>
<tr>
<td>wss://accesshub-global.coolccloud.com</td>
<td><code>wss://accesshub-global.coolccloud.com</code></td>
</tr>
<tr>
<td>wss://accesshub-global.coolgcloud.com</td>
<td><code>wss://accesshub-global.coolgcloud.com</code></td>
</tr>
<tr>
<td>wss://accesshub-global.coolhcloud.com</td>
<td><code>wss://accesshub-global.coolhcloud.com</code></td>
</tr>
<tr>
<td>wss://accesshub-global.coolzcloud.com</td>
<td><code>wss://accesshub-global.coolzcloud.com</code></td>
</tr>
<tr>
<td>wss://webzim-report.zego.im</td>
<td><code>wss://webzim-report.zego.im</code></td>
<td>1.2.0 ~ 2.11.0</td>
<td rowspan="7">数据上报:分析 SDK 数据。</td>
</tr>
<tr>
<td>wss://weblogger-wss.zego.im</td>
<td><code>wss://weblogger-wss.zego.im</code></td>
<td rowspan="6">2.12.0 及以上</td>
</tr>
<tr>
<td>wss://weblogger-wss.coolbcloud.com</td>
<td><code>wss://weblogger-wss.coolbcloud.com</code></td>
</tr>
<tr>
<td>wss://weblogger-wss.coolccloud.com</td>
<td><code>wss://weblogger-wss.coolccloud.com</code></td>
</tr>
<tr>
<td>wss://weblogger-wss.coolgcloud.com</td>
<td><code>wss://weblogger-wss.coolgcloud.com</code></td>
</tr>
<tr>
<td>wss://weblogger-wss.coolhcloud.com</td>
<td><code>wss://weblogger-wss.coolhcloud.com</code></td>
</tr>
<tr>
<td>wss://weblogger-wss.coolzcloud.com</td>
<td><code>wss://weblogger-wss.coolzcloud.com</code></td>
</tr>
<tr>
<td rowspan="18">request 合法域名</td>
<td>https://cloud-setting-api.zego.im</td>
<td><code>>cloud-setting-api.zego.im</code></td>
<td rowspan="2">1.2.0 ~ 2.1.5</td>
<td rowspan="2">云控配置:动态修改 SDK 能力。</td>
</tr>
<tr>
<td>https://cloud-setting-api.zegocloud.com</td>
<td><code>https://cloud-setting-api.zegocloud.com</code></td>
</tr>
<tr>
<td>https://webzim-detaillog.zego.im</td>
<td><code>https://webzim-detaillog.zego.im</code></td>
<td>1.2.0 ~ 2.11.0</td>
<td rowspan="7">日志上报:排查故障,定位问题。</td>
</tr>
<tr>
<td>https://detaillog-global.zego.im</td>
<td><code>https://detaillog-global.zego.im</code></td>
<td rowspan="6">2.12.0 及以上</td>
</tr>
<tr>
<td>https://detaillog-global.coolbcloud.com</td>
<td><code>https://detaillog-global.coolbcloud.com</code></td>
</tr>
<tr>
<td>https://detaillog-global.coolccloud.com</td>
<td><code>https://detaillog-global.coolccloud.com</code></td>
</tr>
<tr>
<td>https://detaillog-global.coolgcloud.com</td>
<td><code>https://detaillog-global.coolgcloud.com</code></td>
</tr>
<tr>
<td>https://detaillog-global.coolhcloud.com</td>
<td><code>https://detaillog-global.coolhcloud.com</code></td>
</tr>
<tr>
<td>https://detaillog-global.coolzcloud.com</td>
<td><code>https://detaillog-global.coolzcloud.com</code></td>
</tr>
<tr>
<td>https://zego-zim-smsh.oss-cn-shanghai.aliyuncs.com</td>
<td><code>https://zego-zim-smsh.oss-cn-shanghai.aliyuncs.com</code></td>
<td rowspan="3">2.2.0 ~ 2.11.0</td>
<td rowspan="9">文件媒体消息:文件媒体消息的 URL。</td>
</tr>
<tr>
<td>https://zego-zim-zimsh.oss-cn-shanghai.aliyuncs.com</td>
<td><code>https://zego-zim-zimsh.oss-cn-shanghai.aliyuncs.com</code></td>
</tr>
<tr>
<td>https://zimfile-sh2.zego.im</td>
<td><code>https://zimfile-sh2.zego.im</code></td>
</tr>
<tr>
<td>https://access-zfpxy-global.zego.im</td>
<td><code>https://access-zfpxy-global.zego.im</code></td>
<td rowspan="6">2.12.0 及以上</td>
</tr>
<tr>
<td>https://access-zfpxy-global.coolbcloud.com</td>
<td><code>https://access-zfpxy-global.coolbcloud.com</code></td>
</tr>
<tr>
<td>https://access-zfpxy-global.coolccloud.com</td>
<td><code>https://access-zfpxy-global.coolccloud.com</code></td>
</tr>
<tr>
<td>https://access-zfpxy-global.coolgcloud.com</td>
<td><code>https://access-zfpxy-global.coolgcloud.com</code></td>
</tr>
<tr>
<td>https://access-zfpxy-global.coolhcloud.com</td>
<td><code>https://access-zfpxy-global.coolhcloud.com</code></td>
</tr>
<tr>
<td>https://access-zfpxy-global.coolzcloud.com</td>
<td><code>https://access-zfpxy-global.coolzcloud.com</code></td>
</tr>
<tr>
<td rowspan="16">uploadFile 合法域名</td>
<td>https://webzim-detaillog.zego.im</td>
<td><code>https://webzim-detaillog.zego.im</code></td>
<td>1.2.0 ~ 2.11.0</td>
<td rowspan="7">日志上报:排查故障,定位问题。</td>
</tr>
<tr>
<td>https://detaillog-global.zego.im</td>
<td><code>https://detaillog-global.zego.im</code></td>
<td rowspan="6">2.12.0 及以上</td>
</tr>
<tr>
<td>https://detaillog-global.coolbcloud.com</td>
<td><code>https://detaillog-global.coolbcloud.com</code></td>
</tr>
<tr>
<td>https://detaillog-global.coolccloud.com</td>
<td><code>https://detaillog-global.coolccloud.com</code></td>
</tr>
<tr>
<td>https://detaillog-global.coolgcloud.com</td>
<td><code>https://detaillog-global.coolgcloud.com</code></td>
</tr>
<tr>
<td>https://detaillog-global.coolhcloud.com</td>
<td><code>https://detaillog-global.coolhcloud.com</code></td>
</tr>
<tr>
<td>https://detaillog-global.coolzcloud.com</td>
<td><code>https://detaillog-global.coolzcloud.com</code></td>
</tr>
<tr>
<td>https://zego-zim-smsh.oss-cn-shanghai.aliyuncs.com</td>
<td><code>https://zego-zim-smsh.oss-cn-shanghai.aliyuncs.com</code></td>
<td rowspan="3">2.2.0 ~ 2.11.0</td>
<td rowspan="9">文件媒体消息:文件媒体消息的 URL。</td>
</tr>
<tr>
<td>https://zego-zim-zimsh.oss-cn-shanghai.aliyuncs.com</td>
<td><code>https://zego-zim-zimsh.oss-cn-shanghai.aliyuncs.com</code></td>
</tr>
<tr>
<td>https://zimfile-sh2.zego.im</td>
<td><code>https://zimfile-sh2.zego.im</code></td>
</tr>
<tr>
<td>https://access-zfpxy-global.zego.im</td>
<td><code>https://access-zfpxy-global.zego.im</code></td>
<td rowspan="6">2.12.0 及以上</td>
</tr>
<tr>
<td>https://access-zfpxy-global.coolbcloud.com</td>
<td><code>https://access-zfpxy-global.coolbcloud.com</code></td>
</tr>
<tr>
<td>https://access-zfpxy-global.coolccloud.com</td>
<td><code>https://access-zfpxy-global.coolccloud.com</code></td>
</tr>
<tr>
<td>https://access-zfpxy-global.coolgcloud.com</td>
<td><code>https://access-zfpxy-global.coolgcloud.com</code></td>
</tr>
<tr>
<td>https://access-zfpxy-global.coolhcloud.com</td>
<td><code>https://access-zfpxy-global.coolhcloud.com</code></td>
</tr>
<tr>
<td>https://access-zfpxy-global.coolzcloud.com</td>
<td><code>https://access-zfpxy-global.coolzcloud.com</code></td>
</tr>
<tr>
<td rowspan="9">downloadFile 合法域名</td>
<td>https://zego-zim-smsh.oss-cn-shanghai.aliyuncs.com</td>
<td><code>https://zego-zim-smsh.oss-cn-shanghai.aliyuncs.com</code></td>
<td rowspan="3">2.2.0 ~ 2.11.0</td>
<td rowspan="9">文件媒体消息:文件媒体消息的 URL。</td>
</tr>
<tr>
<td>https://zego-zim-zimsh.oss-cn-shanghai.aliyuncs.com</td>
<td><code>https://zego-zim-zimsh.oss-cn-shanghai.aliyuncs.com</code></td>
</tr>
<tr>
<td>https://zimfile-sh2.zego.im</td>
<td><code>https://zimfile-sh2.zego.im</code></td>
</tr>
<tr>
<td>https://access-zfpxy-global.zego.im</td>
<td><code>https://access-zfpxy-global.zego.im</code></td>
<td rowspan="6">2.12.0 及以上</td>
</tr>
<tr>
<td>https://access-zfpxy-global.coolbcloud.com</td>
<td><code>https://access-zfpxy-global.coolbcloud.com</code></td>
</tr>
<tr>
<td>https://access-zfpxy-global.coolccloud.com</td>
<td><code>https://access-zfpxy-global.coolccloud.com</code></td>
</tr>
<tr>
<td>https://access-zfpxy-global.coolgcloud.com</td>
<td><code>https://access-zfpxy-global.coolgcloud.com</code></td>
</tr>
<tr>
<td>https://access-zfpxy-global.coolhcloud.com</td>
<td><code>https://access-zfpxy-global.coolhcloud.com</code></td>
</tr>
<tr>
<td>https://access-zfpxy-global.coolzcloud.com</td>
<td><code>https://access-zfpxy-global.coolzcloud.com</code></td>
</tr>
</tbody>
</table>


### 示例源码目录结构

- 下列结构为 `微信原生小程序` 开发的的源码文件的子目录结构,下文所涉及的文件路径均为相对于此目录的路径,请参考 [运行微信原生小程序示例源码](12679#1_5)
- 下列结构为 `微信原生小程序` 开发的的源码文件的子目录结构,下文所涉及的文件路径均为相对于此目录的路径,请参考 [运行微信原生小程序示例源码](#运行微信原生小程序示例源码)

```bash
├── README.md
Expand All @@ -290,7 +290,7 @@
└── typings
```

- 下列结构为 `uni-app 框架` 开发的源码文件的子目录结构,下文所涉及的文件路径均为相对于此目录的路径,请参考 [使用 uni-app 框架示例源码运行到微信小程序平台](12679#1_6)
- 下列结构为 `uni-app 框架` 开发的源码文件的子目录结构,下文所涉及的文件路径均为相对于此目录的路径,请参考 [使用 uni-app 框架示例源码运行到微信小程序平台](#使用-uni-app-框架示例源码运行到微信小程序平台)

```bash
├── App.vue
Expand Down

0 comments on commit 23559c6

Please sign in to comment.