clearConversationAndDeleteAllMsg

Description

info

Delete the messages in a specified conversation from both local and server, but the conversation itself will still be kept.

Note

Related Callbacks:
onConversationChanged

iOS

Function Prototype

  Future clearConversationAndDeleteAllMsg({
    required String conversationID,
    String? operationID,
  })

Input Parameters

Parameter Name	Parameter Type	Required	Description
conversationID	String	Yes	Conversation ID

Return Result

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

Code Example

    await OpenIM.iMManager.conversationManager.clearConversationAndDeleteAllMsg(conversationID: conversationID);
    //todo

Android

Function Prototype

- (void)clearConversationAndDeleteAllMsg:(NSString *)conversationID
                                 onSuccess:(nullable OIMSuccessCallback)onSuccess
                                 onFailure:(nullable OIMFailureCallback)onFailure;

Input Parameters

Parameter Name	Parameter Type	Required	Description
conversationID	NSString	Yes	Conversation ID

Return Result

Name	Type	Description
onSuccess	OIMSuccessCallback	Success return
onFailure	OIMFailureCallback	Failure return

Code Example

[OIMManager.manager clearConversationAndDeleteAllMsg:@""
                                             onSuccess:^(NSString * _Nullable data) {

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

}];

Flutter

Function Prototype

public void clearConversationAndDeleteAllMsg(String conversationID, OnBase<String> callBack)

Input Parameters

Parameter Name	Parameter Type	Required	Description
conversationID	String	Yes	Conversation ID
callBack	OnBase	Yes	Callback interface

Code Example

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

            }

            @Override
            public void onSuccess(String data) {

            }
        })

uni-app

Function Prototype

IMSDK.clearConversationAndDeleteAllMsg(conversationID: string, operationID?: string): Promise<WsResponse>

Input Parameters

Parameter Name	Parameter Type	Required	Description
conversationID	string	Yes	Conversation ID

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.clearConversationAndDeleteAllMsg('conversationID')
  .then(({ data }) => {
    // Call successful
  })
  .catch(({ errCode, errMsg }) => {
    // Call failed
  });

Browser/Electron

Function Prototype

IMSDK.asyncApi('clearConversationAndDeleteAllMsg', operationID: string, conversationID: 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
conversationID	string	Yes	Conversation ID

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(
  'clearConversationAndDeleteAllMsg',
  IMSDK.uuid(),
  'conversationID'
)
  .then(() => {
    // Call successful
  })
  .catch(({ errCode, errMsg }) => {
    // Call failed
  });

React-Native

Function Prototype

OpenIMSDK.clearConversationAndDeleteAllMsg(conversationID: string, operationID?: string): Promise<void>

Input Parameters

Parameter Name	Parameter Type	Required	Description
conversationID	string	Yes	Conversation ID
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.clearConversationAndDeleteAllMsg("conversationID")
  .then(() => {
    // Call successful
  })
  .catch((error) => {
    // Call failed
  });

Unity

Function Prototype

public static void ClearConversationAndDeleteAllMsg(OnBase<bool> cb, string conversationId);

Input Parameters

Parameter Name	Parameter Type	Required	Description
cb	OnBase	Yes	Callback interface
conversationId	string	Yes	Conversation ID

Code Example

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

},conversationId);