OpenIMSDKDocs

Type at least two characters to search titles and routes.

EN

Language

ENEnglishEnglish docs简中简体中文中文文档
Browse SDKs · uni-app / uni-app x
Platform
SDKsuni-app / uni-app x

Set global message reception

Configure account-level default message reception and notification options across all conversations.

Copy

The globalRecvMsgOpt property defines the account-level default message notification policy across all conversations. Because this preference is separate from display attributes like nicknames and avatars, update it independently from a dedicated settings screen.

Parameters

The globalRecvMsgOpt parameter accepts values of type OpenIMMessageReceiveOption. For account-level configuration, use the following options:

Enum constantNumeric valueDescription
OpenIMMessageReceiveOptionReceive0Normal message reception; notifications and offline push alerts are permitted.
OpenIMMessageReceiveOptionReceiveWithoutNotification2Messages are received silently without offline push or local notification alerts (Do Not Disturb).

Pass OpenIMMessageReceiveOptionReceive to disable account-wide Do Not Disturb, or OpenIMMessageReceiveOptionReceiveWithoutNotification to enable it. Note that OpenIMMessageReceiveOptionDoNotReceive is reserved for specific conversation overrides and should not be offered as an account-level setting.

Code example

import {
  OpenIMMessageReceiveOptionReceiveWithoutNotification,
  setSelfInfo,
} from '@/uni_modules/unix-openim-sdk'

await setSelfInfo({
  globalRecvMsgOpt: OpenIMMessageReceiveOptionReceiveWithoutNotification,
})

Conversation-level recvMsgOpt settings provide finer-grained overrides. When both account-level and conversation-level settings are present, the SDK evaluates them hierarchically; always display the computed state returned by the SDK or server.

Return value

The Promise resolves with void once OpenIMServer updates the account preference.

State changes after the call

A resolved Promise confirms that the server accepted the setting. It does not indicate that the profile update event has completed across all local stores. For event registration and userID state merging, see Update your profile. To re-verify current settings immediately, invoke Get your profile.