com.netease.nimlib.sdk.msg.model

Class CustomMessageConfig

java.lang.Object

com.netease.nimlib.sdk.msg.model.CustomMessageConfig

All Implemented Interfaces:

java.io.Serializable

public class CustomMessageConfig
extends java.lang.Object
implements java.io.Serializable

Message configuration for the life cycle of messages and whether to push or count as unread.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
boolean	enableHistory Specify whether to store the message on the server.
boolean	enablePersist Specify whether to persist messages after the user gets offline The default value is true.
boolean	enablePush Specify whether to enable alert.
boolean	enablePushNick Specify whether to push the nickname (valid for iOS clients).
boolean	enableRoaming Specify whether to enable roaming.
boolean	enableRoute Specify whether to enable route.
boolean	enableSelfSync Specify whether to sync a message with other devices.
boolean	enableUnreadCount Specify whether to count the message as unread.
static java.lang.String	KEY_ENABLE_HISTORY
static java.lang.String	KEY_ENABLE_PERSIST
static java.lang.String	KEY_ENABLE_PUSH
static java.lang.String	KEY_ENABLE_PUSH_NICK
static java.lang.String	KEY_ENABLE_ROAMING
static java.lang.String	KEY_ENABLE_ROUTE
static java.lang.String	KEY_ENABLE_SELF_SYNC
static java.lang.String	KEY_ENABLE_UNREAD_COUNT

Constructor Summary

Constructors

Constructor and Description
CustomMessageConfig()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEY_ENABLE_HISTORY

public static java.lang.String KEY_ENABLE_HISTORY

KEY_ENABLE_ROAMING

public static java.lang.String KEY_ENABLE_ROAMING

KEY_ENABLE_SELF_SYNC

public static java.lang.String KEY_ENABLE_SELF_SYNC

KEY_ENABLE_PUSH

public static java.lang.String KEY_ENABLE_PUSH

KEY_ENABLE_PERSIST

public static java.lang.String KEY_ENABLE_PERSIST

KEY_ENABLE_PUSH_NICK

public static java.lang.String KEY_ENABLE_PUSH_NICK

KEY_ENABLE_UNREAD_COUNT

public static java.lang.String KEY_ENABLE_UNREAD_COUNT

KEY_ENABLE_ROUTE

public static java.lang.String KEY_ENABLE_ROUTE

enableHistory

public boolean enableHistory

Specify whether to store the message on the server. If the value is set to false, data retrieved by calling MsgService.pullMessageHistory(IMMessage, int, boolean) will not contain this message.
The default value is true.

enableRoaming

public boolean enableRoaming

Specify whether to enable roaming. If the value is set to false and a message is received by one client, other roaming clients will not receive this message.
The default value is true.

enableSelfSync

public boolean enableSelfSync

Specify whether to sync a message with other devices. If multi-device login is enabled, a message sent on one device will be synced with other devices.
The default value is true.

enablePush

public boolean enablePush

Specify whether to enable alert. If the value is set to true, alerts will show on the system notification bar when the message is received. The default value is true.

enablePushNick

public boolean enablePushNick

Specify whether to push the nickname (valid for iOS clients). If the value is set to true, the iOS client shows the nickname when the message is received. The default value is true.

enableUnreadCount

public boolean enableUnreadCount

Specify whether to count the message as unread. If the value is set to true, the unread count increments by 1 in the recent contacts list when the message is received. The default value is true.

enableRoute

public boolean enableRoute

Specify whether to enable route. If the value is set to true, the message is sent following the default app route. If a endpoint URL is configured for message delivery, the message will be synced. The default value is true.

enablePersist

public boolean enablePersist

Specify whether to persist messages after the user gets offline The default value is true.

Constructor Detail

CustomMessageConfig

public CustomMessageConfig()