setConversationPrivateChat

Feature Description

Description

Activate or deactivate "read and burn."

Note

Related Callback: onConversationChanged

iOS

Function Prototype

  Future<dynamic> setConversationPrivateChat({
    required String conversationID,
    required bool isPrivate,
    String? operationID,
  })

Input Parameters

Parameter Name	Parameter Type	Mandatory	Description
conversationID	String	Yes	Conversation ID
isPrivate	bool	Yes	Activate read and burn

Return Result

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

Code Example

    await OpenIM.iMManager.conversationManager.setConversationPrivateChat(conversationID: conversationID, isPrivate: isPrivate);
    //todo

Android

Function Prototype

- (void)setConversationPrivateChat:(NSString *)conversationID
                            isPrivate:(BOOL)isPrivate
                            onSuccess:(nullable OIMSuccessCallback)onSuccess
                            onFailure:(nullable OIMFailureCallback)onFailure;

Input Parameters

Parameter Name	Parameter Type	Mandatory	Description
conversationID	NSString	Yes	Conversation ID
isPrivate	BOOL	Yes	Activate read and burn

Return Result

Name	Type	Description
onSuccess	OIMSuccessCallback	Success return
onFailure	OIMFailureCallback	Failure return

Code Example

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

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

}];

Flutter

Function Prototype

 public void setOneConversationPrivateChat(OnBase<String> base, String conversionID, boolean isPrivate)

Input Parameters

Parameter Name	Parameter Type	Mandatory	Description
base	OnBase<String>	Yes	Callback interface
conversationID	String	Yes	Conversation ID
isPrivate	bool	Yes	Private chat

Return Result

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

Code Example

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

            }

            @Override
            public void onSuccess(String data) {

            }
        }conversionID,isPrivate);

uni-app

Function Prototype

IMSDK.setConversationPrivateChat({
    conversationID: string;
    isPrivate: boolean;
},operationID?: string): Promise<WsResponse>

Input Parameters

Parameter Name	Parameter Type	Mandatory	Description
conversationID	string	Yes	Conversation ID
isPrivate	boolean	Yes	Activate read and burn

Return Result

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

Browser/Electron/MiniProgram

Function Prototype

IMSDK.asyncApi('setConversationPrivateChat', operationID: string, {
  conversationID: string;
  isPrivate: boolean;
}): Promise<void>

Input Parameters

Parameter Name	Parameter Type	Mandatory	Description
operationID	string	Yes	Operation ID, used for problem tracking, keep unique, recommended to use current time and random number
conversationID	string	Yes	Conversation ID
isPrivate	boolean	Yes	Activate read and burn

Return Result

The function is Promise-wrapped through the openim-uniapp-polyfill package. When calling, you need to use then and catch to determine and handle success and failure callbacks respectively.

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

React-Native

Function Prototype

OpenIMSDKRN.setConversationPrivateChat({
  conversationID: string,
  isPrivate: boolean,
}, operationID: string): Promise<void>

Input Parameters

Parameter Name	Parameter Type	Mandatory	Description
conversationID	string	Yes	Conversation ID
isPrivate	boolean	Yes	Activate read and burn
operationID	string	Yes	Operation ID, used for problem location, keep 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.setConversationPrivateChat({
  conversationID: 'conversationID',
  isPrivate: true,
}, 'operationID')
  .then(() => {
    // Call was successful
  })
  .catch(({ errCode, errMsg }) => {
    // Call failed
  });

Unity

Function Prototype

public static void SetConversationPrivateChat(OnSucOrError cb, string conversationID, bool isPrivate)

Input Parameter

Parameter Name	Parameter Type	Mandatory	Description
cb	OnSucOrError	Yes	Callback
conversationID	string	Yes	Conversation ID
isPrivate	bool	Yes	Activate read and burn

Return Result

Code Example

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

} conversionID,isPrivate);