接收消息

大约 6 分钟

接收消息

环信即时通讯 IM iOS SDK 通过 EMChatManagerDelegate 类实现文本、图片、音频、视频和文件等类型的消息的接收。

前提条件

开始前，请确保满足以下条件：

接收文本消息

  • 你可以用注册监听 EMChatManagerDelegate 接收消息。该 EMChatManagerDelegate 可以多次添加，请记得在不需要的时候移除 Delegate，如在 ViewController dealloc() 时。
  • 在新消息到来时，你会收到 messagesDidReceive 的回调，消息接收时可能是一条，也可能是多条。你可以在该回调里遍历消息队列，解析并显示收到的消息。若在初始化时打开了 EMOptions#includeSendMessageInMessageListener 开关，则该回调中会返回发送成功的消息。
  • 对于聊天室消息，你可以通过消息的 EMChatMessage#broadcast 属性判断该消息是否为 通过 REST API 发送的聊天室全局广播消息。
// 添加代理。
[[EMClient sharedClient].chatManager addDelegate:self delegateQueue:nil];

// 收到消息回调。

- (void)messagesDidReceive:(NSArray *)aMessages
  {
  // 收到消息，遍历消息列表。
  for (EMChatMessage *message in aMessages) {
    // 消息解析和展示。
  }
  }

// 移除代理。

- (void)dealloc
  {
  [[EMClient sharedClient].chatManager removeDelegate:self];
  }

接收附件消息

除文本消息外，SDK 还支持接收附件类型消息，包括语音、图片、视频和文件消息。

附件消息的接收过程如下：

  1. 接收附件消息。SDK 自动下载语音消息，默认自动下载图片和视频的缩略图。若下载原图、视频和文件，需调用 downloadAttachment 方法。
  2. 获取附件的服务器地址和本地路径。

自 ISO SDK 4.14.0 版本开始，支持消息附件下载鉴权功能。该功能默认关闭，如要开通需联系环信商务。该功能开通后，用户必须调用 SDK 的 API downloadMessageAttachment 下载消息附件。

接收语音消息

  1. 接收方收到语音消息时，自动下载语音文件。

  2. 接收方收到 messagesDidReceive 回调，调用 remotePath 或 localPath 方法获取语音文件的服务器地址或本地路径，从而获取语音文件。

EMVoiceMessageBody *voiceBody = (EMVoiceMessageBody *)message.body;
// 获取语音文件在服务器的地址。
NSString *voiceRemotePath = voiceBody.remotePath;
// 本地语音文件的资源路径。
NSString *voiceLocalPath = voiceBody.localPath;

接收图片消息

  1. 接收方收到图片消息，自动下载图片缩略图。
  • 默认情况下，SDK 自动下载缩略图，即 [EMClient sharedClient].options.isAutoDownloadThumbnail; 为 YES。
  • 若设置为手动下载缩略图，即 [EMClient sharedClient].options.isAutoDownloadThumbnail(NO);，需调用 [[EMClient sharedClient].chatManager downloadMessageThumbnail:message progress:nil completion:nil]; 下载。
  1. 接收方收到 messagesDidReceive 回调，调用 downloadMessageAttachment 下载原图。

下载完成后，在回调里调用相应消息 body 的 thumbnailLocalPath 获取缩略图路径。

EMImageMessageBody *imageBody = (EMImageMessageBody *)message.body;
// 图片文件的本地缩略图资源路径。
NSString *thumbnailLocalPath = imageBody.thumbnailLocalPath;
  1. 获取图片消息的附件。
[[EMClient sharedClient].chatManager downloadMessageAttachment:message progress:nil completion:^(EMChatMessage *message, EMError *error) {
            if (!error) {
                EMImageMessageBody *imageBody = (EMImageMessageBody *)message.body;
                NSString *localPath = imageBody.localPath;
            }
        }];

接收 GIF 图片消息

自 iOS SDK 4.14.0 开始，支持接收 GIF 图片消息。

图片缩略图的下载与普通图片消息相同，详见 接收图片消息。

与普通消息相同，接收 GIF 图片消息时，接收方会收到 messagesDidReceive 回调方法。接收方判断为图片消息后，读取消息体的 isGif 属性，若值是 YES， 则为 GIF 图片消息。

- (void)messagesDidReceive:(NSArray<EMChatMessage*> *)aMessages
{
  // 收到消息，遍历消息列表。
  for (EMChatMessage *message in aMessages) {
    // 消息解析和展示。
    if (message.body.type == EMMessageBodyTypeImage) {
        EMImageMessageBody *body = (EMImageMessageBody *)message.body;
        if (body.isGif) {
            // 是 GIF 图片消息
        }
      }
   }
}

接收视频消息

  1. 接收方收到视频消息时，自动下载视频缩略图。你可以设置自动或手动下载视频缩略图，该设置与图片缩略图相同，详见设置图片缩略图自动下载。
  2. 接收方收到 messagesDidReceive 回调，可以调用 downloadMessageAttachment 方法下载视频原文件。
  3. 获取视频缩略图和视频原文件。
// 发送成功后，获取视频消息缩略图及附件。
EMVideoMessageBody *body = (EMVideoMessageBody *)message.body;
// 从服务器端获取视频文件的地址。
NSString *remotePath = body.remotePath;
// 从服务器端获取视频缩略图。
NSString *thumbnailPath = body.thumbnailRemotePath;
// 从本地获取视频文件。
NSString *localPath = body.localPath;
// 从本地获取视频缩略图。
NSString *thumbnailLocalPath = body.thumbnailLocalPath;

接收文件消息

  1. 接收方收到 messagesDidReceive 回调，调用 downloadMessageAttachment 方法下载文件。
[[EMClient sharedClient].chatManager downloadMessageAttachment:message progress:nil completion:^(EMChatMessage *message, EMError *error) {
            if (!error) {
                // 附件下载成功
            }
        }];
  1. 调用以下方法从服务器或本地获取文件附件：
EMFileMessageBody *body = (EMFileMessageBody *)message.body;
// 从服务器端获取文件路径。
NSString *remotePath = body.remotePath;
// 从本地获取文件路径。
NSString *localPath = body.localPath;

接收位置消息

接收位置消息与文本消息一致，详见接收文本消息。

接收方接收到位置消息时，需要将该位置的经纬度，借由第三方的地图服务，将位置在地图上显示出来。

接收透传消息

可将透传消息理解为一条指令，通过发送这条指令给对方，通知对方要执行的操作，收到消息可以自定义处理。

具体功能可以根据自身业务需求自定义，例如实现头像、昵称的更新等。另外，以 em_ 和 easemob:: 开头的 action 为内部保留字段，注意不要使用。

透传消息适用于更新头像、更新昵称等场景。

提示

  • 透传消息发送后，不支持撤回。
  • 透传消息不会存入本地数据库中，所以在 UI 上不会显示。

接收方通过 cmdMessagesDidReceive 回调接收透传消息，方便用户进行不同的处理。

// 收到透传消息。
- (void)cmdMessagesDidReceive:(NSArray *)aCmdMessages{
  for (EMChatMessage *message in aCmdMessages) {
        EMCmdMessageBody *body = (EMCmdMessageBody *)message.body;
        // 进行透传消息 body 解析。
    }
  }

接收自定义类型消息

除了几种消息之外，你可以自己定义消息类型，方便业务处理，即首先设置一个消息类型名称，然后可添加多种自定义消息。

接收自定义消息与其他类型消息一致，详见 接收文本消息。

接收合并消息

为了方便消息互动，即时通讯 IM 自 4.1.0 版本开始支持将多个消息合并在一起进行转发。

接收合并消息与接收普通消息的操作相同，详见 接收消息。

  • 对于不支持合并转发消息的 SDK 版本，该类消息会被解析为文本消息，消息内容为 compatibleText 携带的内容，其他字段会被忽略。
  • 合并消息实际上是一种附件消息。收到合并消息后，你可以调用 downloadAndParseCombineMessage 方法下载合并消息附件并解析出原始消息列表。
  • 对于一条合并消息，首次调用该方法会下载和解析合并消息附件，然后返回原始消息列表，而后续调用会存在以下情况：
    • 若附件已存在，该方法会直接解析附件并返回原始消息列表。
    • 若附件不存在，该方法首先下载附件，然后解析附件并返回原始消息列表。
- (void)messagesDidReceive:(NSArray<EMChatMessage *> *)aMessages
{

    for (EMChatMessage* msg in aMessages) {
        if (msg.body.type == EMMessageBodyTypeCombine) {
            // 合并消息类型，解析合并消息
            [EMClient.sharedClient.chatManager downloadAndParseCombineMessage:msg completion:^(NSArray<EMChatMessage *> * _Nullable messages, EMError * _Nullable error) {

            }];
        }
    }
}
环信 IM 文档 Version: 1.0.0 ©️环信