setConversationPrivateChat

功能介绍

说明

打开或者关闭"阅后即焚"，开启后发送的消息体上AttachedInfoElem的isPrivateChat为true，客户端可以根据这个标识位做阅后即焚的逻辑。

注意

相关回调：
onConversationChanged

iOS

函数原型

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

输入参数

参数名称	参数类型	是否必填	描述
conversationID	String	是	会话 ID
isPrivate	bool	是	是否开启阅后即焚

返回结果

名称	类型	描述
~	~	无异常抛出则操作成功

代码示例

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

Android

函数原型

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

输入参数

参数名称	参数类型	是否必填	描述
conversationID	NSString	是	会话 ID
isPrivate	BOOL	是	是否开启阅后即焚

返回结果

名称	类型	描述
onSuccess	OIMSuccessCallback	成功返回
onFailure	OIMFailureCallback	失败返回

代码示例

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

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

}];

Flutter

函数原型

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

输入参数

参数名称	参数类型	是否必填	描述
base	OnBase<String>	是	回调接口
conversationID	String	是	会话 ID
isPrivate	bool	是	是否是私聊

返回结果

名称	类型	描述
~	~	无异常抛出则操作成功

代码示例

        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

函数原型

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

输入参数

参数名称	参数类型	是否必填	描述
conversationID	string	是	会话 ID
isPrivate	boolean	是	是否开启阅后即焚

返回结果

参数名称	参数类型	描述
Promise.then()	Promise<WsResponse>	调用成功回调
Promise.catch()	Promise<WsResponse>	调用失败回调

代码示例

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 }) => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Browser/Electron/MiniProgram

函数原型

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

输入参数

参数名称	参数类型	是否必填	描述
operationID	string	是	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数
conversationID	string	是	会话 ID
isPrivate	boolean	是	是否开启阅后即焚

返回结果

通过openim-uniapp-polyfill包将函数 Promise 化，调用时需要使用then和catch判断并处理成功和失败回调。

参数名称	参数类型	描述
Promise.then()	Promise<void>	调用成功回调
Promise.catch()	Promise<CatchResponse>	调用失败回调

代码示例

import IMSDK from 'openim-uniapp-polyfill';

IMSDK.asyncApi('setConversationPrivateChat', IMSDK.uuid(), {
  conversationID: 'conversationID',
  isPrivate: true,
})
  .then(() => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

React-Native

函数原型

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

输入参数

参数名称	参数类型	是否必填	描述
conversationID	string	是	会话 ID
isPrivate	boolean	是	是否开启阅后即焚
operationID	string	是	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数

返回结果

参数名称	参数类型	描述
Promise.then()	Promise<void>	调用成功回调
Promise.catch()	Promise<CatchResponse>	调用失败回调

代码示例

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

OpenIMSDKRN.setConversationPrivateChat({
  conversationID: 'conversationID',
  isPrivate: true,
}, 'operationID')
  .then(({ data }) => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Unity

函数原型

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

输入参数

参数名称	参数类型	是否必填	描述
cb	OnSucOrError	是	回调接口
conversationID	string	是	会话 ID
isPrivate	bool	是	是否是私聊

返回结果

代码示例

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

} conversionID,isPrivate);