Skip to content

Commit

Permalink
Merge pull request #648 from haoxiuwen/doc-v2
Browse files Browse the repository at this point in the history 
Modify Electron Doc
  • Loading branch information
@haoxiuwen
haoxiuwen authored Feb 26, 2024
2 parents 06b6c7c + 8fd96d9 commit 9c4b5e8
Show file tree
Hide file tree
Showing 33 changed files with 189 additions and 189 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/blank.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,12 +70,12 @@ jobs:
accessKeyId: ${{ secrets.ALIYUN_CDN_ACCESS_KEY_ID }}
accessKeySecret: ${{ secrets.ALIYUN_CDN_ACCESS_KEY_SECRET }}
type: Directory
path: https://docs-im-beta.easemob.com/
path: https://doc.easemob.com/

- name: CDN Refresh HTTP
uses: visionwx/ali-cdn-refresh@main
with:
accessKeyId: ${{ secrets.ALIYUN_CDN_ACCESS_KEY_ID }}
accessKeySecret: ${{ secrets.ALIYUN_CDN_ACCESS_KEY_SECRET }}
type: Directory
path: http://docs-im-beta.easemob.com/
path: http://doc.easemob.com/
2 changes: 1 addition & 1 deletion docs/.vuepress/navbar/index.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ export const zhNavbar = navbar([
{
text: "Web/小程序",
icon: "/icon-web.svg",
link: "https://docs-im-beta.easemob.com/jsdoc/index.html",
link: "https://doc.easemob.com/jsdoc/index.html",
},
{
text: "Windows",
Expand Down
66 changes: 33 additions & 33 deletions docs/document/android/elite_sdk.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
<td rowspan="17">消息管理</td>
<td rowspan="9">发送和接收消息</td>
<td>发送和接收消息</td>
<td rowspan="9"><p><a href="https://docs-im-beta.easemob.com/document/android/message_send_receive.html">发送和接收消息</a></p></td>
<td rowspan="9"><p><a href="https://doc.easemob.com/document/android/message_send_receive.html">发送和接收消息</a></p></td>
<td>✅</td>
<td>✅</td>
</tr>
Expand Down Expand Up @@ -75,32 +75,32 @@
<tr>
<td>管理本地消息</td>
<td>管理本地消息</td>
<td><p><a href="https://docs-im-beta.easemob.com/document/android/message_retrieve.html">获取本地历史消息</a><a href="https://docs-im-beta.easemob.com/document/android/message_retrieve.html"></a></p>
<p><a href="https://docs-im-beta.easemob.com/document/android/message_search.html">搜索消息</a></p>
<p><a href="https://docs-im-beta.easemob.com/document/android/message_import_insert.html">导入和插入消息</a></p>
<p><a href="https://docs-im-beta.easemob.com/document/android/message_update.html">更新消息</a></p>
<p><a href="https://docs-im-beta.easemob.com/document/android/message_delete.html">删除消息</a></p></td>
<td><p><a href="https://doc.easemob.com/document/android/message_retrieve.html">获取本地历史消息</a><a href="https://doc.easemob.com/document/android/message_retrieve.html"></a></p>
<p><a href="https://doc.easemob.com/document/android/message_search.html">搜索消息</a></p>
<p><a href="https://doc.easemob.com/document/android/message_import_insert.html">导入和插入消息</a></p>
<p><a href="https://doc.easemob.com/document/android/message_update.html">更新消息</a></p>
<p><a href="https://doc.easemob.com/document/android/message_delete.html">删除消息</a></p></td>
<td>❌</td>
<td>✅</td>
</tr>
<tr>
<td>管理服务端消息</td>
<td>管理服务端消息</td>
<td><p><a href="https://docs-im-beta.easemob.com/document/android/message_retrieve.html">从服务器分页获取指定会话的历史消息</a></p>
<p><a href="https://docs-im-beta.easemob.com/document/android/message_delete.html#单向删除服务端的历史消息">单向删除服务端的历史消息</a></p></td>
<td><p><a href="https://doc.easemob.com/document/android/message_retrieve.html">从服务器分页获取指定会话的历史消息</a></p>
<p><a href="https://doc.easemob.com/document/android/message_delete.html#单向删除服务端的历史消息">单向删除服务端的历史消息</a></p></td>
<td>✅</td>
<td>✅</td>
</tr>
<tr>
<td rowspan="2">管理消息回执</td>
<td>消息送达回执</td>
<td><p><a href="https://docs-im-beta.easemob.com/document/android/message_receipt.html">消息送达回执</a></p></td>
<td><p><a href="https://doc.easemob.com/document/android/message_receipt.html">消息送达回执</a></p></td>
<td>✅</td>
<td>✅</td>
</tr>
<tr>
<td>消息已读回执</td>
<td><p><a href="https://docs-im-beta.easemob.com/document/android/message_receipt.html">消息已读回执</a></p></td>
<td><p><a href="https://doc.easemob.com/document/android/message_receipt.html">消息已读回执</a></p></td>
<td>❌</td>
<td>✅</td>
</tr>
Expand All @@ -115,71 +115,71 @@
<tr>
<td>修改消息</td>
<td>单聊会话中已经发送成功的文本消息进行修改</td>
<td><p><a href="https://docs-im-beta.easemob.com/document/android/message_modify.html">修改消息</a></p></td>
<td><p><a href="https://doc.easemob.com/document/android/message_modify.html">修改消息</a></p></td>
<td>❌</td>
<td>✅</td>
</tr>
<tr>
<td height="71">获取消息流量统计</td>
<td>获取消息流量统计</td>
<td><a href="https://docs-im-beta.easemob.com/document/android/message_traffic_statis.html">获取消息流量统计</a></td>
<td><a href="https://doc.easemob.com/document/android/message_traffic_statis.html">获取消息流量统计</a></td>
<td>&nbsp;</td>
<td>&nbsp;</td>
</tr>
<tr>
<td height="71">翻译</td>
<td>消息翻译</td>
<td><p><a href="https://docs-im-beta.easemob.com/document/android/message_modify.html">消息翻译</a></p></td>
<td><p><a href="https://doc.easemob.com/document/android/message_modify.html">消息翻译</a></p></td>
<td>❌</td>
<td>✅</td>
</tr>
<tr>
<td rowspan="6">会话管理</td>
<td rowspan="2">会话列表</td>
<td>获取本地所有会话 </td>
<td><a href="https://docs-im-beta.easemob.com/document/android/conversation_list.html#获取本地所有会话">获取本地所有会话</a></td>
<td><a href="https://doc.easemob.com/document/android/conversation_list.html#获取本地所有会话">获取本地所有会话</a></td>
<td>❌</td>
<td>✅</td>
</tr>
<tr>
<td> 从服务器分页获取会话列表</td>
<td><p><a href="https://docs-im-beta.easemob.com/document/android/conversation_list.html#从服务器分页获取会话列表">从服务器分页获取会话列表</a></p></td>
<td><p><a href="https://doc.easemob.com/document/android/conversation_list.html#从服务器分页获取会话列表">从服务器分页获取会话列表</a></p></td>
<td>✅</td>
<td>✅</td>
</tr>
<tr>
<td>会话未读数</td>
<td>获取或清零本地会话的未读数</td>
<td><p>&nbsp;</p>
<p><a href="https://docs-im-beta.easemob.com/document/android/conversation_unread.html">会话未读数</a></p></td>
<p><a href="https://doc.easemob.com/document/android/conversation_unread.html">会话未读数</a></p></td>
<td>❌</td>
<td>✅</td>
</tr>
<tr>
<td>置顶会话</td>
<td>置顶会话</td>
<td><a href="https://docs-im-beta.easemob.com/document/android/conversation_pin.html">置顶会话</a></td>
<td><a href="https://doc.easemob.com/document/android/conversation_pin.html">置顶会话</a></td>
<td>✅</td>
<td>✅</td>
</tr>
<tr>
<td rowspan="2">删除会话</td>
<td>单向删除服务端会话及其历史消息</td>
<td><a href="https://docs-im-beta.easemob.com/document/android/conversation_delete.html#单向删除服务端会话及其历史消息">单向删除服务端会话及其历史消息</a></td>
<td><a href="https://doc.easemob.com/document/android/conversation_delete.html#单向删除服务端会话及其历史消息">单向删除服务端会话及其历史消息</a></td>
<td>✅</td>
<td>✅</td>
</tr>
<tr>
<td>删除本地会话及历史消息</td>
<td><a href="https://docs-im-beta.easemob.com/document/android/conversation_delete.html#删除本地会话及历史消息">删除本地会话及历史消息</a></td>
<td><a href="https://doc.easemob.com/document/android/conversation_delete.html#删除本地会话及历史消息">删除本地会话及历史消息</a></td>
<td>❌</td>
<td>✅</td>
</tr>
<tr>
<td>管理用户属性</td>
<td>设置和获取用户属性</td>
<td>用户属性指实时消息互动用户的信息，如用户昵称、头像、邮箱、电话、性别、签名、生日等</td>
<td><a href="https://docs-im-beta.easemob.com/document/android/userprofile.html">管理用户属性</a></td>
<td><a href="https://doc.easemob.com/document/android/userprofile.html">管理用户属性</a></td>
<td>❌</td>
<td>✅</td>
</tr>
Expand All @@ -191,7 +191,7 @@
<p>从服务器获取好友列表；</p>
<p>将用户添加到或移除黑名单</p>
<p>从服务器获取黑名单列表</p></td>
<td><a href="https://docs-im-beta.easemob.com/document/android/user_relationship.html">管理用户关系</a></td>
<td><a href="https://doc.easemob.com/document/android/user_relationship.html">管理用户关系</a></td>
<td>❌</td>
<td>✅</td>
</tr>
Expand All @@ -201,22 +201,22 @@
<td><p>创建、管理群组；</p>
<p>管理群成员；</p>
<p>管理群成员属性</p></td>
<td><a href="https://docs-im-beta.easemob.com/document/android/group_overview.html">群组管理</a></td>
<td><a href="https://doc.easemob.com/document/android/group_overview.html">群组管理</a></td>
<td>❌</td>
<td>✅</td>
</tr>
<tr>
<td rowspan="19">聊天室管理</td>
<td>聊天室为多人聊天，没有固定的成员关系。</td>
<td><p>聊天室概述</p></td>
<td><a href="https://docs-im-beta.easemob.com/document/android/room_overview.html">聊天室概述</a></td>
<td><a href="https://doc.easemob.com/document/android/room_overview.html">聊天室概述</a></td>
<td>&nbsp;</td>
<td>&nbsp;</td>
</tr>
<tr>
<td rowspan="6">创建和管理聊天室</td>
<td>创建聊天室</td>
<td rowspan="6"><a href="https://docs-im-beta.easemob.com/document/android/room_manage.html">创建和管理聊天室</a></td>
<td rowspan="6"><a href="https://doc.easemob.com/document/android/room_manage.html">创建和管理聊天室</a></td>
<td>❌</td>
<td>✅</td>
</tr>
Expand Down Expand Up @@ -248,7 +248,7 @@
<tr>
<td rowspan="7">管理聊天室成员</td>
<td>获取聊天室成员列表</td>
<td rowspan="7"><a href="https://docs-im-beta.easemob.com/document/android/room_members.html">管理聊天室成员</a></td>
<td rowspan="7"><a href="https://doc.easemob.com/document/android/room_members.html">管理聊天室成员</a></td>
<td>✅</td>
<td>✅</td>
</tr>
Expand Down Expand Up @@ -285,7 +285,7 @@
<tr>
<td rowspan="4">管理聊天室基本属性</td>
<td>获取聊天室公告</td>
<td rowspan="4"><a href="https://docs-im-beta.easemob.com/document/android/room_attributes.html">管理聊天室基本属性</a></td>
<td rowspan="4"><a href="https://doc.easemob.com/document/android/room_attributes.html">管理聊天室基本属性</a></td>
<td>✅</td>
<td>✅</td>
</tr>
Expand All @@ -307,15 +307,15 @@
<tr>
<td>管理聊天室自定义属性</td>
<td>管理聊天室自定义属性</td>
<td><a href="https://docs-im-beta.easemob.com/document/android/room_attributes.html#管理聊天室自定义属性-key-value">管理聊天室自定义属性</a></td>
<td><a href="https://doc.easemob.com/document/android/room_attributes.html#管理聊天室自定义属性-key-value">管理聊天室自定义属性</a></td>
<td>❌</td>
<td>✅</td>
</tr>
<tr>
<td rowspan="7">进阶功能</td>
<td>离线推送</td>
<td>集成第三方消息推送服务</td>
<td><a href="https://docs-im-beta.easemob.com/document/android/push.html">离线推送</a></td>
<td><a href="https://doc.easemob.com/document/android/push.html">离线推送</a></td>
<td>❌</td>
<td>✅</td>
</tr>
Expand All @@ -328,35 +328,35 @@
</tr>
<tr>
<td>多设备管理</td>
<td><a href="https://docs-im-beta.easemob.com/document/android/multi_device.html">多设备登录</a></td>
<td><a href="https://doc.easemob.com/document/android/multi_device.html">多设备登录</a></td>
<td>❌</td>
<td>✅</td>
</tr>
<tr>
<td>管理在线状态订阅</td>
<td>管理在线状态订阅</td>
<td><a href="https://docs-im-beta.easemob.com/document/android/presence.html">在线状态订阅</a></td>
<td><a href="https://doc.easemob.com/document/android/presence.html">在线状态订阅</a></td>
<td>❌</td>
<td>✅</td>
</tr>
<tr>
<td>消息表情回复&nbsp;Reaction</td>
<td>对单聊和群聊中的消息通过表情回复</td>
<td><a href="https://docs-im-beta.easemob.com/document/android/reaction.html">消息表情回复</a></td>
<td><a href="https://doc.easemob.com/document/android/reaction.html">消息表情回复</a></td>
<td>❌</td>
<td>✅</td>
</tr>
<tr>
<td>子区管理</td>
<td>子区是群组成员的子集</td>
<td><a href="https://docs-im-beta.easemob.com/document/android/thread.html">子区管理</a></td>
<td><a href="https://doc.easemob.com/document/android/thread.html">子区管理</a></td>
<td>❌</td>
<td>✅</td>
</tr>
<tr>
<td>消息举报</td>
<td>开发者可以在客户端调用该接口举报违规消息</td>
<td><a href="https://docs-im-beta.easemob.com/document/android/moderation.html">消息举报</a></td>
<td><a href="https://doc.easemob.com/document/android/moderation.html">消息举报</a></td>
<td>❌</td>
<td>✅</td>
</tr>
Expand Down
2 changes: 1 addition & 1 deletion docs/document/applet/apidoc.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

<Toc />

微信小程序的 IM 的 API 使用方法，与 Web Javascript 接入方式基本相同，可参照 [Web SDK API DOC](https://docs-im-beta.easemob.com/jsdoc/index.html)
微信小程序的 IM 的 API 使用方法，与 Web Javascript 接入方式基本相同，可参照 [Web SDK API DOC](https://doc.easemob.com/jsdoc/index.html)
2 changes: 1 addition & 1 deletion docs/document/applet/releasenote.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@

### 新增特性

- [IM SDK] 新增群组事件回调 [onGroupEvent](https://docs-im-beta.easemob.com/jsdoc/interfaces/Types.EventHandlerType.EventHandlerType.html#onGroupEvent) 和聊天室事件回调 [onChatroomEvent](https://docs-im-beta.easemob.com/jsdoc/interfaces/Types.EventHandlerType.EventHandlerType.html#onChatroomEvent)。原回调可继续使用；
- [IM SDK] 新增群组事件回调 [onGroupEvent](https://doc.easemob.com/jsdoc/interfaces/Types.EventHandlerType.EventHandlerType.html#onGroupEvent) 和聊天室事件回调 [onChatroomEvent](https://doc.easemob.com/jsdoc/interfaces/Types.EventHandlerType.EventHandlerType.html#onChatroomEvent)。原回调可继续使用；
- [IM SDK] 新增群聊消息限流错误码 [MESSAGE_CURRENT_LIMITING](/document/web/error.html)
- [IM SDK] 邀请加入群聊回调 `onGroupChange` 返回中新增 群名称 参数值。

Expand Down
2 changes: 1 addition & 1 deletion docs/document/electron/sdk_basic_function.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ log.Error("Error Test");
log.Error(5);
```

**注：**由于 EMChatConfig 对象创建时会指定日志输出路径，日志对象的创建一般放到 EMChatConfig 创建之后。
**注：** 由于 EMChatConfig 对象创建时会指定日志输出路径，日志对象的创建一般放到 EMChatConfig 创建之后。

Windows 桌面端日志生成在 c:/用户/{user}/AppData/Roaming/{ProcessName}/easemob-desktop/easemobLog 路径下的`easemob.log`，{user}为操作系统用户名，{ProcessName}为进程名称，热启动时为**electron**，安装后启动时为**IM-SDK桌面端Demo**。

Expand Down
Loading

0 comments on commit 9c4b5e8

Please sign in to comment.