Merge pull request #1041 from haoxiuwen/doc-v2

Modify IM Docs
easemob · Nov 20, 2024 · 322186b · 322186b
2 parents 2ab0e04 + 6adef7e
commit 322186b
Show file tree

Hide file tree

Showing 21 changed files with 41 additions and 46 deletions.
diff --git a/...t/chatuikit/android/message_longpress.png → ...chatuikit/android/message_longpress_1.png b/...t/chatuikit/android/message_longpress.png → ...chatuikit/android/message_longpress_1.png
diff --git a/docs/.vuepress/public/images/uikit/chatuikit/android/message_longpress_2.png b/docs/.vuepress/public/images/uikit/chatuikit/android/message_longpress_2.png
diff --git a/...uikit/chatuikit/android/message_types.png → ...kit/chatuikit/android/message_types_1.png b/...uikit/chatuikit/android/message_types.png → ...kit/chatuikit/android/message_types_1.png
diff --git a/docs/.vuepress/public/images/uikit/chatuikit/android/message_types_2.png b/docs/.vuepress/public/images/uikit/chatuikit/android/message_types_2.png
diff --git a/.../images/uikit/chatuikit/ios/configurationitem/chat/[email protected] b/.../images/uikit/chatuikit/ios/configurationitem/chat/[email protected]
diff --git a/.../images/uikit/chatuikit/ios/configurationitem/chat/[email protected] b/.../images/uikit/chatuikit/ios/configurationitem/chat/[email protected]
diff --git a/...images/uikit/chatuikit/ios/configurationitem/chat/[email protected] b/...images/uikit/chatuikit/ios/configurationitem/chat/[email protected]
diff --git a/...images/uikit/chatuikit/ios/configurationitem/chat/[email protected] b/...images/uikit/chatuikit/ios/configurationitem/chat/[email protected]
diff --git a/...uikit/chatuikit/ios/message_longpress.png → ...kit/chatuikit/ios/message_longpress_1.png b/...uikit/chatuikit/ios/message_longpress.png → ...kit/chatuikit/ios/message_longpress_1.png
diff --git a/docs/.vuepress/public/images/uikit/chatuikit/ios/message_longpress_2.png b/docs/.vuepress/public/images/uikit/chatuikit/ios/message_longpress_2.png
diff --git a/...ges/uikit/chatuikit/ios/message_types.png → ...s/uikit/chatuikit/ios/message_types_1.png b/...ges/uikit/chatuikit/ios/message_types.png → ...s/uikit/chatuikit/ios/message_types_1.png
diff --git a/docs/.vuepress/public/images/uikit/chatuikit/ios/message_types_2.png b/docs/.vuepress/public/images/uikit/chatuikit/ios/message_types_2.png
diff --git a/docs/document/server-side/account_system.md b/docs/document/server-side/account_system.md
@@ -952,7 +952,6 @@ POST https://{host}/{org_name}/{app_name}/users/{username}/deactivate
 
 | 参数            | 类型   | 是否必需 | 描述      |
 | :-------------- | :----- | :------- | :------------- |
-| `Content-Type`  | String | 是       | 内容类型。请填 `application/json`。                                                                                  |
 | `Accept`        | String | 是       | 内容类型。请填 `application/json`。                                                                                  |
 | `Authorization` | String | 是       | App 管理员的鉴权 token，格式为 `Bearer YourAppToken`，其中 `Bearer` 为固定字符，后面为英文空格和获取到的 app token。 |
 
@@ -977,7 +976,7 @@ POST https://{host}/{org_name}/{app_name}/users/{username}/deactivate
 ```shell
 # 将 <YourAppToken> 替换为你在服务端生成的 App Token
 
-curl -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'https://XXXX/XXXX/XXXX/users/user1/deactivate'
+curl -X POST -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'https://XXXX/XXXX/XXXX/users/user1/deactivate'
 ```
 
 ##### 响应示例
@@ -1031,7 +1030,6 @@ POST https://{host}/{org_name}/{app_name}/users/{username}/activate
 
 | 参数            | 类型   | 是否必需 | 描述         |
 | :-------------- | :----- | :------- | :--------------- |
-| `Content-Type`  | String | 是       | 内容类型。请填 `application/json`。                                                                                  |
 | `Accept`        | String | 是       | 内容类型。请填 `application/json`。                                                                                  |
 | `Authorization` | String | 是       | App 管理员的鉴权 token，格式为 `Bearer YourAppToken`，其中 `Bearer` 为固定字符，后面为英文空格和获取到的 app token。 |
 
@@ -1056,7 +1054,7 @@ POST https://{host}/{org_name}/{app_name}/users/{username}/activate
 ```shell
 # 将 <YourAppToken> 替换为你在服务端生成的 App Token
 
-curl -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'https://XXXX/XXXX/XXXX/users/user1/activate'
+curl -X POST -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToken>' 'https://XXXX/XXXX/XXXX/users/user1/activate'
 ```
 
 ##### 响应示例
@@ -1367,7 +1365,11 @@ POST https://{host}/{org_name}/{app_name}/users/batch/status
 ```shell
 # 将 <YourAppToken> 替换为你在服务端生成的 App Token
 
-curl -X POST https://XXXX/XXXX/chatdemoui/users/batch/status -H 'Authorization: Bearer <YourAppToken>' -H 'Content-Type: application/json' -d '{"usernames":["user1","user2"]}'
+curl -X POST https://XXXX/XXXX/chatdemoui/users/batch/status \
+-H 'Accept: application/json'  \
+-H 'Authorization: Bearer <YourAppToken>'  \
+-H 'Content-Type: application/json'  \
+-d '{"usernames":["user1","user2"]}'
 ```
 
 ##### 响应示例

diff --git a/docs/document/server-side/message_offline.md b/docs/document/server-side/message_offline.md
@@ -118,7 +118,7 @@ curl -X GET -H 'Accept: application/json' -H 'Authorization: Bearer <YourAppToke
 
 关于其他错误，你可以参考 [错误码](#错误码) 了解可能的原因。
 
-### 获取指定离线消息的投递状态
+## 获取指定离线消息的投递状态
 
 获取用户的指定离线消息的投递状态，即查看该消息是否已投递。
 

diff --git a/docs/uikit/chatuikit/android/chatuikit_overview.md b/docs/uikit/chatuikit/android/chatuikit_overview.md
@@ -61,8 +61,8 @@ Chat Fragment 提供所有聊天视图的容器。
 
 <ImageGallery :columns="3">
   <ImageItem src="/images/uikit/chatuikit/android/chat_detail.png" title="聊天页面" />
-  <ImageItem src="/images/uikit/chatuikit/android/message_types.png" title="发送多种类型的消息" />
-  <ImageItem src="/images/uikit/chatuikit/android/message_longpress.png" title="消息长按操作" />
+  <ImageItem src="/images/uikit/chatuikit/android/message_types_2.png" title="发送多种类型的消息" />
+  <ImageItem src="/images/uikit/chatuikit/android/message_longpress_2.png" title="消息长按操作" />
   <ImageItem src="/images/uikit/chatuikit/android/message_reply.png" title="消息引用" />
   <ImageItem src="/images/uikit/chatuikit/android/message_deliveryreceipt.png" title="已发送回执" />
   <ImageItem src="/images/uikit/chatuikit/android/message_readreceipt.png" title="已读回执" />

diff --git a/docs/uikit/chatuikit/flutter/chatuikit_chat.md b/docs/uikit/chatuikit/flutter/chatuikit_chat.md
@@ -195,8 +195,8 @@ ChatUIKitSettings.messageAttachmentMenuStyle = ChatUIKitMessageAttachmentMenuSty
 ```
 
 <ImageGallery>
-  <ImageItem src="/images/uikit/chatuikit/ios/configurationitem/chat/Appearance_chat_messageLongPressedActions.png" title="bottom-sheet" />
-  <ImageItem src="/images/uikit/chatuikit/ios/configurationitem/chat/msgmenu_style1_onlight@3x.png" title="context" />
+  <ImageItem src="/images/uikit/chatuikit/ios/message_types_1.png" title="BottomSheet" />
+  <ImageItem src="/images/uikit/chatuikit/ios/message_types_2.png" title="类似微信样式" />
 </ImageGallery>
 
 ### 自定义消息长按后显示的操作
@@ -214,8 +214,7 @@ ChatUIKitSettings.messageLongPressMenuStyle = ChatUIKitMessageLongPressMenuStyle
 ```
 
 <ImageGallery>
-  <ImageItem src="/images/uikit/chatuikit/ios/configurationitem/chat/attmsg_style2_onlight@3x.png" title="bottom-sheet" />
-  <ImageItem src="/images/uikit/chatuikit/ios/configurationitem/chat/attmsg_style1_onlight@3x.png" title="context" />
+  <ImageItem src="/images/uikit/chatuikit/ios/message_longpress_1.png" title="BottomSheet" />
+  <ImageItem src="/images/uikit/chatuikit/ios/message_longpress_2.png" title="类似微信样式" />
 </ImageGallery>
 
-
diff --git a/docs/uikit/chatuikit/flutter/chatuikit_overview.md b/docs/uikit/chatuikit/flutter/chatuikit_overview.md
@@ -211,8 +211,8 @@
 
 <ImageGallery :columns="3">
   <ImageItem src="/images/uikit/chatuikit/ios/chat_detail.png" title="聊天页面" />
-  <ImageItem src="/images/uikit/chatuikit/ios/message_types.png" title="发送多种类型的消息" />
-  <ImageItem src="/images/uikit/chatuikit/ios/message_longpress.png" title="消息长按操作" />
+  <ImageItem src="/images/uikit/chatuikit/ios/message_types_2.png" title="发送多种类型的消息" />
+  <ImageItem src="/images/uikit/chatuikit/ios/message_longpress_2.png" title="消息长按操作" />
   <ImageItem src="/images/uikit/chatuikit/ios/message_reply.png" title="消息引用" />
   <ImageItem src="/images/uikit/chatuikit/ios/message_deliveryreceipt.png" title="已发送回执" />
   <ImageItem src="/images/uikit/chatuikit/ios/message_readreceipt.png" title="已读回执" />

diff --git a/docs/uikit/chatuikit/ios/chatuikit_custom_chat.md b/docs/uikit/chatuikit/ios/chatuikit_custom_chat.md
@@ -91,27 +91,24 @@
 
 ### 设置附件消息
 
-#### 设置类似微信样式
+### 设置发送附件消息弹窗样式
 
-若实现发送附件消息时弹出类似微信样式的弹窗，可进行如下设置：
+1. 若实现发送附件消息时弹出类似微信样式的弹窗，可进行如下设置：
 
 ```Swift 
     Appearance.chat.messageAttachmentMenuStyle = .followInput
 ```
 
-效果图如下所示：
-
-![img](/images/uikit/chatuikit/ios/configurationitem/chat/[email protected])
-
-#### 设置仿系统 UIActionSheet 样式
-
-若实现消息长按后弹出仿系统 `UIActionSheet` 样式的弹窗，可进行如下设置：
+2. 若实现消息长按后弹出仿系统 `UIActionSheet` 样式的弹窗，可进行如下设置：
 
 ```Swift 
     Appearance.chat.messageAttachmentMenuStyle = .actionSheet
 ```
 
-![img](/images/uikit/chatuikit/ios/configurationitem/chat/[email protected])
+<ImageGallery>
+  <ImageItem src="/images/uikit/chatuikit/ios/message_types_1.png" title="UIActionSheet" />
+  <ImageItem src="/images/uikit/chatuikit/ios/message_types_2.png" title="类似微信样式" />
+</ImageGallery>
 
 #### 设置附件消息相关的配置项
 
@@ -183,31 +180,28 @@ override func filterMessageActions(message: MessageEntity) -> [ActionSheetItemPr
         }
 ```
 
-![img](/images/uikit/chatuikit/ios/configurationitem/chat/Appearance_chat_messageLongPressedActions.png)
-
-#### 设置类似微信样式
+<ImageGallery>
+  <ImageItem src="/images/uikit/chatuikit/ios/message_longpress_1.png" />
+</ImageGallery>
 
-若实现消息长按后弹出类似微信样式的弹窗，可进行如下设置：
+1. 若实现消息长按后弹出类似微信样式的弹窗，可进行如下设置：
 
 ```Swift 
     Appearance.chat.messageLongPressMenuStyle = .withArrow
 ```
 
-效果图如下所示：
-
-![img](/images/uikit/chatuikit/ios/configurationitem/chat/[email protected])
-
-#### 设置仿系统 UIActionSheet 样式
-
-若实现消息长按后弹出仿系统 `UIActionSheet` 样式的弹窗，可进行如下设置：
+2. 若实现消息长按后弹出仿系统 `UIActionSheet` 样式的弹窗，可进行如下设置：
 
 ```Swift 
     Appearance.chat.messageLongPressMenuStyle = .actionSheet
 ```
 
 效果图如下所示：
 
-![img](/images/uikit/chatuikit/ios/configurationitem/chat/[email protected])
+<ImageGallery>
+  <ImageItem src="/images/uikit/chatuikit/ios/message_longpress_1.png" title="UIActionSheet" />
+  <ImageItem src="/images/uikit/chatuikit/ios/message_longpress_2.png" title="类似微信样式" />
+</ImageGallery>
 
 ## 设置聊天页面输入框
 

diff --git a/docs/uikit/chatuikit/ios/chatuikit_overview.md b/docs/uikit/chatuikit/ios/chatuikit_overview.md
@@ -53,8 +53,8 @@ Chat 模块提供所有聊天视图的容器。
 
 <ImageGallery :columns="3">
   <ImageItem src="/images/uikit/chatuikit/ios/chat_detail.png" title="聊天页面" />
-  <ImageItem src="/images/uikit/chatuikit/ios/message_types.png" title="发送多种类型的消息" />
-  <ImageItem src="/images/uikit/chatuikit/ios/message_longpress.png" title="消息长按操作" />
+  <ImageItem src="/images/uikit/chatuikit/ios/message_types_2.png" title="发送多种类型的消息" />
+  <ImageItem src="/images/uikit/chatuikit/ios/message_longpress_2.png" title="消息长按操作" />
   <ImageItem src="/images/uikit/chatuikit/ios/message_reply.png" title="消息引用" />
   <ImageItem src="/images/uikit/chatuikit/ios/message_deliveryreceipt.png" title="已发送回执" />
   <ImageItem src="/images/uikit/chatuikit/ios/message_readreceipt.png" title="已读回执" />

diff --git a/docs/uikit/chatuikit/react-native/chatuikit_chat.md b/docs/uikit/chatuikit/react-native/chatuikit_chat.md
@@ -446,13 +446,13 @@ export function MyConversationDetailScreen(props: Props) {
 ```
 
 <ImageGallery>
-  <ImageItem src="/images/uikit/chatuikit/ios/configurationitem/chat/Appearance_chat_messageLongPressedActions.png" title="bottom-sheet" />
-  <ImageItem src="/images/uikit/chatuikit/ios/configurationitem/chat/msgmenu_style1_onlight@3x.png" title="context" />
+  <ImageItem src="/images/uikit/chatuikit/ios/message_longpress_1.png" title="bottom-sheet" />
+  <ImageItem src="/images/uikit/chatuikit/ios/message_longpress_2.png" title="context" />
 </ImageGallery>
 
 ### 自定义发送消息附件菜单样式
 
-`messageInputBarStyle` 支持两种模式: `bottom-sheet` 和 `extension`。`bottom-sheet` 模式通过页面组件底部弹出菜单， `context` 模式通过布局组件实现。
+`messageInputBarStyle` 支持两种模式: `bottom-sheet` 和 `extension`。`bottom-sheet` 模式通过页面组件底部弹出菜单， `extension` 模式通过布局组件实现。
 
 在全局通过设置属性 `Container.messageInputBarStyle` 属性决定菜单样式。
 
@@ -467,8 +467,8 @@ export function App() {
 ```
 
 <ImageGallery>
-  <ImageItem src="/images/uikit/chatuikit/ios/configurationitem/chat/attmsg_style2_onlight@3x.png" title="bottom-sheet" />
-  <ImageItem src="/images/uikit/chatuikit/ios/configurationitem/chat/attmsg_style1_onlight@3x.png" title="context" />
+  <ImageItem src="/images/uikit/chatuikit/ios/message_types_1.png" title="bottom-sheet" />
+  <ImageItem src="/images/uikit/chatuikit/ios/message_types_2.png" title="extension" />
 </ImageGallery>
 
 ### 事件通知

diff --git a/docs/uikit/chatuikit/react-native/chatuikit_overview.md b/docs/uikit/chatuikit/react-native/chatuikit_overview.md
@@ -94,8 +94,8 @@
 
 <ImageGallery :columns="3">
   <ImageItem src="/images/uikit/chatuikit/ios/chat_detail.png" title="聊天页面" />
-  <ImageItem src="/images/uikit/chatuikit/ios/message_types.png" title="发送多种类型的消息" />
-  <ImageItem src="/images/uikit/chatuikit/ios/message_longpress.png" title="消息长按操作" />
+  <ImageItem src="/images/uikit/chatuikit/ios/message_types_2.png" title="发送多种类型的消息" />
+  <ImageItem src="/images/uikit/chatuikit/ios/message_longpress_2.png" title="消息长按操作" />
   <ImageItem src="/images/uikit/chatuikit/ios/message_reply.png" title="消息引用" />
   <ImageItem src="/images/uikit/chatuikit/ios/message_deliveryreceipt.png" title="已发送回执" />
   <ImageItem src="/images/uikit/chatuikit/ios/message_readreceipt.png" title="已读回执" />