收发消息
本文介绍了如何从客户端发送超级群消息。超级群收发消息需要使用 RCCoreClient 下的方法。
前置条件
建议先阅读超级群概述和超级群私有频道概述，了解在 App 业务中如何使用频道和超级群频道功能特性。
- 通过服务端 API 创建超级群
- 通过服务端 API 创建频道，或使用默认频道 ID
RCDefault - 通过服务端 API 将发件人加入超级群
- 如不确定发件人是否在超级群中，请通过服务端 API 查询用户是否为群成员
- 如向超级群私有频道中发送消息，请确认已通过服务端 API 添加私有频道成员
当前频道聊天页面发送与接收消息，需要同时检查超级群 ID 和频道 ID。如果超级群 ID 和频道 ID 和当前频道聊天页面对应，才能在当前频道页面进行展示处理，否则就不处理。如果消息出现在其他聊天页面，一般是因为超级群 ID 或者频道 ID 发生错误。
构造消息对象
在发送消息前，需要构造 RCMessage 对象。消息的 conversationType 字段必须填写超级群业务的会话类型 ConversationType_ULTRAGROUP。消息的 targetId 字段表示超级群 ID，channelId 表示超级群频道 ID。
RCMessage 对象中可包含普通消息内容或媒体消息内容。普通消息内容指 RCMessageContent 的子类，例如文本消息（RCTextMessage）。
RCTextMessage *messageContent = [RCTextMessage messageWithContent:@"测试超级群消息"];
RCMessage *message = [[RCMessage alloc] initWithType:ConversationType_ULTRAGROUP targetId:@"超级群 id" channelId:@"频道 id" direction:MessageDirection_SEND content:messageContent];
媒体消息内容指 RCMediaMessageContent 的子类，例如图片消息（RCImageMessage）、GIF 消息（RCGIFMessage）等。
RCImageMessage *mediaMessageContent = [RCImageMessage messageWithImageURI:@"path/to/image"];
mediaMessageContent.full YES; // 图片消息支持设置以原图发送
RCMessage *message = [[RCMessage alloc] initWithType:ConversationType_ULTRAGROUP targetId:@"超级群 id" channelId:@"频道 id" direction:MessageDirection_SEND content:mediaMessageContent];
- 如果您的应用/环境在 2022.10.13 日及以后开通超级群服务，超级群业务中会包含一个 ID 为
RCDefault的默认频道。如果发消息时不指定频道 ID，则该消息会发送到RCDefault频道中。 - 如果您的应用/环境在 2022.10.13 日前已开通超级群服务，在发送消息时如果不指定频道 ID，则该消息不属于任何频道。融云支持客户调整服务至最新行为。该行为调整将影响客户端、服务端收发消息、获取会话、清除历史消息、禁言等多个功能。如有需要，请提交工单咨询详细方案。
发送普通消息
从 5.3.0 版本 RCCoreClient 开始，建议使用下方异步返回结果的接口，原同步接口同时废弃。
发送超级群普通消息需要使用 RCCoreClient 中的提供的 sendMessage 方法。
[[RCCoreClient sharedCoreClient]
sendMessage:message
pushContent:nil
pushData:nil
attached:^(RCMessage * _Nullable message) {
// 消息发出前已存入数据库的消息实体
}
success:^(RCMessage * _Nonnull successMessage) {
//成功
}
error:^(RCErrorCode nErrorCode, RCMessage * _Nonnull errorMessage) {
//失败
}];
sendMessage 中直接提供了用于控制推送通知内容（pushContent）和推送附加信息（pushData）的参数。不过，如果您需要更精细地控制离线推送通知，例如标题、内容、图标、或其他第三方厂商个性化配置，请使用消息推送属性进行配置，详见自定义消息推送通知。
- 如果发送的消息属于 SDK 内置消息类型，例如 RCTextMessage，这两个参数可设置为
nil。一旦消息触发离线推送通知时，融云服务端会使用各个内置消息类型默认的pushContent值。关于各类型消息的默认推送通知内容，详见用户内容类消息格式。 - 如果消息类型为自定义消息类型，且需要支持离线推送通知，则必须向融云提供
pushContent字段，否则用户无法收到离线推送通知。 - 如果消息类型为自定义消息类型，但不需要支持远程推送通知（例如通过自定义消息类型实现的 App 业务层操作指令），可将
pushContent字段留空。 RCMessage的推送属性配置MessagePushConfig的pushContent和pushData会覆盖此处配置，并提供更多配置能力，例如自定义推送通知的标题。详见自定义消息推送通知。
| 参数 | 类型 | 说明 |
|---|---|---|
| message | RCMessage | 要发送的消息体。必填属性包括会话类型（conversationType），会话 ID（targetId），消息内容（content）。详见消息介绍 中对 RCMessage 的结构说明。 |
| pushContent | NSString | 修改或指定远程消息推送通知栏显示的内容。您也可以在 RCMessage 的推送属性（RCMessagePushConfig）中配置，会覆盖此处配置，详见配置消息的推送属性。
|
| pushData | String | 远程推送附加信息。您也可以在 RCMessage 的推送属性（RCMessagePushConfig）中配置，会覆盖此处配置，详见配置消息的推送属性。 |
| attachedBlock | Block | 入库回调 |
| successBlock | Block | 消息发送成功回调 |
| errorBlock | Block | 消息发送失败回调 |
发送媒体消息
从 5.3.0 版本 RCCoreClient 开始，建议使用下方异步返回结果的接口，原同步接口同时废弃。
媒体消息 RCMessage 对象的 content 字段必须传入 RCMediaMessageContent 的子类对象，表示媒体消息内容。例如图片消息内容（RCImageMessage）、GIF 消息内容（RCGIFMessage），或继承自 RCMediaMessageContent 的自定义媒体消息内容。
图片消息内容（RCImageMessage）支持设置为发送原图。
RCImageMessage *mediaMessageContent = [RCImageMessage messageWithImageURI:@"path/to/image"];
mediaMessageContent.full YES; // 图片消息支持设置以原图发送
RCMessage *message = [[RCMessage alloc] initWithType:ConversationType_ULTRAGROUP
targetId:@"targetId"
channelId:@"channelId"
direction:MessageDirection_SEND
content:mediaMessageContent];
向超级群中发送媒体消息需要使用 sendMediaMessage 方法。SDK 会为图片、小视频等生成缩略图，根据默认压缩配置进行压缩，再将图片、小视频等媒体文件上传到融云默认的文件服务器（文件存储时长），上传成功之后再发送消息。图片消息如已设置为发送原图，则不会进行压缩。
[[RCCoreClient sharedCoreClient] sendMediaMessage:message
pushContent:nil
pushData:nil
attached:^(RCMessage * _Nullable message) {
// 消息发出前已存入数据库的消息实体
}
progress:^(int progress, RCMessage *progressMessage) {
//媒体上传进度
}
success:^(RCMessage *successMessage) {
//成功
}
error:^(RCErrorCode nErrorCode, RCMessage *errorMessage) {
//失败
}
cancel:^(RCMessage *cancelMessage) {
//取消
}];
sendMediaMessage 中直接提供了用于控制推送通知内容（pushContent）和推送附加信息（pushData）的参数。不过，如果您需要更精细地控制离线推送通知，例如标题、内容、图标、或其他第三方厂商个性化配置，请使用消息推送属性进行配置，详见自定义消息推送通知。
- 如果发送的消息属于 SDK 内置消息类型，例如 RCImageMessage，这两个参数可设置为
nil。一旦消息触发离线推送通知时，融云服务端会使用各个内置消息类型默认的pushContent值。关于各类型消息的默认推送通知内容，详见用户内容类消息格式。 - 如果消息类型为自定义消息类型，且需要支持离线推送通知，则必须向融云提供
pushContent字段，否则用户无法收到离线推送通知。 - 如果消息类型为自定义消息类型，但不需要支持远程推送通知（例如通过自定义消息类型实现的 App 业务层操作指令），可将
pushContent字段留空。 RCMessage的推送属性配置MessagePushConfig的pushContent和pushData会覆盖此处配置，并提供更多配置能力，例如自 定义推送通知的标题。详见自定义消息推送通知。
| 参数 | 类型 | 说明 |
|---|---|---|
| message | RCMessage | 要发送的消息体。必填属性包括会话类型（conversationType），会话 ID（targetId），消息内容（content）。详见消息介绍 中对 RCMessage 的结构说明。 |
| pushContent | NSString | 修改或指定远程消息推送通知栏显示的内容。您也可以在 RCMessage 的推送属性（RCMessagePushConfig）中配置，会覆盖此处配置，详见配置消息的推送属性。
|
| pushData | String | 远程推送附加信息。您也可以在 RCMessage 的推送属性（RCMessagePushConfig）中配置，会覆盖此处配置，详见配置消息的推送属性。 |
| attachedBlock | Block | 入库回调 |
| progressBlock | Block | 发送进度的回调 |
| successBlock | Block | 消息发送成功回调 |
| errorBlock | Block | 消息发送失败回调 |
| cancel | Block | 取消发送的回调 |
接收消息
消息接收监听的设置在 RCCoreClient 中
设置监听
- (void)addReceiveMessageDelegate:(id<RCIMClientReceiveMessageDelegate>)delegate
实现监听代理方法
- (void)onReceived:(RCMessage *)message left:(int)nLeft object:(id)object
如何发送 @ 消息
@消息在融云即时通讯服务中不属于一种预定义的消息类型（详见服务端文档 消息类型概述）。融云通过在消息中携带 mentionedInfo 数据，帮助 App 实现提及他人（@）功能。
消息的 RCMessageContent 中的 RCMentionedInfo 字段存储了携带所 @ 人员的信息。无论是 SDK 内置消息类型，或者您自定义的消息类型，都直接或间接继承了 RCMessageContent 类。
融云支持在向群组和超级群中发消息时，在消息内容中添加 mentionedInfo。消息发送前，您可以构造 MentionedInfo，并设置到消息的 RCMessageContent 中。
RCTextMessage *messageContent = [RCTextMessage messageWithContent:@"Test"];
messageContent.mentionedInfo = [[RCMentionedInfo alloc] initWithMentionedType:RC_Mentioned_Users userIdList:mentionedUserIdList mentionedContent:nil];
MentionedInfo 参数：
| 参数 | 类型 | 说明 |
|---|---|---|
| type | RCMentionedType | （必填）指定 MentionedInfo 的类型。RC_Mentioned_All 表示需要提及（@）所有人。RC_Mentioned_Users 表示需要 @ 部分人，被提及的人员需要在 userIdList 中指定。 |
| userIdList | NSArray | 被提及（@）用户的 ID 集合。当 type 为 MentionedType.PART 时必填。 |
| mentionedContent | NSString | 触发离线消息推送时，通知栏显示的内容。如果是 nil，则显示默认提示内容（“有人 @ 你”）。@消息携带的 mentionedContent 优先级最高，会覆盖所有默认或自定义的 pushContent 数据。 |
IMLib SDK 接收消息后，您需要处理 @ 消息中的数据。您可以在获取 RCMessage(消息对象)后获取到消息对象携带的 RCMentionedInfo 对象。
为消息禁用推送通 知
在接收者未上线时，融云服务端默认触发推送服务，将消息通过推送通道下发（服务端是否触发推送也会收到应用级别、用户级别免打扰设置的影响）。
有时 App 用户可能希望在发送消息时就指定该条消息不需要触发推送，该需求可通过 RCMessage 对象的 MessageConfig 配置实现。
以下示例中，我们将 messageConfig 的 disableNotification 设置为 YES 禁用该条消息的推送通知。接收方再次上线时需要主动拉取。
RCTextMessage *txtMsg = [RCTextMessage messageWithContent:@"测试文本消息"];
RCMessage *message = [[RCMessage alloc]
initWithType:ConversationType_ULTRAGROUP
targetId:@"targetId"
channelId:@"targetId"
direction:MessageDirection_SEND
content:txtMsg];
message.messageConfig.disableNotification = YES;
自定义消息推送通知
您可以在发送消息时提供 RCMessagePushConfig 配置，对单条消息的推送行为进行个性化配置。例如：
- 自定义推送标题、推送通知内容
- 自定义通知栏图标
- 添加远程推送附加信息
- 越过接收客户端的配置，强制在推送通知内显示通知内容
- 其他 APNs 或 Android 推送通道支持的个性化配置
关于 RCMessagePushConfig 的配置方式详见配置消息的推送属性。
如何处理消息发送失败
对于客户端本地会存储的消息类型（参见消息类型概述），如果触发（attached）回调，表示此时该消息已存入本地数据库，并已进入本地消息列表。
- 如果入库失败，您可以检查参数是否合法，设备存储是否可正常写入。
- 如果入库成功，但消息发送失败（
error），App 可以在 UI 临时展示这条发送失败的消息，并缓存error抛出的RCMessage实例，在合适的时机重新调用sendMessage/sendMediaMessage发送。请注意，如果不复用该消息实例，而是重发相同内容的新消息，本地消息列表中会存储内容重复的两条消息。
对于客户端本地不存储的消息，如果发送失败（error），App 可缓存消息实例再重试发送，或直接新建消息实例进行发送。