User-Level Push Notification Configuration

User-level push configuration refers to the push settings for the currently logged-in user of the app.

tip

• User-level push configuration is different from App Key-level push configuration. App Key-level push configuration applies to all users under the app. You can adjust some App Key-level push service configurations in the RC Console.
• User-level push configuration requires that the App Key has enabled the User-Level Function Settings. To enable this, please submit a ticket.

The following configurations apply to Global IM UIKit, IMLib, or other client SDKs that depend on IMLib/Global IM UIKit.

Set User Push Language Preference

Set the display language preference for push notifications for the currently logged-in user. If the user has not set a preference, the Push Language setting at the App Key level will be used.

RC's built-in message types include some formatted text strings in their default push content. For example, by default, when a user receives a file message in a one-to-one chat, the push notification content will display the simplified Chinese string "[文件]". If the user changes their push language preference to American English en_US, the formatted text string in the notification content will be "[File]" when they receive a file message.

The "[文件]" and "[File]" in the example above are formatted text strings. Currently, RC's server provides formatted text strings for the push content of built-in message types, supporting Simplified Chinese zh_CN, American English en_US, and Arabic ar_SA.

RongIMClient.getInstance().setPushLanguageCode(languageCode,
    new RongIMClient.OperationCallback() {

        /**
         * Success callback
         */
        @Override
        public void onSuccess() {

        }

        /**
         * Error callback
         * @param errorCode Error code
         */
        @Override
        public void onError(RongIMClient.ErrorCode errorCode) {

        }
    });

After successful setup, when the current user receives push notifications for built-in message types, the formatted text strings in the push content will be adjusted according to the corresponding language.

Parameter	Type	Description
languageCode	String	Set the language for push notifications. Currently, RC supports built-in push languages: zh_CN, en_US, ar_SA. For custom push languages, ensure they match the language identifiers in Console > Custom Push Content.
callback	OperationCallback	Operation callback

Currently, RC supports built-in push languages: Simplified Chinese zh_CN, American English en_US, and Arabic ar_SA. Apps can use the Custom Multi-Language Push Template feature to support more push languages in a single notification.

You can also modify the default push language configuration for the App Key in RC via the RC Console, under Configuration > Chat settings > Basic features > Push > Push Language.

Set User Push Notification Detail Preference

By default, push notification content is displayed if the user has not set a preference. This feature allows the currently logged-in user to set whether the details of push notifications should be displayed.

boolean showStatus = false; // Do not display push notification details

RongIMClient.getInstance().setPushContentShowStatus(showStatus,
    new RongIMClient.OperationCallback() {

        /**
         * Success callback
         */
        @Override
        public void onSuccess() {

        }

        /**
         * Error callback
         * @param errorCode Error code
         */
        @Override
        public void onError(RongIMClient.ErrorCode errorCode) {

        }
    });

If set to not display details, the push notification will show a formatted text string such as "You have received a notification" (this formatted text string supports Simplified Chinese zh_CN, American English en_US, and Arabic ar_SA).

Parameter	Type	Description
showStatus	boolean	Whether to display push details. true: Show details. false: Do not show details.
callback	OperationCallback	Operation callback

Note that when sending a message, you can specify forceShowDetailContent to override the recipient's configuration and force the display of push notification details. Below are some platform-specific configurations:

• Android: The MessagePushConfig property of Message. Refer to the MessagePushConfig Property Description in the Android "Send Message" documentation.
• iOS: The RCMessagePushConfig property of RCMessage. Refer to the Configuring Message Push Properties section in the iOS "APNs Push Development Guide".
• Web: IPushConfig
• IM Server API: If the interface provides the forceShowPushContent parameter, this feature is supported.

You can also modify the default configuration for the App Key in RC. If needed, submit a ticket to change the Push Notification Details setting at the App Key level. Once turned off, all push notifications will not display details by default.

Set User Multi-Device Push Reception Preference

Set whether the offline mobile devices of the currently logged-in user should receive push notifications when the user is online on the Web or PC. Note that this interface is only available if the App Key has enabled the Web/PC Online Mobile Push Reception service.

You can modify the App Key-level configuration in the Basic Features page of the Console.

• If the App Key has not enabled Web/PC Online Mobile Push Reception, all app users will not receive push notifications on their offline mobile devices when they are online on the Web or PC. App users cannot modify their preferences.
• If the App Key has enabled Web/PC Online Mobile Push Reception, the currently logged-in user can turn this behavior on or off.

boolean receiveStatus = false; // The current user does not want to receive push notifications when online on Web/PC

RongIMClient.getInstance().setPushReceiveStatus(receiveStatus,
    new RongIMClient.OperationCallback() {

        /**
         * Success callback
         */
        @Override
        public void onSuccess() {

        }

        /**
         * Error callback
         * @param errorCode Error code
         */
        @Override
        public void onError(RongIMClient.ErrorCode errorCode) {

        }
    });

After successfully setting to false, the current user will not receive push notifications on their mobile devices if they are online on the Web or PC.

Parameter	Type	Description
receiveStatus	boolean	Whether the mobile device receives push notifications when other devices are online. true: Receive push. false: Do not receive push.
callback	OperationCallback	Operation callback