deleteAllMsgFromLocal

Description

info

Delete all messages in all local conversations, the conversations will still be retained. After uninstalling and reinstalling, these messages can still be retrieved.

Note

Related Callback:
onConversationChanged

iOS

Function Prototype

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

Input Parameters

None

Return Result

Name	Type	Description
~	~	Operation is successful if no exception is thrown

Code Example

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

Android

Function Prototype

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

Input Parameters

None

Return Result

Name	Type	Description
onSuccess	OIMSuccessCallback	Success return
onFailure	OIMFailureCallback	Failure return

Code Example

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

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

}];

Flutter

Function Prototype

 public void deleteAllMsgFromLocal(OnBase<String> base)

Input Parameters

Name	Type	Required	Description
callBack	OnBase<String>	Yes	Callback interface

Code Example

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

            }

            @Override
            public void onSuccess(String data) {

            }
        })

uni-app

Function Prototype

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

Input Parameters

None

Return Result

Parameter Name	Parameter Type	Description
Promise.then()	Promise<WsResponse>	Success callback
Promise.catch()	Promise<WsResponse>	Failure callback

Code Example

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();

IMSDK.deleteAllMsgFromLocal()
  .then(({ data }) => {
    // Call successful
  })
  .catch(({ errCode, errMsg }) => {
    // Call failed
  });

Browser/Electron

Function Prototype

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

Input Parameters

Parameter Name	Parameter Type	Required	Description
operationID	string	Yes	Operation ID, used to pinpoint issues, keep unique, prefer time+random

Return Result

Use the openim-uniapp-polyfill package to make the function Promise. When calling, you need to use then and catch to determine and handle success and failure callbacks.

Parameter Name	Parameter Type	Description
Promise.then()	Promise<void>	Success callback
Promise.catch()	Promise<CatchResponse>	Failure callback

Code Example

import IMSDK from 'openim-uniapp-polyfill';

IMSDK.asyncApi('deleteAllMsgFromLocal', IMSDK.uuid())
  .then(() => {
    // Call successful
  })
  .catch(({ errCode, errMsg }) => {
    // Call failed
  });

React-Native

Function Prototype

OpenIMSDK.deleteAllMsgFromLocal(operationID?: string): Promise<void>

Input Parameters

Parameter Name	Parameter Type	Required	Description
operationID	string	No	Operation ID, used to pinpoint issues, keep unique, prefer time+random

Return Result

Parameter Name	Parameter Type	Description
Promise.then()	Promise<void>	Success callback
Promise.catch()	Promise<OpenIMApiError>	Failure callback

Code Example

import OpenIMSDK from "@openim/rn-client-sdk";

OpenIMSDK.deleteAllMsgFromLocal()
  .then(() => {
    // Call successful
  })
  .catch((error) => {
    // Call failed
  });

Unity

Function Prototype

public static void DeleteAllMsgFromLocal(OnBase<bool> cb)

Input Parameters

Name	Type	Required	Description
cb	OnBase	Yes	Callback interface

Code Example

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

});