deleteMessageFromLocalStorage

Feature Introduction

Note

Delete a message from local storage. After uninstalling the APP, it can be retrieved again.

Attention

Relevant Callback: onConversationChanged If the message being deleted is the latest one, the latest message in the conversation will change.

iOS

Function Prototype

  Future deleteMessageFromLocalStorage({
    required String conversationID,
    required String clientMsgID,
    String? operationID,
  })

Input Parameters

Parameter Name	Parameter Type	Mandatory	Description
conversationID	String	Yes	Conversation ID
clientMsgID	String	Yes	Message ID

Return Result

Name	Type	Description
~	~	If no exception is thrown, operation is successful

Code Example

    await OpenIM.iMManager.messageManager.deleteMessageFromLocalStorage(
        "conversationID":"conversationID",
        "clientMsgID":"clientMsgID",
    );
    // todo

Android

Function Prototype

- (void)deleteMessageFromLocalStorage:(NSString *)conversationID
                          clientMsgID:(NSString *)clientMsgID
                            onSuccess:(OIMSuccessCallback)onSuccess
                            onFailure:(OIMFailureCallback)onFailure;

Input Parameters

Parameter Name	Parameter Type	Mandatory	Description
conversationID	NSString	Yes	Conversation ID
clientMsgID	NSString	Yes	Message ID

Return Result

Name	Type	Description
onSuccess	OIMSuccessCallback	Successful return
onFailure	OIMFailureCallback	Failed return

Code Example

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

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

}];

Flutter

Function Prototype

 public void deleteMessageFromLocalStorage(String conversationID, String clientMsgID, OnBase<String> callBack)

Input Parameters

Parameter Name	Parameter Type	Mandatory	Description
conversationID	String	Yes	Conversation ID
clientMsgID	String	Yes	Message ID
callBack	OnBase<String>	Yes	Callback interface

Code Example

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

            }

            @Override
            public void onSuccess(String data) {

            }
        })
    // todo

uni-app

Function Prototype

IMSDK.deleteMessageFromLocalStorage({
  conversationID: string;
  clientMsgID: string;
}, operationID?: string): Promise<WsResponse>

Input Parameters

Parameter Name	Parameter Type	Mandatory	Description
conversationID	string	Yes	Conversation ID
clientMsgID	string	Yes	Message ID

Return Result

Parameter Name	Parameter Type	Description
Promise.then()	Promise<WsResponse>	Successful callback
Promise.catch()	Promise<WsResponse>	Failed 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.deleteMessageFromLocalStorage({
  conversationID: '',
  clientMsgID: '',
})
  .then(({ data }) => {
    // Successful call
  })
  .catch(({ errCode, errMsg }) => {
    // Failed call
  });

Browser/Electron/MiniProgram

Function Prototype

IMSDK.asyncApi('deleteMessageFromLocalStorage', operationID: string, {
  conversationID: string;
  clientMsgID: string;
}): Promise<void>

Input Parameters

Parameter Name	Parameter Type	Mandatory	Description
operationID	string	Yes	Operation ID used to identify issues, recommended to use current time and a random number
conversationID	string	Yes	Conversation ID
clientMsgID	string	Yes	Message ID

Return Result

Through the openim-uniapp-polyfill package, the function is Promise-based. When calling, use then and catch to determine and handle successful and failed callbacks.

Parameter Name	Parameter Type	Description
Promise.then()	Promise<void>	Successful callback
Promise.catch()	Promise<CatchResponse>	Failed callback

Code Example

import IMSDK from 'openim-uniapp-polyfill';

IMSDK.asyncApi('deleteMessageFromLocalStorage', IMSDK.uuid(), {
  conversationID: '',
  clientMsgID: '',
})
  .then(() => {
    // Successful call
  })
  .catch(({ errCode, errMsg }) => {
    // Failed call
  });

React-Native

Function Prototype

OpenIMSDKRN.deleteMessageFromLocalStorage({
  conversationID: string,
  clientMsgID:string
}, operationID: string): Promise<void>

Input Parameters

Parameter Name	Parameter Type	Mandatory	Description
operationID	string	Yes	Operation ID used to identify issues, recommended to use current time and a random number
conversationID	string	Yes	Conversation ID
clientMsgID	string	Yes	Message ID

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.deleteMessageFromLocalStorage({
  conversationID: '',
  clientMsgID: '',
}, 'operationID')
  .then(() => {
    // Successful call
  })
  .catch(({ errCode, errMsg }) => {
    // Failed call
  });

Unity

Function Prototype

public static void DeleteMessageFromLocalStorage(OnSucOrError cb, string conversationID, string clientMsgID)

Input Parameter

Parameter Name	Parameter Type	Mandatory	Description
cb	OnSucOrError	Yes	Callback
conversationID	string	Yes	Conversation ID
clientMsgID	string	Yes	Message ID

Code Example

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

},conversationID,clientMsgID);