Skip to content

Commit

Permalink
Merge pull request #1099 from haoxiuwen/doc-v2
Browse files Browse the repository at this point in the history
Modify Document Format
  • Loading branch information
haoxiuwen authored Dec 19, 2024
2 parents 6ee357f + 2124cbf commit ea7ffbd
Show file tree
Hide file tree
Showing 6 changed files with 31 additions and 31 deletions.
8 changes: 5 additions & 3 deletions docs/document/android/message_send_receive.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,8 @@ EMClient.getInstance().chatManager().sendMessage(message);

2. 接收方收到图片消息,自动下载图片缩略图。

SDK 默认自动下载缩略图,即 `EMClient.getInstance().getOptions().setAutoDownloadThumbnail(true)`。若设置为手动下载缩略图,即 `EMClient.getInstance().getOptions().setAutoDownloadThumbnail(false)`,需调用 `EMClient.getInstance().chatManager().downloadThumbnail(message)` 下载。
- 默认情况下,SDK 自动下载缩略图,即 `EMClient.getInstance().getOptions().setAutoDownloadThumbnail(true)`
- 若设置为手动下载缩略图,即 `EMClient.getInstance().getOptions().setAutoDownloadThumbnail(false)`,需调用 `EMClient.getInstance().chatManager().downloadThumbnail(message)` 下载。

3. 接收方收到 `onMessageReceived` 回调,调用 `downloadAttachment` 下载原图。

Expand Down Expand Up @@ -269,9 +270,10 @@ EMClient.getInstance().chatManager().sendMessage(message);

3. 接收方收到视频消息时,自动下载视频缩略图。

SDK 默认自动下载缩略图,即 `EMClient.getInstance().getOptions().setAutoDownloadThumbnail(true)`。若设置为手动下载缩略图,即 `EMClient.getInstance().getOptions().setAutoDownloadThumbnail(false)`,需调用 `EMClient.getInstance().chatManager().downloadThumbnail(message)` 下载。
- 默认情况下,SDK 自动下载缩略图,即 `EMClient.getInstance().getOptions().setAutoDownloadThumbnail(true)`
- 若设置为手动下载缩略图,即 `EMClient.getInstance().getOptions().setAutoDownloadThumbnail(false)`,需调用 `EMClient.getInstance().chatManager().downloadThumbnail(message)` 下载。

4. 接收方收到 `onMessageReceived` 回调,可以调用 `EMClient.getInstance().chatManager().downloadAttachment(message)` 方法下载视频原文件。
1. 接收方收到 `onMessageReceived` 回调,可以调用 `EMClient.getInstance().chatManager().downloadAttachment(message)` 方法下载视频原文件。

```Java
/**
Expand Down
2 changes: 0 additions & 2 deletions docs/document/flutter/message_send_receive.md
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,6 @@ if(msg.body.type == MessageType.VOICE) {

1. 发送方调用 `EMMessage#createImageSendMessage` 方法传入接收方的用户 ID(群聊或聊天室分别为群组 ID 或聊天室 ID)和图片文件的 filePath,创建图片消息,然后调用 `sendMessage` 方法发送该消息。SDK 会将图片上传至环信服务器,服务器自动生成图片缩略图。


```dart
final imgMsg = EMMessage.createImageSendMessage(
targetId: targetId,
Expand Down Expand Up @@ -286,7 +285,6 @@ body.thumbnailRemotePath;

2. 发送方调用 `EMMessage#createVideoSendMessage` 方法传入接收方的用户 ID(群聊或聊天室分别为群组 ID 或聊天室 ID),图片文件的 filePath、创建视频消息,然后调用 `sendMessage` 方法发送消息。SDK 会将视频文件上传至消息服务器。若需要视频缩略图,你需自行获取视频首帧的路径,将该路径传入 `createVideoSendMessage` 方法。


```dart
final videoMsg = EMMessage.createVideoSendMessage(
Expand Down
6 changes: 4 additions & 2 deletions docs/document/harmonyos/message_send_receive.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,8 @@ ChatClient.getInstance().chatManager()?.sendMessage(message);

2. 接收方收到图片消息,自动下载图片缩略图。

SDK 默认自动下载缩略图,即 `ChatOptions.setAutoDownloadThumbnail` 设置为 `true`。若设置为手动下载缩略图,即 `ChatOptions.setAutoDownloadThumbnail` 设置为 `false` ,需调用 `ChatClient.getInstance().chatManager()?.downloadThumbnail(message)` 下载。
- 默认情况下,SDK 自动下载缩略图,即 `ChatOptions.setAutoDownloadThumbnail` 设置为 `true`
- 若设置为手动下载缩略图,即 `ChatOptions.setAutoDownloadThumbnail` 设置为 `false` ,需调用 `ChatClient.getInstance().chatManager()?.downloadThumbnail(message)` 下载。

3. 接收方收到 `onMessageReceived` 回调,调用 `downloadAttachment` 下载原图。

Expand Down Expand Up @@ -262,7 +263,8 @@ ChatClient.getInstance().chatManager()?.sendMessage(message);

3. 接收方收到视频消息时,自动下载视频缩略图。

SDK 默认自动下载缩略图,即 `ChatOptions.setAutoDownloadThumbnail` 设置为 `true` 。若设置为手动下载缩略图,即 `ChatOptions.setAutoDownloadThumbnail` 设置为 `false`,需调用 `ChatClient.getInstance().chatManager()?.downloadThumbnail(message)` 下载。
- 默认情况下,SDK 自动下载缩略图,即 `ChatOptions.setAutoDownloadThumbnail` 设置为 `true`
- 若设置为手动下载缩略图,即 `ChatOptions.setAutoDownloadThumbnail` 设置为 `false`,需调用 `ChatClient.getInstance().chatManager()?.downloadThumbnail(message)` 下载。

4. 接收方收到 `onMessageReceived` 回调,可以调用 `ChatClient.getInstance().chatManager()?.downloadAttachment(message)` 方法下载视频原文件。

Expand Down
6 changes: 4 additions & 2 deletions docs/document/ios/message_send_receive.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,8 @@ NSString *thumbnailLocalPath = body.thumbnailLocalPath;

2. 接收方收到图片消息,自动下载图片缩略图。

SDK 默认自动下载缩略图,即 `[EMClient sharedClient].options.isAutoDownloadThumbnail;``YES`。若设置为手动下载缩略图,即 `[EMClient sharedClient].options.isAutoDownloadThumbnail(NO);`,需调用 `[[EMClient sharedClient].chatManager downloadMessageThumbnail:message progress:nil completion:nil];` 下载。
- 默认情况下,SDK 自动下载缩略图,即 `[EMClient sharedClient].options.isAutoDownloadThumbnail;``YES`
- 若设置为手动下载缩略图,即 `[EMClient sharedClient].options.isAutoDownloadThumbnail(NO);`,需调用 `[[EMClient sharedClient].chatManager downloadMessageThumbnail:message progress:nil completion:nil];` 下载。

3. 接收方收到 `messagesDidReceive` 回调,调用 `downloadMessageAttachment` 下载原图。

Expand Down Expand Up @@ -238,7 +239,8 @@ message.chatType = EMChatTypeGroupChat;

3. 接收方收到视频消息时,自动下载视频缩略图。

SDK 默认自动下载缩略图,即 `[EMClient sharedClient].options.isAutoDownloadThumbnail;``YES`。若设置为手动下载缩略图,即 `[EMClient sharedClient].options.isAutoDownloadThumbnail(NO);`,需调用 `[[EMClient sharedClient].chatManager downloadMessageThumbnail:message progress:nil completion:nil];` 下载。
- 默认情况下,SDK 自动下载缩略图,即 `[EMClient sharedClient].options.isAutoDownloadThumbnail;``YES`
- 若设置为手动下载缩略图,即 `[EMClient sharedClient].options.isAutoDownloadThumbnail(NO);`,需调用 `[[EMClient sharedClient].chatManager downloadMessageThumbnail:message progress:nil completion:nil];` 下载。

4. 接收方收到 `messagesDidReceive` 回调,可以调用 `downloadMessageAttachment` 方法下载视频原文件。

Expand Down
20 changes: 9 additions & 11 deletions docs/document/unity/message_send_receive.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ SDKClient.Instance.ChatManager.RemoveChatManagerDelegate(adelegate);

### 发送和接收附件消息

除文本消息外,还有几种其他类型的消息,其中语音,图片,短视频,文件等消息,是通过先将附件上传到消息服务器的方式实现。收到语音时,会自动下载,而图片和视频会自动下载缩略图。文件消息不会自动下载附件,接收方需调用下载附件的 API,具体实现参考下文。
除文本消息外,还有几种其他类型的消息,其中语音,图片,视频,文件等消息,是通过先将附件上传到消息服务器的方式实现。收到语音时,会自动下载,而图片和视频会自动下载缩略图。文件消息不会自动下载附件,接收方需调用下载附件的 API,具体实现参考下文。

#### 发送和接收语音消息

Expand Down Expand Up @@ -225,13 +225,13 @@ else {

接收方如果设置了自动下载,即 `Options.IsAutoDownload``true`,SDK 接收到消息后会下载缩略图;如果未设置自动下载,需主动调用 `SDKClient.Instance.ChatManager.DownloadThumbnail` 下载。

下载完成后,调用相应消息 `msg.Body``ThumbnailLocalPath` 去获取缩略图路径
下载完成后,调用相应消息 `msg.Body``ThumbnailLocalPath` 获取缩略图路径

#### 发送和接收短视频消息
#### 发送和接收视频消息

发送短视频消息时,应用层需要完成视频文件的选取或者录制。视频消息支持给出视频的时长作为参数,发送给接收方。
发送视频消息时,应用层需要完成视频文件的选取或者录制。视频消息支持给出视频的时长作为参数,发送给接收方。

参考如下示例代码,创建并发送短视频消息
参考如下示例代码,创建并发送视频消息

```C#
Message msg = Message.CreateVideoSendMessage(toChatUsername, localPath, displayName, thumbnailLocalPath, fileSize, duration, width, height);
Expand All @@ -251,13 +251,11 @@ SDKClient.Instance.ChatManager.SendMessage(ref msg, new CallBack(
));
```

默认情况下,当收件人收到短视频消息时,SDK 会下载视频消息的缩略图。
默认情况下,当收件人收到视频消息时,SDK 会下载视频消息的缩略图。

如果不希望 SDK 自动下载视频缩略图,可以将 `Options.IsAutoDownload` 设置为 `false`
如果不希望 SDK 自动下载视频缩略图,可以将 `Options.IsAutoDownload` 设置为 `false`这种情况下,需主动调用 `SDKClient.Instance.ChatManager.DownloadThumbnail` 下载。下载完成后,使用相应消息 `Body``ThumbnailLocalPath` 成员获取缩略图路径。

如果未设置自动下载,需主动调用 `SDKClient.Instance.ChatManager.DownloadThumbnail` 下载。下载完成后,使用相应消息 `Body``ThumbnailLocalPath` 成员获取缩略图路径。

短视频文件本身需要通过 `SDKClient.Instance.ChatManager.DownloadAttachment` 下载,下载完成后,使用相应消息 `Body``LocalPath` 成员获取短视频文件路径。
视频文件本身需要通过 `SDKClient.Instance.ChatManager.DownloadAttachment` 下载,下载完成后,使用相应消息 `Body``LocalPath` 成员获取视频文件路径。

```C#
// 接收到视频消息需先下载附件才能打开。
Expand All @@ -270,7 +268,7 @@ SDKClient.Instance.ChatManager.DownloadAttachment("Message ID", new CallBack(
{
if (msg.Body.Type == ChatSDK.MessageBodyType.VIDEO) {
ChatSDK.MessageBody.VideoBody vb = (ChatSDK.MessageBody.VideoBody)msg.Body;
//从本地获取短视频文件路径
//从本地获取视频文件路径
string videoLocalUri = vb.LocalPath;
//这里可以根据本地路径打开文件。
}
Expand Down
20 changes: 9 additions & 11 deletions docs/document/windows/message_send_receive.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ SDKClient.Instance.ChatManager.RemoveChatManagerDelegate(adelegate);

### 发送和接收附件消息

除文本消息外,还有几种其他类型的消息,其中语音,图片,短视频,文件等消息,是通过先将附件上传到消息服务器的方式实现。收到语音时,会自动下载,而图片和视频会自动下载缩略图。文件消息不会自动下载附件,接收方需调用下载附件的 API,具体实现参考下文。
除文本消息外,还有几种其他类型的消息,其中语音,图片,视频,文件等消息,是通过先将附件上传到消息服务器的方式实现。收到语音时,会自动下载,而图片和视频会自动下载缩略图。文件消息不会自动下载附件,接收方需调用下载附件的 API,具体实现参考下文。

#### 发送和接收语音消息

Expand Down Expand Up @@ -227,13 +227,13 @@ else {

接收方如果设置了自动下载,即 `Options.IsAutoDownload``true`,SDK 接收到消息后会下载缩略图;如果未设置自动下载,需主动调用 `SDKClient.Instance.ChatManager.DownloadThumbnail` 下载。

下载完成后,调用相应消息 `msg.Body``ThumbnailLocalPath` 去获取缩略图路径
下载完成后,调用相应消息 `msg.Body``ThumbnailLocalPath` 获取缩略图路径

#### 发送和接收短视频消息
#### 发送和接收视频消息

发送短视频消息时,应用层需要完成视频文件的选取或者录制。视频消息支持给出视频的时长作为参数,发送给接收方。
发送视频消息时,应用层需要完成视频文件的选取或者录制。视频消息支持给出视频的时长作为参数,发送给接收方。

参考如下示例代码,创建并发送短视频消息
参考如下示例代码,创建并发送视频消息

```C#
Message msg = Message.CreateVideoSendMessage(toChatUsername, localPath, displayName, thumbnailLocalPath, fileSize, duration, width, height);
Expand All @@ -253,13 +253,11 @@ SDKClient.Instance.ChatManager.SendMessage(ref msg, new CallBack(
));
```

默认情况下,当收件人收到短视频消息时,SDK 会下载视频消息的缩略图。
默认情况下,当收件人收到视频消息时,SDK 会下载视频消息的缩略图。

如果不希望 SDK 自动下载视频缩略图,可以将 `Options.IsAutoDownload` 设置为 `false`
如果不希望 SDK 自动下载视频缩略图,可以将 `Options.IsAutoDownload` 设置为 `false`这种情况下,需主动调用 `SDKClient.Instance.ChatManager.DownloadThumbnail` 下载。下载完成后,使用相应消息 `Body``ThumbnailLocalPath` 成员获取缩略图路径。

如果未设置自动下载,需主动调用 `SDKClient.Instance.ChatManager.DownloadThumbnail` 下载。下载完成后,使用相应消息 `Body``ThumbnailLocalPath` 成员获取缩略图路径。

短视频文件本身需要通过 `SDKClient.Instance.ChatManager.DownloadAttachment` 下载,下载完成后,使用相应消息 `Body``LocalPath` 成员获取短视频文件路径。
视频文件本身需要通过 `SDKClient.Instance.ChatManager.DownloadAttachment` 下载,下载完成后,使用相应消息 `Body``LocalPath` 成员获取视频文件路径。

```C#
// 接收到视频消息需先下载附件才能打开。
Expand All @@ -272,7 +270,7 @@ SDKClient.Instance.ChatManager.DownloadAttachment("Message ID", new CallBack(
{
if (msg.Body.Type == ChatSDK.MessageBodyType.VIDEO) {
ChatSDK.MessageBody.VideoBody vb = (ChatSDK.MessageBody.VideoBody)msg.Body;
//从本地获取短视频文件路径
//从本地获取视频文件路径
string videoLocalUri = vb.LocalPath;
//这里可以根据本地路径打开文件。
}
Expand Down

0 comments on commit ea7ffbd

Please sign in to comment.