ZIM SDK 支持单聊消息、群组消息、房间消息等的收发,以及查询历史消息、删除消息等功能。可广泛应用于娱乐社交、电商购物、在线教育、互动直播等多种场景下。
本文档介绍了如何使用 ZIM SDK 的接口,实现各类消息的收发功能与监听消息的状态。
目前 ZIM 支持的消息类型如下:
消息类型 | 说明 | 特性及适用场景 |
---|---|---|
ZIMTextMessage(1) |
文本消息。消息大小不超过 32 KB,单个客户端发送频率限制为 10 次/秒。 |
消息可靠有序,可存储为历史消息(保存时间请参考 计费说明 - 版本说明 中“历史消息存储天数”。);一般适用于“单聊”、“群聊”等即时聊天的场景和“房间聊天”的公屏聊天场景。房间解散后,“房间聊天”的消息不存储。
相关接口:sendMessage |
ZIMCommandMessage(2) |
开发者可自定义数据内容的信令消息。消息大小不超过 5 KB,单个客户端发送频率限制为 10 次/秒。 |
支持更高的并发;一般适用于“语聊房”、“在线课堂”等房间内的信令传输,比如上下麦操作、送礼物,发送在线课堂课件等。
相关接口:sendMessage |
ZIMBarrageMessage(20) |
房间内弹幕文本消息。消息大小不超过 5 KB,单个客户端发送频率无限制。 |
专门用于房间内的高频、不可靠、允许丢掉的消息,一般适用于发送“弹幕消息”的场景中。 支持高并发,但不可靠,不保证消息送达。 相关接口:sendMessage |
ZIMImageMessage(11) |
图片消息。支持主流图片格式,包括 JPG、PNG、BMP、TIFF、GIF、WebP,大小不超过 10 MB,单个客户端发送频率限制为 10 次/秒。 |
消息可靠有序,可存储为历史消息(保存时间请参考 计费说明 - 版本说明 中“历史消息存储天数”。);一般用于单聊、房间、群聊等即时聊天场景。
相关接口: sendMediaMessage |
ZIMFileMessage(12) |
文件消息。消息内容为文件,格式不限,大小不超过 100 MB,单个客户端发送频率限制为 10 次/秒。 |
|
ZIMAudioMessage(13) |
语音消息。支持 MP3、M4A 格式的语音文件,时长不超过 300 秒,大小不超过 6 MB,单个客户端发送频率限制为 10 次/秒。 |
|
ZIMVideoMessage(14) |
视频消息。支持 MP4、MOV 格式的视频文件,大小不超过 100 MB,单个客户端发送频率限制为 10 次/秒。仅支持视频编码格式为 H264 和 H265 的视频文件在消息发送成功后获取该视频首帧的宽、高信息。 |
|
ZIMCombineMessage(100) |
合并消息,消息大小无限制,单个客户端发送频率限制为 10 次/秒。 |
消息可靠有序,可存储为历史消息(保存时间请参考 计费说明 - 版本说明 中“历史消息存储天数”。);一般用于单聊、房间、群聊等即时聊天场景。
相关接口:sendMessage |
ZIMCustomMessage(200) |
自定义消息。开发者可自定义消息的类型,并自行完成消息的解析,ZIM SDK 不负责定义和解析自定义消息的具体内容。 |
一般可用于发送投票类型、接龙类型、视频卡片类型等消息。
相关接口: sendMessage |
在实现“收发消息”功能之前,请确保:
普通消息,包含 ZIMTextMessage、ZIMBarrageMessage 等消息类型。
type
(具体请参考 ZIMMessageType)字段,判断消息类型是 Text 还是 Command,然后强转基类为具体的子类(ZIMTextMessage 或 ZIMCommandMessage),然后从 “message” 字段获取消息内容。以客户端 A 向客户端 B 发送消息为例:
converversationType
为 ZIMConversationTypePeer
发送一条单聊消息到客户端 B。目前 ZIM 不支持调用 sendMessage
接口,向自己发送消息(即 toConversationID = 自己的 ID)。如果尝试向自己发送消息,会返回错误 6000001,并提示传入参数错误。
- (void)sendMessage:(ZIMMessage *)message
toConversationID:(NSString *)toConversationID
conversationType:(ZIMConversationType)conversationType
config:(ZIMMessageSendConfig *)config
notification:(nullable ZIMMessageSendNotification *)notification
callback:(ZIMMessageSentCallback)callback;
参数 | 类型 | 是否必填 | 说明 |
---|---|---|---|
message | ZIMMessage * | 是 | 发送的消息内容。 |
toConversationID | NSString * | 是 | 会话 ID。
|
conversationType | ZIMConversationType | 是 | 会话类型。
|
config | ZIMMessageSendConfig * | 是 | 发送消息的高级属性配置,包含如下配置:
|
notification | ZIMMessageSendNotification | 是 | 发送通知的回调:onMessageAttached,在消息发送前,可以获得一个临时的 ZIMMessage,以便您添加一些业务处理逻辑。 |
callback | ZIMMessageSentCallback | 是 | 发送消息操作的结果回调。 |
// 1、创建 ZIM 对象,传入 appID、appSign
ZIMAppConfig *appConfig = [[ZIMAppConfig alloc] init];
appConfig.appID = (unsigned int)appID; //替换为您申请到的 AppID
appConfig.appSign = @"appSign"; //替换为您申请到的 AppSign
self.zim = [ZIM createWithAppConfig: appConfig];
// 2、设置 setEventHandler 回调
[self.zim setEventHandler:self];
// 3、登录
ZIMUserInfo *userInfo = [[ZIMUserInfo alloc] init];
userInfo.userID = @"xxxx";
userInfo.userName = @"xxxx";
[self.zim loginWithUserInfo:userInfo callback:^(ZIMError * _Nonnull errorInfo){
// 开发者可根据 ZIMError 来判断是否登录成功。
}];
NSString *toConversationID = @"xxxx1";
ZIMTextMessage *textMessage = [[ZIMTextMessage alloc] init];
textMessage.message = @"消息内容";
ZIMMessageSendConfig *config = [[ZIMMessageSendConfig alloc] init];
// 设置消息优先级
config.priority = ZIMMessagePriorityLow;
// 设置消息的离线推送配置。若使用该功能,需要先开通离线推送服务
ZIMPushConfig *pushConfig = [[ZIMPushConfig alloc] init];
pushConfig.title = @"离线推送的标题";
pushConfig.content= @"离线推送的内容";
pushConfig.extendedData = @"离线推送的扩展信息";
config.pushConfig = pushConfig
ZIMMessageSendNotification *notification = [[ZIMMessageSendNotification alloc] init];
notification.onMessageAttached = ^(ZIMMessage * _Nonnull message) {
// 发送前的回调,客户可以在这里获取一个临时对象,该对象与开发者创建的 zimMessage 对象属于同一对象,开发者可利用此特性做一些业务逻辑,如提前展示 UI 等
};
// 4、设置会话类型,选择其一向对应的会话类型发送消息
// 发送单聊信息
ZIMConversationType type = ZIMConversationTypePeer;
// 发送群聊信息
ZIMConversationType type = ZIMConversationTypeGroup;
// 发送房间信息
ZIMConversationType type = ZIMConversationTypeRoom;
// 5、发送消息
[self.zim sendMessage:textMessage toConversationID:toConversationID conversationType:type config:config notification:notification callback:^((ZIMMessage * _Nonnull message, ZIMError * _Nonnull errorInfo)) {
// 开发者可以通过该回调监听消息是否发送成功。
}];
//注册 ZIMEventHander 回调
[zim setEventHandler:self];
// 收到单聊消息的回调
- (void)zim:(ZIM *)zim
receivePeerMessage:(NSArray<ZIMMessage *> *)messageList
fromUserID:(NSString *)fromUserID{
// 在此编写收到消息后的业务逻辑
}
// 收到群组消息的回调
- (void)zim:(ZIM *)zim
receiveGroupMessage:(NSArray<ZIMMessage *> *)messageList
fromGroupID:(NSString *)fromGroupID{
// 在此编写收到消息后的业务逻辑
}
// 收到房间消息的回调
- (void)zim:(ZIM *)zim
receiveRoomMessage:(NSArray<ZIMMessage *> *)messageList
fromRoomID:(NSString *)fromRoomID{
// 在此编写收到消息后的业务逻辑
}
ZIM SDK 支持发送多种类型的富媒体消息,包含图片、文件、音频、视频等消息类型,开发者可以通过以下步骤实现富媒体文件消息的收发。
用户登录成功后,调用 sendMediaMessage 接口,指定会话、消息类型(图片、文件、音频、视频)、会话类型(单聊、房间、群组)、以及相关消息配置,向指定会话发送富媒体消息。
UTF-8
编码格式。- (void)sendMediaMessage:(ZIMMediaMessage *)message
toConversationID:(NSString *)toConversationID
conversationType:(ZIMConversationType)conversationType
config:(ZIMMessageSendConfig *)config
notification:(nullable ZIMMediaMessageSendNotification *)notification
callback:(ZIMMessageSentCallback)callback;
参数 | 类型 | 是否必填 | 说明 |
---|---|---|---|
message | ZIMMediaMessage * | 是 | 发送的富媒体消息内容。使用时,请根据多媒体消息类型,修改 message 的类型。例如,发送图片消息时,请使用 ZIMImageMessage。 |
toConversationID | NSString * | 是 | 会话 ID。
|
conversationType | ZIMConversationType | 是 | 会话类型。
|
config | ZIMMessageSendConfig * | 是 | 发送消息的高级属性配置,包含如下配置:
|
notification | ZIMMediaMessageSendNotification | 是 | 发送通知的回调:
|
callback | ZIMMessageSentCallback | 是 | 发送消息操作的结果回调。 |
// 发送多媒体消息示例 - 单聊 发送图片消息
ZIMImageMessage *imgMsg = [[ZIMImageMessage alloc] init];
//需填入 UTF-8 格式的本地路径(建议填写 app 本地图片的路径)
//此处以一个相册图片临时路径为例
imgMsg.fileLocalPath = @"/private/var/mobile/Containers/Data/Application/C142EFE6-9DEC-449D-89B7-BF99F2578F98/tmp/D1513E30-2641-440B-B897-48CD43BE1D04.jpeg";
//如果此处填入了网络 URL, SDK 会透传该路径,而不会经过 ZIM 后台服务处理, 同时填入网络 URL 与本地路径,SDK 会优先任务用户想要使用网路 URL
imgMsg.fileDownloadUrl = @"";
ZIMMessageSendConfig *sendConfig = [[ZIMMessageSendConfig alloc] init];
sendConfig.priority = 1;
ZIMMediaMessageSendNotification *notification = [[ZIMMediaMessageSendNotification alloc] init];
notification.onMessageAttached = ^(ZIMMessage * _Nonnull message) {
// 开发者可以监听这个回调执行消息发送前的业务逻辑
};
notification.onMediaUploadingProgress = ^(ZIMMediaMessage * _Nonnull message, unsigned long long currentFileSize, unsigned long long totalFileSize) {
// 开发者可以监听这个回调获取多媒体上传的进度
};
[[ZIM getInstance] sendMediaMessage:imgMsg toConversationID:@"conversationID" conversationType:ZIMConversationTypePeer config:sendConfig notification:notification callback:^(ZIMMessage * _Nonnull message, ZIMError * _Nonnull errorInfo) {
}];
// 发送多媒体消息示例 - 单聊 发送音频消息
//需填入 UTF-8 格式的本地路径(建议填写 app 本地音频的路径),音频时间(单位秒)
//此处以一个本地音频文件路径为例
ZIMAudioMessage audioMessage = [[ZIMAudioMessage alloc] initWithFileLocalPath:@"/private/var/mobile/Containers/Shared/AppGroup/D5144D14-3FE8-4C6C-8527-01F368B8E49E/File Provider Storage/IMG_0131.mp3" audioDuration:10];
//如果此处填入了网络 URL, SDK 会透传该路径,而不会经过 ZIM 后台服务处理, 同时填入网络 URL 与本地路径,SDK 会优先任务用户想要使用网路 URL
audioMessage.fileDownloadUrl = @"";
ZIMMessageSendConfig *sendConfig = [[ZIMMessageSendConfig alloc] init];
sendConfig.priority = ZIMMessagePriorityHigh;
ZIMMediaMessageSendNotification *notification = [[ZIMMediaMessageSendNotification alloc] init];
notification.onMessageAttached = ^(ZIMMessage * _Nonnull message) {
// 开发者可以监听这个回调执行消息发送前的业务逻辑
};
notification.onMediaUploadingProgress = ^(ZIMMediaMessage * _Nonnull message, unsigned long long currentFileSize, unsigned long long totalFileSize) {
// 开发者可以监听这个回调获取多媒体上传的进度
};
[[ZIM getInstance] sendMediaMessage:audioMessage toConversationID:@"conversationID" conversationType:ZIMConversationTypePeer config:sendConfig notification:notification callback:^(ZIMMessage * _Nonnull message, ZIMError * _Nonnull errorInfo) {
}];
// 发送多媒体消息示例 - 单聊 发送视频消息
ZIMVideoMessage *videoMessage = [[ZIMVideoMessage alloc] init];
//需填入 UTF-8 格式的本地路径
//此处以一个本地视频路径为例
videoMessage.fileLocalPath = @"/var/mobile/Containers/Data/Application/C142EFE6-9DEC-449D-89B7-BF99F2578F98/Documents/22-08-31-10:23:49.mp4";
//如果此处填入了网络 URL, SDK 会透传该路径,而不会经过 ZIM 后台服务处理, 同时填入网络 URL 与本地路径,SDK 会优先任务用户想要使用网路 URL
videoMessage.fileDownloadUrl = @"";
ZIMMessageSendConfig *sendConfig = [[ZIMMessageSendConfig alloc] init];
sendConfig.priority = ZIMMessagePriorityHigh;
ZIMMediaMessageSendNotification *notification = [[ZIMMediaMessageSendNotification alloc] init];
notification.onMessageAttached = ^(ZIMMessage * _Nonnull message) {
// 开发者可以监听这个回调执行消息发送前的业务逻辑
};
notification.onMediaUploadingProgress = ^(ZIMMediaMessage * _Nonnull message, unsigned long long currentFileSize, unsigned long long totalFileSize) {
// 开发者可以监听这个回调获取多媒体上传的进度
};
[[ZIM getInstance] sendMediaMessage:videoMessage toConversationID:@"conversationID" conversationType:ZIMConversationTypePeer config:sendConfig notification:notification callback:^(ZIMMessage * _Nonnull message, ZIMError * _Nonnull errorInfo) {
}];
// 发送多媒体消息示例 - 单聊 发送文件消息
ZIMFileMessage *fileMsg = [[ZIMFileMessage alloc] init];
//需填入 UTF-8 格式的本地路径
//此处以文件选择器选中的某个文件地址为例
fileMsg.fileLocalPath = @"/private/var/mobile/Containers/Shared/AppGroup/D5144D14-3FE8-4C6C-8527-01F368B8E49E/File Provider Storage/IMG_0131.HEIC";
//如果此处填入了网络 URL, SDK 会透传该路径,而不会经过 ZIM 后台服务处理, 同时填入网络 URL 与本地路径,SDK 会优先任务用户想要使用网路 URL
fileMsg.fileDownloadUrl = @"";
ZIMMessageSendConfig *sendConfig = [[ZIMMessageSendConfig alloc] init];
sendConfig.priority = ZIMMessagePriorityHigh;
ZIMMediaMessageSendNotification *notification = [[ZIMMediaMessageSendNotification alloc] init];
notification.onMessageAttached = ^(ZIMMessage * _Nonnull message) {
// 开发者可以监听这个回调执行消息发送前的业务逻辑
};
notification.onMediaUploadingProgress = ^(ZIMMediaMessage * _Nonnull message, unsigned long long currentFileSize, unsigned long long totalFileSize) {
// 开发者可以监听这个回调获取多媒体上传的进度
};
[[ZIM getInstance] sendMediaMessage:fileMsg toConversationID:@"conversationID" conversationType:ZIMConversationTypePeer config:sendConfig notification:notification callback:^(ZIMMessage * _Nonnull message, ZIMError * _Nonnull errorInfo) {
}];
开发者可以通过 ZIMMediaMessageSendNotification 中的 onMediaUploadingProgress
回调,接收富媒体消息的上传发送进度的相关通知。
typedef void (^ZIMMediaUploadingProgress)(ZIMMessage *message, unsigned long long currentFileSize, unsigned long long totalFileSize);
其中:
接收方用户登录成功后,根据会话类型(单聊、房间、群组)的相关回调监听(receivePeerMessage、receiveRoomMessage、receiveGroupMessage),接收富媒体消息的相关通知,然后可以调用 downloadMediaFileWithMessage 接口,下载富媒体消息文件到本地。
下载富媒体消息时,需要指定对应的媒体消息的文件类型。
- (void)downloadMediaFileWithMessage:(ZIMMediaMessage *)message
fileType:(ZIMMediaFileType)fileType
progress:(ZIMMediaDownloadingProgress)progress
callback:(ZIMMediaDownloadedCallback)callback;
参数 | 类型 | 是否必填 | 说明 |
---|---|---|---|
message | ZIMMediaMessage * | 是 | 接收到的富媒体文件消息内容。 |
fileType | ZIMMediaFileType | 是 | 接收富媒体消息的文件类型。
|
progress | ZIMMediaDownloadingProgress | 是 | 下载消息进度。 |
callback | ZIMMediaDownloadedCallback | 是 | 下载消息操作的结果回调。 |
// 接收多媒体消息示例 - 单聊 接收图片消息
- (void)receivePeerMessage:(NSArray<ZIMMessage *> *)messageList
fromUserID:(NSString *)fromUserID{
for (ZIMMessage *msg in reverseMsgList) {
// 收到消息时,可通过消息的 Type 进行判断接收到何种类型的消息
switch (msg.type) {
case ZIMMessageTypeImage:{
ZIMImageMessage *imageMsg = (ZIMImageMessage *)msg;
[[ZIM getInstance] downloadMediaFileWithMessage:imageMsg fileType:ZIMMediaFileTypeOriginalFile progress:^(ZIMMessage * _Nonnull message, unsigned long long currentFileSize, unsigned long long totalFileSize) {
} callback:^(ZIMMessage * _Nonnull message, ZIMError * _Nonnull errorInfo) {
}];
break;
}
case ZIMMessageTypeVideo:{
ZIMVideoMessage *videoMsg = (ZIMVideoMessage *)msg;
break;
}
case ZIMMessageTypeAudio:{
ZIMAudioMessage *audioMsg = (ZIMAudioMessage *)msg;
break;
}
case ZIMMessageTypeFile:{
ZIMFileMessage *fileMsg = (ZIMFileMessage *)msg;
break;
}
default:
break;
}
}
}
开发者可以通过 ZIMMediaDownloadingProgress 回调,接收富媒体消息的下载进度的相关通知。
typedef void (^ZIMMediaDownloadingProgress)(ZIMMessage *message, unsigned long long currentFileSize, unsigned long long totalFileSize);
其中:
ZIM SDK 支持开发者实现信令类型的消息收发,开发者可以通过 ZIMCommandMessage 对象定义自己的消息类型,例如位置消息等。
信令消息不支持离线推送和本地存储。
以下以向指定用户发送信令消息为例。
//向指定用户发送信令消息
NSData *anyData = [[NSData alloc] init];
NSString *toUserID = @"toUserID";
ZIMCommandMessage * cmdMsg = [[ZIMCommandMessage alloc] initWithMessage:anyData];
ZIMMessageSendConfig *sendConfig = [[ZIMMessageSendConfig alloc] init];
sendConfig.priority = ZIMMessagePriorityMedium;
[self.zim sendMessage:cmdMsg toUserID:toUserID conversationType:type config:config notification:notification callback:^((ZIMMessage * _Nonnull message, ZIMError * _Nonnull errorInfo)) {
// 开发者可以通过该回调监听消息是否发送成功。
}];
//用户接收信令消息
- (void)zim:(ZIM *)zim receivePeerMessage:(NSArray<ZIMMessage *> *)messageList fromUserID:(NSString *)fromUserID {
if (zim != self.zim) {
return;
}
for (ZIMMessage *msg in messageList) {
if(msg.type == ZIMMessageTypeCommand){
ZIMCommandMessage *cmdMsg = (ZIMCommandMessage *)msg;
NSData *receivedData = cmdMsg.message;
}
}
}
ZIM SDK 支持开发者实现自定义类型的消息收发,开发者可以通过 ZIMCustomMessage 对象自行定义消息类型,例如投票类型、接龙类型、视频卡片类型等。开发者可以通过以下步骤实现自定义消息的收发。
发送自定义消息使用的接口为 sendMessage,与发送普通消息所用接口相同,开发者可参考 收发普通消息 - 发送消息 了解此接口参数详情。
开发者需要通过 ZIMCustomMessage 对象定义自定义类型消息,包括以下参数:
参数 | 类型 | 是否必填 | 说明 |
---|---|---|---|
message | NSString * | 是 | 自定义消息的文本内容,开发者可传入一串特定格式的字符串,如 Json,以定制消息内容。 |
subType | int | 是 | 具体的自定义类型。值由您定义,取值范围为 [0,200]。消息接收端会根据不同的类型显示不同的样式。 |
searchedContent | NSString * | 否 | 自定义消息的检索字段。由于无法通过直接搜索 message 字段来搜索自定义消息,您可把该自定义消息中希望被搜索的内容(如投票的标题等)拼接后放到此参数(长度上线默认为 64 字节),以便后续搜索。 |
以下为用户在单聊会话中发送自定义消息的示例代码:
// 向指定用户发送自定义消息
NSString *message = @"message";
NSString *toUserID = @"toUserID";
ZIMCustomMessage * customMessage = [[ZIMCustomMessage alloc] init];
customMessage.message = message;
customMessage.subType = 1; // 开发者自定义的类型
customMessage.searchContent="";
ZIMMessageSendConfig *sendConfig = [[ZIMMessageSendConfig alloc] init];
sendConfig.priority = ZIMMessagePriorityMedium;
[self.zim sendMessage:customMessage toUserID:toUserID conversationType: ZIMConversationTypePeer config:config notification:notification callback:^((ZIMMessage * _Nonnull message, ZIMError * _Nonnull errorInfo)) {
// 开发者可以通过该回调监听消息是否发送成功。
}];
接收自定义消息的回调接口与接收普通消息的回调接口一致,请参考 收发普通消息 - 接收消息 了解具体接口。
以下为用户在单聊会话中接收自定义消息的示例代码:
// 用户在单聊会话中接收自定义消息
- (void)zim:(ZIM *)zim receivePeerMessage:(NSArray<ZIMMessage *> *)messageList fromUserID:(NSString *)fromUserID {
if (zim != self.zim) {
return;
}
for (ZIMMessage *msg in messageList) {
if(msg.type == ZIMCustomMessage){
// 这里表示接收到自定义消息
}
}
}
@ 消息,是指包含“@ + 用户”内容的消息。被 @ 的用户在收到消息时会强提醒。
@ 消息不属于消息类型。一条消息既可以是文本消息或其他类型消息,同时也是 @ 消息。
在调用 sendMessage 发送消息时,可以通过以下 ZIMMessage 参数(可同时使用)将一条消息设置为 @ 信息:
仅 2.14.0 及以上版本的 ZIM SDK 支持发送消息中带 @ 信息。
// 以下为用户在单聊会话中发送 @ 消息的示例代码:
// 创建提醒用户列表
NSMutableArray<NSString *> *mentionArrayList = [[NSMutableArray alloc] init];
// 添加提醒用户(用户可以不在当前会话)
[mentionArrayList addObject:@"userId1"];
[mentionArrayList addObject:@"userId2"];
// message 可以为任何类型消息
// 调用接口提醒列表中用户查看消息
[message mentionedUserIDs:mentionArrayList];
// 提醒会话内所有其他用户查看消息
BOOL isMentionAll = YES;
[message isMentionAll:isMentionAll];
ZIMMessageSendConfig *config = [[ZIMMessageSendConfig alloc] init];
// 是否强推送给被提醒用户(不管对方是否开启了会话免打扰),默认为 NO;
config.isNotifyMentionedUsers = YES;
// 以发送单聊信息为例
ZIMConversationType type = ZIMConversationTypePeer;
[zim sendMessage:message convId:@"conv_id" type:type config:config callback:^(ZIMMessage *zimMessage, ZIMError *error) {
if (error) {
// 开发者可以通过该回调监听消息是否发送成功。
}
}];
接收 @ 消息的回调接口与接收普通消息的回调接口一致,请参考 收发普通消息 - 接收消息 了解具体接口。
收到消息后,开发者可根据业务逻辑实现对应的功能,如高亮等。
当会话内用户被提醒后,可以被动或主动获取 mentionedInfoList。
mentionedInfoList,包含 @ 消息的对应消息 ID,发送者 userID,以及 @ 消息的类型 ZIMMessageMentionedType,开发者可用于实现标记会话等多样业务逻辑。
在用户被提醒时,会收到 conversationChanged 回调,即可获取当前 ZIMConversation 的最新 mentionedInfoList。
- (void)zim:(ZIM *)zim
conversationChanged:(NSArray<ZIMConversationChangeInfo *> *)conversationChangeInfoList {
// conversationChangeInfoList 可拿到收到提醒的会话里面的 mentionInfoList
}
如用 queryConversationListWithConfig 或者 queryConversation 主动拉取会话,也可获取会话里面的mentionedInfoList,可参考以下示例代码:
NSArray<ZIMMessageMentionedInfo *> * mentionedInfoList = conversation.mentionedInfoList;
接收 @ 消息后,用户需要清除会话的 mentionedInfoList,才能不再被提醒。
清除会话的 mentionedInfoList 接口与清除会话消息未读数接口相同:
会话内所有用户都可以通过 ZIMMessage 的 mentionedUserIDs 参数获取具体提醒用户列表,可此接口仅能返回 @ 消息发送用户通过 ZIMMessage 的 MentionedUserIDs 参数传入的用户列表。
NSArray<NSString *> *userIds = message.mentionedUserIDs;
会话内所有用户都可以通过 ZIMMessage 的 isMentionAll 参数,确认消息是否为全员提醒消息。
BOOL isMentionAll = message.isMentionAll;
ZIM 支持您通过服务端向 App 所有在线用户发送消息,目标用户通过客户端接收相关消息。
请查看服务单 API 文档 全员推送 文档,实现从服务端向所有用户发送消息。
通过 broadcastMessageReceived 回调,即可接收全员推送消息。
示例代码:
// 用户接收全员推送消息
- (void)zim:(ZIM *)zim broadcastMessageReceived:(ZIMMessage *)message {
// 接收到全员推送消息
}
ZIM SDK 支持实现以下两种形式的消息转发:
具体实现流程,请参考 转发消息。
ZIM SDK 支持用户在会话内的操作转换为 Tips 消息。当相关操作出现后,ZIM SDK 会向会话发送一条 Tips 消息进行通知,详情请参考 接收 Tips 消息。
在一些弱网场景中,可能存在以下场景,即消息发送成功,但由于某些因素(如网络丢包),导致 ZIM SDK 未收到服务端应答。此时,ZIM SDK 会因应答超时而认为消息发送失败,但实际上消息发送成功,导致消息状态混乱。为解决该问题,明确消息最终状态, 2.6.0 或以上版本 SDK 支持开发者监听 messageSentStatusChanged 回调,接收消息的状态变化。消息的状态有三种,即 Sending、Success 和 Failed。根据消息状态的变化,开发者可判断消息发送是否成功,并在业务上做相应处理。
// 监听消息状态
- (void)zim:(ZIM *)zim messageSentStatusChanged:
(NSArray<ZIMMessageSentStatusChangeInfo *> *)messageSentStatusChangeInfoList {
// 开发者可在这里监听消息状态的改变
}
联系我们
文档反馈