deleteMessage
功能介绍
说明
从本地和服务端删除一条消息。
注意
相关回调:
onConversationChanged
如果删除的是最新一条消息,则会话最新一条消息会改变
- iOS
- Android
- Flutter
- uni-app
- Browser/Electron/MiniProgram
- React-Native
- Unity
函数原型
Future<dynamic> deleteMessageFromLocalAndSvr({
required String conversationID,
required String clientMsgID,
String? operationID,
})
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
conversationID | String | 是 | 会话 ID |
clientMsgID | String | 是 | 消息 ID |
返回结果
名称 | 类型 | 描述 |
---|---|---|
~ | ~ | 无异常抛出则操作成功 |
代码示例
await OpenIM.iMManager.messageManager.deleteMessageFromLocalAndSvr(
"conversationID":"conversationID",
"clientMsgID":"clientMsgID",
);
// todo
函数原型
- (void)deleteMessage:(NSString *)conversationID
clientMsgID:(NSString *)clientMsgID
onSuccess:(nullable OIMSuccessCallback)onSuccess
onFailure:(nullable OIMFailureCallback)onFailure;
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
conversationID | NSString | 是 | 会话 ID |
clientMsgID | NSString | 是 | 消息 ID |
返回结果
名称 | 类型 | 描述 |
---|---|---|
onSuccess | OIMSuccessCallback | 成功返回 |
onFailure | OIMFailureCallback | 失败返回 |
代码示例
[OIMManager.manager deleteMessage:@""
clientMsgID:@""
onSuccess:^(NSString * _Nullable data) {
} onFailure:^(NSInteger code, NSString * _Nullable msg) {
}];
### 函数原型
public void deleteMessageFromLocalAndSvr(String conversationID, String clientMsgID, OnBase<String> callBack)
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
conversationID | String | 是 | 回话 ID |
clientMsgID | String | 是 | 消息 ID |
callBack | OnBase<String> | 是 | 回调接口 |
返回结果
名称 | 类型 | 描述 |
---|---|---|
~ | ~ | 无异常抛出则操作成功 |
代码示例
OpenIMClient.getInstance().messageManager. deleteMessageFromLocalAndSvr(conversationID, clientMsgID,new OnBase<String>() {
public void onError(int code, String error) {
}
public void onSuccess(String data) {
}
})
// todo
函数原型
IMSDK.deleteMessage({
conversationID: string;
clientMsgID: string;
}, operationID?: string): Promise<WsResponse>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
conversationID | string | 是 | 会话 ID |
clientMsgID | string | 是 | 消息 ID |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<WsResponse> | 调用成功回调 |
Promise.catch() | Promise<WsResponse> | 调用失败回调 |
代码示例
import { getSDK } from '@openim/wasm-client-sdk';
const IMSDK = getSDK();
// use in electron with ffi
// import { getWithRenderProcess } from '@openim/electron-client-sdk/lib/render';
// const { instance: IMSDK } = getWithRenderProcess();
// use in mini program
// import { OpenIMSDK } from 'open-im-sdk';
// const IMSDK = new OpenIMSDK();
IMSDK.deleteMessage({
conversationID: '',
clientMsgID: '',
})
.then(({ data }) => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});
函数原型
IMSDK.asyncApi('deleteMessage', operationID: string, {
conversationID: string;
clientMsgID: string;
}): Promise<void>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
operationID | string | 是 | 操作 ID,用于定位问题,保持唯一,建议用当前时间和随机数 |
conversationID | string | 是 | 会话 ID |
clientMsgID | string | 是 | 消息 ID |
返回结果
通过
openim-uniapp-polyfill
包将函数 Promise 化,调用时需要使用then
和catch
判断并处理成功和失败回调。
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<void> | 调用成功回调 |
Promise.catch() | Promise<CatchResponse> | 调用失败回调 |
代码示例
import IMSDK from 'openim-uniapp-polyfill';
IMSDK.asyncApi('deleteMessage', IMSDK.uuid(), {
conversationID: '',
clientMsgID: '',
})
.then(() => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});
函数原型
OpenIMSDKRN.deleteMessage({
conversationID: string,
clientMsgID:string
}, operationID: string): Promise<void>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
operationID | string | 是 | 操作 ID,用于定位问题,保持唯一,建议用当前时间和随机数 |
conversationID | string | 是 | 会话 ID |
clientMsgID | string | 是 | 消息 ID |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<void> | 调用成功回调 |
Promise.catch() | Promise<CatchResponse> | 调用失败回调 |
代码示例
import OpenIMSDKRN from "open-im-sdk-rn";
OpenIMSDKRN.deleteMessage({
conversationID: '',
clientMsgID: '',
}, 'operationID')
.then(() => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});