更新时间: 2020-08-26
# 本地删除
开发者可通过下面接口对本地数据库的消息进行删除。
# 通过消息 ID 删除
输入参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
messageIds | NSArray<NSNumber *> | 是 | 消息ID的列表,元素需要为 NSNumber 类型 |
返回参数说明:
返回值 | 返回类型 | 说明 |
---|---|---|
success | BOOL | 是否删除成功 |
代码示例:
BOOL success = [[RCIMClient sharedRCIMClient] deleteMessages: @[@(message.messageId)]];
已复制
1
# 通过时间戳删除
输入参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
conversationType | RCConversationType (opens new window) | 是 | 会话类型,传入 {conversationType} |
targetId | NSString | 是 | |
recordTime | long long | 是 | 清除消息时间戳,传入的时间戳必须小于等于当前会话最后一条消息的 sentTime 传 0 表示清除所有消息, 传入其他值表示清除小于等于 recordTime 的消息 |
clearRemote | BOOL | 是 | 是否同时删除服务端消息 |
successBlock | Block | - | 获取成功的回调 |
errorBlock | Block | - | 获取失败的回调 |
回调参数说明:
error 说明:
回调参数 | 回调类型 | 说明 |
---|---|---|
status | RCErrorCode (opens new window) | 撤回失败错误码 |
代码示例:
[[RCIMClient sharedRCIMClient] clearHistoryMessages:{conversationType} targetId:@"{userId}" recordTime:recordTime clearRemote:NO success:^{} error:^(RCErrorCode status) {}];
已复制
1
2
3
4
5
6
2
3
4
5
6
# 通过会话删除
输入参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
conversationType | RCConversationType (opens new window) | 是 | 会话类型,传入 {conversationType} |
targetId | NSString | 是 |
返回参数说明:
返回值 | 返回类型 | 说明 |
---|---|---|
success | BOOL | 是否删除成功 |
代码示例:
BOOL success = [[RCIMClient sharedRCIMClient] clearMessages:{conversationType} targetId:@"{userId}"];
已复制
1
# 远端删除
开发者可通过下面接口对远端的消息进行删除。
# 通过时间戳删除
通过时间戳删除该时间之前的服务端历史消息,删除后不可恢复。
输入参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
conversationType | RCConversationType (opens new window) | 是 | 会话类型,传入 {conversationType} |
targetId | NSString | 是 | |
recordTime | long long | 是 | 清除消息时间戳,传入的时间戳必须小于等于当前会话最后一条消息的 sentTime 传 0 表示清除所有消息, 传入其他值表示清除小于等于 recordTime 的消息 |
successBlock | Block | - | 删除成功的回调 |
errorBlock | Block | - | 删除失败的回调 |
回调参数说明:
error 说明:
回调参数 | 回调类型 | 说明 |
---|---|---|
status | RCErrorCode (opens new window) | 删除失败错误码 |
代码示例:
[[RCIMClient sharedRCIMClient]clearRemoteHistoryMessages:{conversationType} targetId:@"{userId}" recordTime:sentTime success:^{} error:^(RCErrorCode status) {}];
已复制
1
2
3
4
5
2
3
4
5
# 通过消息删除
仅删除服务端指定一条或多条历史消息。
输入参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
conversationType | RCConversationType (opens new window) | 是 | 会话类型,传入 {conversationType} |
targetId | NSString | 是 | |
messages | NSArray<RCMessage *> | 是 | 将被删除的消息列表 |
successBlock | Block | - | 成功的回调 |
errorBlock | Block | - | 失败的回调 |
回调参数说明:
error 说明:
回调参数 | 回调类型 | 说明 |
---|---|---|
status | RCErrorCode (opens new window) | 删除失败错误码 |
代码示例:
[[RCIMClient sharedRCIMClient] deleteRemoteMessage:{conversationType} targetId:@"{userId}" messages:messages success:^{} error:^(RCErrorCode status) {}];
已复制
1
2
3
4
2
3
4