会话标记

大约 4 分钟

会话标记

某些情况下,你可能需要对会话添加标记,例如会话标星或将会话标为已读或未读。即时通讯云 IM 支持对单聊和群聊会话添加标记,最大支持 20 个标记,所以一个会话最多可添加 20 个标记。

如果要使用会话标记功能,你需要确保开通了会话列表服务并将 SDK 版本升级至 4.3.0 或以上版本。

你需要自行维护会话标记与具体业务含义(比如 EMMarkType0 为重要会话)之间的映射关系。例如:

NSDictionary* mapping = @{
        @(EMMarkType0): @"important",
        @(EMMarkType1): @"normal",
        @(EMMarkType2): @"unimportant",
        @(EMMarkType3): @"boys",
        @(EMMarkType4): @"girls",
    };

技术原理

环信即时通讯 IM 支持会话标记功能,主要方法如下:

  • EMChatManager#addConversationMark:completion:标记会话。
  • EMChatManager#removeConversationMark:completion:取消标记会话。
  • EMChatManager#getConversationsFromServerWithCursor:filter:completion:根据会话标记从服务器分页查询会话列表。
  • 根据会话标记从本地查询会话列表:调用 getAllConversations 方法获取本地所有会话后自己进行会话过滤。
  • 获取本地单个会话的所有标记:调用 getConversationWithConvId 方法获取本地单个会话,然后从会话的 marks 属性中查看该会话的所有标记。

前提条件

开始前,请确保满足以下条件:

实现方法

标记会话

你可以调用 addConversationMark 方法标记会话。每次最多可为 20 个会话添加标记。调用该方法会同时为本地和服务器端的会话添加标记。

添加会话标记后,若调用 getConversationsFromServerWithCursor:pageSize:completion 接口从服务器分页获取会话列表,返回的会话对象中包含会话标记,即 EMConversation#marks 字段。若你已经达到了服务端会话列表长度限制(默认 100 个会话),服务端会根据会话的活跃度删除不活跃会话,这些会话的会话标记也随之删除。

提示

对会话添加标记,例如会话标星,并不影响会话的其他逻辑,例如会话的未读消息数。

[EMClient.sharedClient.chatManager addConversationMark:@[@"conversationId1"] mark:EMMarkType0 completion:^(EMError * _Nullable aError) {
            
    }];

取消标记会话

你可以调用 removeConversationMark 方法删除会话标记。每次最多可移除 20 个会话的标记。

调用该方法会同时移除本地和服务器端会话的标记。

[EMClient.sharedClient.chatManager removeConversationMark:@[@"conversationId1"] mark:EMMarkType0 completion:^(EMError * _Nullable aError) {
            
    }];

根据会话标记从服务器分页查询会话列表

你可以调用 getConversationsFromServerWithCursor 方法根据会话标记从服务器分页获取会话列表。SDK 会按会话标记的时间的倒序返回会话列表,每个会话对象中包含会话 ID、会话类型、是否为置顶状态、置顶时间(对于未置顶的会话,值为 0)、会话标记以及最新一条消息。从服务端拉取会话列表后会更新本地会话列表。

//cursor:查询的开始位置。若传入空字符串,SDK 从最新标记操作的会话开始获取。
// filter:会话查询选项,包括会话标记和每页获取的会话条数(最多可获取 10 条)。
EMConversationFilter* filter = [[EMConversationFilter alloc] initWithMark:EMMarkType0 pageSize:10];
[EMClient.sharedClient.chatManager getConversationsFromServerWithCursor:@"" filter:filter completion:^(EMCursorResult<EMConversation *> * _Nullable result, EMError * _Nullable error) {
            
    }];

根据会话标记从本地查询会话列表

对于本地会话,你可以调用 getAllConversations 方法获取本地所有会话后自己进行会话过滤。下面以查询标记了 EMMarkType0 的所有本地会话为例。

//最终的查询结果全部放入 result 中。
NSMutableArray<EMConversation*>* result = [NSMutableArray array];
 NSArray<EMConversation*>* allConversations = [EMClient.sharedClient.chatManager getAllConversations];
for (EMConversation* conversation in allConversations) {
    if ([conversation.marks containsObject:@(EMMarkType0)]) {
          [result addObject:conversation];
    }
}

获取本地单个会话的所有标记

要获取本地单个会话的所有标记,你需要首先调用 getConversationWithConvId 方法获取本地单个会话,然后从会话的 marks 属性中查看该会话的所有标记,示例代码如下:

EMConversation* conversation = [EMClient.sharedClient.chatManager getConversationWithConvId:@"conversationId"];
    NSArray<NSNumber*>* marks = conversation.marks;