setGlobalRecvMessageOpt
Function Introduction
Description
Globally set message notifications. Can be used to turn off global message notifications, including offline push and sound alerts.
Note
- iOS
- Android
- Flutter
- uni-app
- Browser/Electron/MiniProgram
- React-Native
- Unity
Function Prototype
Future<dynamic> setGlobalRecvMessageOpt({
required int status,
String? operationID,
})
Input Parameters
Parameter Name | Parameter Type | Required | Description |
---|---|---|---|
status | int | Yes | Disturbance mode 0: Normal; 1: Don't receive messages; 2: Receive online messages but not offline messages |
Return Results
Name | Type | Description |
---|---|---|
~ | ~ | Operation successful if no exceptions are thrown |
Code Example
await OpenIM.iMManager.conversationManager.setGlobalRecvMessageOpt(status: 0);
// todo
Function Prototype
- (void)setGlobalRecvMessageOpt:(OIMReceiveMessageOpt)opt
onSuccess:(nullable OIMSuccessCallback)onSuccess
onFailure:(nullable OIMFailureCallback)onFailure;
Input Parameters
Parameter Name | Parameter Type | Required | Description |
---|---|---|---|
opt | OIMReceiveMessageOpt | Yes | Disturbance mode |
Return Results
Name | Type | Description |
---|---|---|
onSuccess | OIMSuccessCallback | Successful return |
onFailure | OIMFailureCallback | Failure return |
Code Example
[OIMManager.manager setGlobalRecvMessageOpt:OIMReceiveMessageOptNotReceive
onSuccess:^(NSString * _Nullable data) {
} onFailure:^(NSInteger code, NSString * _Nullable msg) {
}];
Function Prototype
public void setGlobalRecvMessageOpt(OnBase<String> base, long status)
Input Parameters
Parameter Name | Parameter Type | Required | Description |
---|---|---|---|
base | OnBase<String> | Yes | Callback interface |
status | int | Yes | MessageOpt Conversation message reception option |
Code Example
OpenIMClient.getInstance().conversationManager.setGlobalRecvMessageOpt(new OnBase<String>() {
public void onError(int code, String error) {
}
public void onSuccess(String data) {
}
},status);
Function Prototype
IMSDK.setGlobalRecvMessageOpt(data: MessageReceiveOptType, operationID?: string): Promise<WsResponse>
Input Parameters
Parameter Name | Parameter Type | Required | Description |
---|---|---|---|
data | MessageReceiveOptType | Yes | Disturbance mode |
Return Results
Parameter Name | Parameter Type | Description |
---|---|---|
Promise.then() | Promise<WsResponse> | Successful 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.setGlobalRecvMessageOpt(MessageReceiveOptType.NotNotify)
.then(({ data }) => {
// Successful call
})
.catch(({ errCode, errMsg }) => {
// Failed call
});
Function Prototype
IMSDK.asyncApi('setGlobalRecvMessageOpt', operationID: string, data: MessageReceiveOptType): Promise<void>
Input Parameters
Parameter Name | Parameter Type | Required | Description |
---|---|---|---|
operationID | string | Yes | Operation ID, used for issue localization, keep unique, suggested to use current time and random number |
data | MessageReceiveOptType | Yes | Do Not Disturb status |
Return Results
Through the
openim-uniapp-polyfill
package, the function is Promisified. You need to usethen
andcatch
to determine and handle the successful and failed callbacks.
Parameter Name | Parameter Type | Description |
---|---|---|
Promise.then() | Promise<void> | Successful callback |
Promise.catch() | Promise<CatchResponse> | Failed callback |
Code Example
import IMSDK, { MessageReceiveOptType } from 'openim-uniapp-polyfill';
IMSDK.asyncApi(
'setGlobalRecvMessageOpt',
IMSDK.uuid(),
MessageReceiveOptType.NotNotify
)
.then(({ data }) => {
// Successfully called
})
.catch(({ errCode, errMsg }) => {
// Call failed
});
Function Prototype
OpenIMSDKRN.setGlobalRecvMessageOpt(
opt: MessageReceiveOptType,
operationID: string
): Promise<void>
Input Parameters
Parameter Name | Parameter Type | Mandatory | Description |
---|---|---|---|
data | MessageReceiveOptType | Yes | Do Not Disturb status |
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, { MessageReceiveOptType } from "open-im-sdk-rn";
OpenIMSDKRN.setGlobalRecvMessageOpt(MessageReceiveOptType.NotNotify, operationID)
.then(({ data }) => {
// Successfully called
})
.catch(({ errCode, errMsg }) => {
// Call failed
});
Function Prototype
public static void SetGlobalRecvMessageOpt(OnSucOrError cb, int opt)
Input Parameter
Parameter Name | Parameter Type | Mandatory | Description |
---|---|---|---|
cb | OnSucOrError | Yes | Callback |
opt | int | Yes | MessageOpt Receive Option |
Code Example
IMSDK.SetGlobalRecvMessageOpt((suc,errCode,errMsg)=>{
},opt);