setConversationRecvMessageOpt

Feature Introduction

Description

Set conversation "Do Not Disturb" status.

Note

Related Callback: onConversationChanged

iOS

Function Prototype

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

Input Parameters

Parameter Name	Parameter Type	Required	Description
conversationID	String	Yes	Conversation ID
status	int	Yes	Message Do Not Disturb status 0: Normal; 1: Don't receive messages; 2: Receive online messages but not offline messages

Return Result

Name	Type	Description
~	~	Operation successful if no exception thrown

Code Example

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

Android

Function Prototype

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

Input Parameters

Parameter Name	Parameter Type	Required	Description
conversationID	NSString	Yes	Conversation ID
status	OIMReceiveMessageOpt	Yes	Message Do Not Disturb status

Return Result

Name	Type	Description
onSuccess	OIMSuccessCallback	Success return
onFailure	OIMFailureCallback	Failure return

Code Example

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

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

}];

Flutter

Function Prototype

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

Input Parameters

Parameter Name	Parameter Type	Required	Description
base	OnBase<String>	Yes	Callback interface
conversationIDs	List<String>	Yes	List of Conversation IDs
status	int	Yes	Opt Message Receive Status

Code Example

          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

Function Prototype

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

Input Parameters

Parameter Name	Parameter Type	Required	Description
conversationID	string	Yes	Conversation ID
opt	MessageReceiveOptType	Yes	Message Do Not Disturb status

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.setConversationRecvMessageOpt({
  conversationID: 'conversationID',
  opt: 2,
})
  .then(({ data }) => {
    // Successful call
  })
  .catch(({ errCode, errMsg }) => {
    // Failed call
  });

Browser/Electron/MiniProgram

Function Prototype

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

Input Parameters

Parameter Name	Parameter Type	Required	Description
operationID	string	Yes	Operation ID, used for problem tracking, should be unique. It's recommended to use the current time combined with a random number
opt	MessageReceiveOptType	Yes	Message Do Not Disturb status

Return Result

The function is made Promise compatible through the openim-uniapp-polyfill package. When calling, use then and catch to determine and handle the 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('setConversationRecvMessageOpt', IMSDK.uuid(), {
  conversationID: 'conversationID',
  opt: 2,
})
  .then(() => {
    // Successful call
  })
  .catch(({ errCode, errMsg }) => {
    // Failed call
  });

React-Native

Function Prototype

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

Input Parameters

Parameter Name	Parameter Type	Mandatory	Description
opt	MessageReceiveOptType	Yes	Message Do Not Disturb status
conversationID	string	Yes	message ID
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.setConversationRecvMessageOpt({
  conversationID: 'conversationID',
  opt: 2,
}, 'operationID')
  .then(() => {
    // Successful call
  })
  .catch(({ errCode, errMsg }) => {
    // Failed call
  });

Unity

Function Prototype

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

Input Parameter

Parameter Name	Parameter Type	Mandatory	Description
cb	OnSucOrError	Yes	Callback
conversationID	string	Yes	Conversation ID
opt	int	Yes	Opt Message Do Not Disturb status

Code Example

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

},conversationIDs,status);