删除消息

针对单聊会话、群聊会话、系统会话，您可以通过 IMLib SDK 删除自己的历史消息，支持仅从本地数据库删除消息、仅从融云服务端删除自己的历史消息、或同时删除本地数据库以及融云服务端自己的历史消息。

IMLib SDK 的删除消息操作（下表中的 API）均指从当前登录操作的用户的历史消息记录中删除一条或一组消息，不影响会话中其他用户的历史消息记录。

功能	本地/服务端	API
仅从本地删除指定消息（根据消息 messageId）	仅从本地删除	deleteMessages
仅从本地删除会话全部历史消息	仅从本地删除	deleteMessages
删除会话内指定消息（根据消息对象）	同时从本地和服务端删除消息	deleteRemoteMessage
删除会话历史消息（根据时间戳）	可选仅本地删除、或者同时从本地和服务端删除消息	clearHistoryMessages
仅从服务端删除会话历史消息（根据时间戳）	仅从服务端删除	clearRemoteHistoryMessages

提示

• App 用户的单聊会话、群聊会话、系统会话的消息默认仅存储在本地数据库中，仅支持从本地删除。如果 App（App Key/环境）已开通单群聊消息云端存储，该用户的消息还会保存在融云服务端（默认 6 个月），可从远端历史消息记录中删除消息。
• 针对单聊会话、群聊会话、系统会话，如果通过任何接口以传入时间戳的方式删除远端消息，服务端默认不会删除对应的离线消息补偿（该机制仅会在打开多设备消息同步开关后生效）。此时如果换设备登录或卸载重装，仍会因为消息补偿机制获取到已被删除的历史消息。如需彻底删除消息补偿，请提交工单，申请开通删除服务端历史消息时同时删除多端补偿的离线消息。如果以传入消息对象的方式删除远端消息，则服务端一定会删除消息补偿中的对应消息。
• 针对单聊会话、群聊会话、系统会话，如果 App 的管理员或者某普通用户希望在所有会话参与者的历史记录中彻底删除一条消息，应使用撤回消息功能。消息成功撤回后，原始消息内容会在所有用户的本地与服务端历史消息记录中删除。
• IMLib SDK 不提供删除聊天室消息的接口。当前用户的聊天室本地消息在退出聊天室时会被自动删除。开通聊天室消息云端存储服务后，如需清除全部用户的聊天室远端历史消息，可使用服务端 API 清除消息。
• IMlib SDK 提供删除超级群会话远端历史消息的 API，详见超级群管理下的删除消息。

仅从本地删除指定消息（消息 messageId）

您可以按消息的 messageId 删除存储在本地数据库内的消息。

如果您已经开通单群聊历史消息云存储服务，服务端保存的操作删除消息用户的历史消息记录不受影响。如果该用户从服务端获取历史消息，可能会获取到在本地已删除的消息。 接口调用时，需要传入删除消息的 messageId 数组。

接口原型

Objective C

- (void)deleteMessages:(NSArray<NSNumber *> *)messageIds
            completion:(nullable void(^)(BOOL ret))completion;

参数说明

参数	类型	说明
messageIds	NSArray of NSNumber	messageId 的列表，元素需要为 NSNumber 类型。详见消息介绍中的 MessageId 属性。

示例代码

Objective C

[[RCCoreClient sharedCoreClient] deleteMessages:@[@(message.messageId)] completion:^(BOOL ret) {
    if (ret) {
        // 删除成功
    } eles {
        // 删除失败
    }
}];

仅从本地删除会话全部历史消息

如果您需要本地清空自己的单聊、群聊或系统会话的历史记录，可以删除指定会话保存在本地数据库中的全部消息。 如果您已经开通单群聊历史消息云存储服务，服务端保存的操作删除消息用户的历史消息记录不受影响。如果该用户从服务端获取历史消息，可能会获取到在本地已删除的消息。 该接口一次仅允许删除指定的单个会话的消息，会话由会话类型和会话 targetId 参数指定。

接口原型

• (void)clearMessages:(RCConversationType)conversationType targetId:(NSString *)targetId completion:(nullable void(^)(BOOL ret))completion;

参数说明

参数	类型	说明
conversationType	RCConversationType	会话类型，单聊传入 ConversationType_PRIVATE
targetId	NSString	会话 ID

示例代码

Objective C

[[RCCoreClient sharedCoreClient] clearMessages:ConversationType_PRIVATE targetId:@"targetId" completion:^(BOOL ret) {
    if (ret) {
        // 删除成功
    } eles {
        // 删除失败
    }
}];

删除会话内指定消息（消息对象）

提示

• 接口调用需要开通单群聊历史消息云存储服务，该接口同时从本地和服务端删除消息。

如果 App 用户希望从自己的单聊、群聊或系统会话的历史记录中彻底删除一条消息，可以使用 deleteRemoteMessage 从本地和服务端同时删除消息。删除成功后，该用户无法从本地数据库获取消息。如果从服务端获取历史消息，也无法获取到已删除的消息。

该接口允许一次删除指定的单个会话内的一条或一组消息。请确保所提供的消息均属于同一会话（由会话类型和会话 targetId 指定）。

接口原型

Objective C

- (void)deleteRemoteMessage:(RCConversationType)conversationType
                   targetId:(NSString *)targetId
                   messages:(NSArray<RCMessage *> *)messages
                    success:(nullable void (^)(void))successBlock
                      error:(nullable void (^)(RCErrorCode status))errorBlock;

参数说明

参数	类型	说明
conversationType	RCConversationType	会话类型，单聊传入 ConversationType_PRIVATE
targetId	NSString	会话 ID
messages	NSArray of RCMessage	将被删除的消息对象 RCMessage 列表
successBlock	Block	成功的回调
errorBlock	Block	失败的回调。status 参数返回错误码 RCErrorCode。

示例代码

Objective C

[[RCCoreClient sharedCoreClient] 
    deleteRemoteMessage:ConversationType_PRIVATE
    targetId:@"targetId"
    messages:messages
     success:^{}
       error:^(RCErrorCode status) {}];

删除会话历史消息（时间戳）

提示

此方法可以清除服务器端历史消息和本地消息，如果清除服务器端消息必须先开通单群聊历史消息云存储服务。

如果 App 用户希望从自己的单聊、群聊或系统会话的历史记录中删除一段历史消息记录，可以使用 clearHistoryMessages 删除会话中早于某个时间点（recordTime）的消息。 如果 clearRemote 参数设置为 YES，表示需要同时删除服务端对应消息，该接口会从本地和服务端同时删除早于 （recordTime）的消息。服务端消息删除后，该用户无法再从服务端获取到已删除的消息。该接口一次仅允许删除指定的单个会话的消息，会话由会话类型和会话 targetId 参数指定。

接口说明

Objective C

- (void)clearHistoryMessages:(RCConversationType)conversationType
                    targetId:(NSString *)targetId
                  recordTime:(long long)recordTime
                 clearRemote:(BOOL)clearRemote
                     success:(nullable void (^)(void))successBlock
                       error:(nullable void (^)(RCErrorCode status))errorBlock;

参数说明

参数	类型	说明
conversationType	RCConversationType	会话类型，单聊传入 ConversationType_PRIVATE
targetId	NSString	会话 ID
recordTime	long long	消息时间戳。默认删除小于等于 recordTime 的消息。如果传 0，则删除所有消息。
clearRemote	BOOL	是否同时删除服务端消息
successBlock	Block	成功的回调
errorBlock	Block	失败的回调。status 参数返回错误码 RCErrorCode。

示例代码

Objective C

[[RCCoreClient sharedCoreClient] 
    clearHistoryMessages:ConversationType_PRIVATE
    targetId:@"targetId"
    recordTime:recordTime
    clearRemote:YES
    success:^{}
    error:^(RCErrorCode status) {}];

仅从服务端删除会话历史消息（时间戳）

提示

• 使用此功能需要开通单群聊历史消息云存储服务。该接口仅从服务端删除消息。
• 使用融云即时通讯服务端 API 也可以直接删除服务端消息。具体操作请参阅服务端文档消息清除。

您可以仅删除指定会话保存在服务端的历史消息。该接口提供时间戳参数（recordTime），支持删除早于指定时间的消息。如果 recordTime 设置为 0 则删除该会话保存在服务端的全部历史消息。

接口说明

Objective C

- (void)clearRemoteHistoryMessages:(RCConversationType)conversationType
                          targetId:(NSString *)targetId
                        recordTime:(long long)recordTime
                           success:(nullable void (^)(void))successBlock
                             error:(nullable void (^)(RCErrorCode status))errorBlock;

参数说明

参数	类型	说明
conversationType	RCConversationType	会话类型，单聊传入 ConversationType_PRIVATE
targetId	NSString	会话 ID
recordTime	long long	消息时间戳。默认删除小于等于 recordTime 的消息。如果传 0，则删除所有消息。
successBlock	Block	删除成功的回调
errorBlock	Block	删除失败的回调。status 参数返回错误码 RCErrorCode。

示例代码

Objective C

[[RCCoreClient sharedCoreClient] 
    clearRemoteHistoryMessages:ConversationType_PRIVATE
    targetId:@"targetId"
    recordTime:sentTime
    success:^{}
    error:^(RCErrorCode status) {}];