setConversationRecvMessageOpt

功能介绍

说明

设置会话免打扰状态。

注意

相关回调：
onConversationChanged

iOS

函数原型

 Future<dynamic> setConversationRecvMessageOpt({
    required String conversationID,
    required int status,
    String? operationID,
  })

输入参数

参数名称	参数类型	是否必填	描述
conversationID	String	是	会话 ID
status	int	是	消息免打扰状态 0：正常；1：不接受消息；2：接受在线消息不接受离线消息

返回结果

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

代码示例

   await OpenIM.iMManager.conversationManager.setConversationRecvMessageOpt(conversationIDList: conversationIDList, status: status);
    //todo

Android

函数原型

- (void)setConversationRecvMessageOpt:(NSString *)conversationID
                               status:(OIMReceiveMessageOpt)status
                            onSuccess:(nullable OIMSuccessCallback)onSuccess
                            onFailure:(nullable OIMFailureCallback)onFailure;

输入参数

参数名称	参数类型	是否必填	描述
conversationID	NSString	是	会话 ID
status	OIMReceiveMessageOpt	是	消息免打扰状态

返回结果

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

代码示例

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

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

}];

Flutter

函数原型

 public void setConversationRecvMessageOpt(OnBase<String> base, List<String> conversationIDs, long status)

输入参数

参数名称	参数类型	是否必填	描述
base	OnBase<String>	是	回调接口
conversationIDs	List<String>	是	会话 ID 列表
status	int	是	Opt 接收消息状态

代码示例

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

              }

              @Override
              public void onSuccess(String data) {

              }
          }conversationIDs,status);

uni-app

函数原型

IMSDK.setConversationRecvMessageOpt({
    conversationID: string;
    opt: MessageReceiveOptType;
},operationID?: string): Promise<WsResponse>

输入参数

参数名称	参数类型	是否必填	描述
conversationID	string	是	会话 ID
opt	MessageReceiveOptType	是	消息免打扰状态

返回结果

参数名称	参数类型	描述
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.setConversationRecvMessageOpt({
  conversationID: 'conversationID',
  opt: 2,
})
  .then(({ data }) => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Browser/Electron/MiniProgram

函数原型

IMSDK.asyncApi('setConversationRecvMessageOpt', operationID: string, {
  conversationID: string;
  opt: MessageReceiveOptType;
}): Promise<void>

输入参数

参数名称	参数类型	是否必填	描述
operationID	string	是	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数
opt	MessageReceiveOptType	是	消息免打扰状态

返回结果

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

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

代码示例

import IMSDK from 'openim-uniapp-polyfill';

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

React-Native

函数原型

OpenIMSDKRN.setConversationRecvMessageOpt({
  conversationID: string,
  opt: number,
}, operationID: string): Promise<void>

输入参数

参数名称	参数类型	是否必填	描述
opt	MessageReceiveOptType	是	消息免打扰状态
conversationID	string	是	消息ID
operationID	string	是	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数

返回结果

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

代码示例

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

OpenIMSDKRN.setConversationRecvMessageOpt({
  conversationID: 'conversationID',
  opt: 2,
}, 'operationID')
  .then(() => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Unity

函数原型

public static void SetConversationRecvMessageOpt(OnSucOrError cb, string conversationID, int opt)

输入参数

参数名称	参数类型	是否必填	描述
cb	OnSucOrError	是	回调接口
conversationID	string	是	会话ID
opt	int	是	Opt 接收消息状态

代码示例

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

},conversationIDs,status);