deleteAllMsgFromLocalAndSvr

Feature Introduction

Description

Delete messages from all sessions locally and on the server. The sessions will still be retained.

Note

Related Callback: onConversationChanged

iOS

Function Prototype

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

Input Parameters

None

Return Results

Name	Type	Description
~	~	Operation successful if no exception thrown

Code Example

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

Android

Function Prototype

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

Input Parameters

None

Return Results

Name	Type	Description
onSuccess	OIMSuccessCallback	Success return
onFailure	OIMFailureCallback	Failure return

Code Example

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

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

}];

Flutter

Function Prototype

   public void deleteAllMsgFromLocalAndSvr(OnBase<String> base)

Input Parameters

Name	Type	Description
callBack	OnBase<String>	Yes	Callback interface

Code Example

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

            }

            @Override
            public void onSuccess(String data) {

            }
        })

uni-app

Function Prototype

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

Input Parameters

None

Return Results

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

Code Example

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.deleteAllMsgFromLocalAndSvr()
  .then(({ data }) => {
    // Successful call
  })
  .catch(({ errCode, errMsg }) => {
    // Failed call
  });

Browser/Electron/MiniProgram

Function Prototype

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

Input Parameters

Parameter Name	Parameter Type	Mandatory	Description
operationID	string	Yes	Operation ID, used for troubleshooting, ensure it's unique, suggest using current time and random number

Return Results

Using openim-uniapp-polyfill package to Promise the function. When calling, 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('deleteAllMsgFromLocalAndSvr', IMSDK.uuid())
  .then(() => {
    // Successful call
  })
  .catch(({ errCode, errMsg }) => {
    // Failed call
  });

React-Native

Function Prototype

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

Input Parameters

Parameter Name	Parameter Type	Mandatory	Description
operationID	string	Yes	Operation ID, used for troubleshooting, ensure it's unique, suggest using current time and random number

Return Result

Parameter Name	Parameter Type	Description
Promise.then()	Promise<void>	Callback on successful call
Promise.catch()	Promise<CatchResponse>	Callback on failed call

Code Example

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

OpenIMSDKRN.deleteAllMsgFromLocalAndSvr('operationID')
  .then(() => {
    // Successful call
  })
  .catch(({ errCode, errMsg }) => {
    // Failed call
  });

Unity

Function Prototype

public static void DeleteAllMsgFromLocalAndSVR(OnSucOrError cb)

Input Parameter

Parameter Name	Type	Description
cb	OnSucOrError	Yes	Callback

Code Example

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

});