deleteAllMsgFromLocal

功能介绍

说明

删除本地所有会话中的消息，会话仍会保留。 卸载重装后还能获取到这些消息。

注意

相关回调：
onConversationChanged

iOS

函数原型

 Future<dynamic> deleteAllMsgFromLocal({
    String? operationID,
  })

输入参数

~

返回结果

名称	类型	描述
~	~	无异常抛出则操作成功

代码示例

    await OpenIM.iMManager.messageManager.deleteAllMsgFromLocal();
    // todo

Android

函数原型

- (void)deleteAllMsgFromLocalWithOnSuccess:(nullable OIMSuccessCallback)onSuccess
                                 onFailure:(nullable OIMFailureCallback)onFailure;

输入参数

无

返回结果

名称	类型	描述
onSuccess	OIMSuccessCallback	成功返回
onFailure	OIMFailureCallback	失败返回

代码示例

[OIMManager.manager deleteAllMsgFromLocalOnSuccess:^(NSString * _Nullable data) {

} onFailure:^(NSInteger code, NSString * _Nullable msg) {

}];

Flutter

函数原型

 public void deleteAllMsgFromLocal(OnBase<String> base)

输入参数

名称	类型	描述
callBack	OnBase<String>	是	回调接口

代码示例

    OpenIMClient.getInstance().messageManager. deleteAllMsgFromLocal(new OnBase<String>() {
            @Override
            public void onError(int code, String error) {

            }

            @Override
            public void onSuccess(String data) {

            }
        })

uni-app

函数原型

IMSDK.deleteAllMsgFromLocal(operationID?: string): Promise<WsResponse>

输入参数

无

返回结果

参数名称	参数类型	描述
Promise.then()	Promise<WsResponse>	调用成功回调
Promise.catch()	Promise<WsResponse>	调用失败回调

代码示例

import { getSDK } from 'open-im-sdk-wasm';
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.deleteAllMsgFromLocal()
  .then(({ data }) => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Browser/Electron/MiniProgram

函数原型

IMSDK.asyncApi('deleteAllMsgFromLocal', operationID: string): Promise<void>

输入参数

参数名称	参数类型	是否必填	描述
operationID	string	是	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数

返回结果

通过openim-uniapp-polyfill包将函数 Promise 化，调用时需要使用then和catch判断并处理成功和失败回调。

参数名称	参数类型	描述
Promise.then()	Promise<void>	调用成功回调
Promise.catch()	Promise<CatchResponse>	调用失败回调

代码示例

import IMSDK from 'openim-uniapp-polyfill';

IMSDK.asyncApi('deleteAllMsgFromLocal', IMSDK.uuid())
  .then(() => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

React-Native

函数原型

OpenIMSDKRN.deleteAllMsgFromLocal(operationID: string): Promise<void>

输入参数

参数名称	参数类型	是否必填	描述
operationID	string	是	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数

返回结果

参数名称	参数类型	描述
Promise.then()	Promise<void>	调用成功回调
Promise.catch()	Promise<CatchResponse>	调用失败回调

代码示例

import OpenIMSDKRN from "open-im-sdk-rn";

OpenIMSDKRN.deleteAllMsgFromLocal('operationID')
  .then(() => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Unity

函数原型

public static void DeleteAllMsgFromLocal(OnSucOrError cb)

输入参数

名称	类型	描述
cb	OnSucOrError	是	回调接口

代码示例

IMSDK.DeleteAllMsgFromLocal((suc,errCode,errMsg)=>{

});