setGlobalRecvMessageOpt

功能介绍

说明

全局设置消息提示，可用于关闭全局消息提示，包括离线推送与声音提示等。

注意

iOS

函数原型

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

输入参数

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

返回结果

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

代码示例

    await OpenIM.iMManager.conversationManager.setGlobalRecvMessageOpt(status: 0);
    // todo

Android

函数原型

- (void)setGlobalRecvMessageOpt:(OIMReceiveMessageOpt)opt
                      onSuccess:(nullable OIMSuccessCallback)onSuccess
                      onFailure:(nullable OIMFailureCallback)onFailure;

输入参数

参数名称	参数类型	是否必填	描述
opt	OIMReceiveMessageOpt	是	免打扰状态

返回结果

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

代码示例

[OIMManager.manager setGlobalRecvMessageOpt:OIMReceiveMessageOptNotReceive
                                  onSuccess:^(NSString * _Nullable data) {

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

}];

Flutter

函数原型

    public void setGlobalRecvMessageOpt(OnBase<String> base, long status)

输入参数

参数名称	参数类型	是否必填	描述
base	OnBase<String>	是	回调接口
status	int	是	MessageOpt 会话消息接收选项

代码示例

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

            }

            @Override
            public void onSuccess(String data) {

            }
        },status);

uni-app

函数原型

IMSDK.setGlobalRecvMessageOpt(data: MessageReceiveOptType, operationID?: string): Promise<WsResponse>

输入参数

参数名称	参数类型	是否必填	描述
data	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.setGlobalRecvMessageOpt(MessageReceiveOptType.NotNotify)
  .then(({ data }) => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Browser/Electron/MiniProgram

函数原型

IMSDK.asyncApi('setGlobalRecvMessageOpt', operationID: string, data: MessageReceiveOptType): Promise<void>

输入参数

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

返回结果

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

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

代码示例

import IMSDK, { MessageReceiveOptType } from 'openim-uniapp-polyfill';

IMSDK.asyncApi(
  'setGlobalRecvMessageOpt',
  IMSDK.uuid(),
  MessageReceiveOptType.NotNotify
)
  .then(({ data }) => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

React-Native

函数原型

OpenIMSDKRN.setGlobalRecvMessageOpt(
  opt: MessageReceiveOptType,
  operationID: string
): Promise<void>

输入参数

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

返回结果

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

代码示例

import OpenIMSDKRN, { MessageReceiveOptType } from "open-im-sdk-rn";

OpenIMSDKRN.setGlobalRecvMessageOpt(MessageReceiveOptType.NotNotify, operationID)
  .then(() => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Unity

函数原型

public static void SetGlobalRecvMessageOpt(OnSucOrError cb, int opt)

输入参数

参数名称	参数类型	是否必填	描述
cb	OnSucOrError	是	回调接口
opt	int	是	MessageOpt 会话消息接收选项

代码示例

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

},opt);