NIMSDK-AOS  10.6.0
Public 属性 | 静态 Public 属性 | 所有成员列表
com.netease.nimlib.sdk.msg.model.CustomMessageConfig类 参考

消息的配置选项,主要用于设定消息的声明周期,是否需要推送,是否需要计入未读数等。 更多...

类 com.netease.nimlib.sdk.msg.model.CustomMessageConfig 继承关系图:

Public 属性

boolean enableHistory = true
 该消息是否要保存到服务器,如果为false,通过MsgService#pullMessageHistory(IMMessage, int, boolean)拉取的结果将不包含该条消息。
默认为true。 更多...
 
boolean enableRoaming = true
 该消息是否需要漫游。如果为false,一旦某一个客户端收取过该条消息,其他端将不会再漫游到该条消息。
默认为true 更多...
 
boolean enableSelfSync = true
 多端同时登录时,发送一条自定义消息后,是否要同步到其他同时登录的客户端。
默认为true 更多...
 
boolean enablePush = true
 该消息是否要消息提醒,如果为true,那么对方收到消息后,系统通知栏会有提醒。 默认为true 更多...
 
boolean enablePushNick = true
 该消息是否需要推送昵称(针对iOS客户端有效),如果为true,那么对方收到消息后,iOS端将显示推送昵称。 默认为true 更多...
 
boolean enableUnreadCount = true
 该消息是否要计入未读数,如果为true,那么对方收到消息后,最近联系人列表中未读数加1。 默认为true 更多...
 
boolean enableRoute = true
 该消息是否支持路由,如果为true,默认按照app的路由开关(如果有配置抄送地址则将抄送该消息) 默认为true 更多...
 
boolean enablePersist = true
 该消息是否要存离线 默认为true 更多...
 

静态 Public 属性

static final String KEY_ENABLE_HISTORY = "KEY_ENABLE_HISTORY"
 
static final String KEY_ENABLE_ROAMING = "KEY_ENABLE_ROAMING"
 
static final String KEY_ENABLE_SELF_SYNC = "KEY_ENABLE_SELF_SYNC"
 
static final String KEY_ENABLE_PUSH = "KEY_ENABLE_PUSH"
 
static final String KEY_ENABLE_PERSIST = "KEY_ENABLE_PERSIST"
 
static final String KEY_ENABLE_PUSH_NICK = "KEY_ENABLE_PUSH_NICK"
 
static final String KEY_ENABLE_UNREAD_COUNT = "KEY_ENABLE_UNREAD_COUNT"
 
static final String KEY_ENABLE_ROUTE = "KEY_ENABLE_ROUTE"
 
static final String KEY_V2_ROUTE_ENV = "KEY_V2_ROUTE_ENV"
 
static final String KEY_V2_CONVERSATION_UPDATE_ENABLED = "KEY_V2_CONVERSATION_UPDATE_ENABLED"
 

详细描述

消息的配置选项,主要用于设定消息的声明周期,是否需要推送,是否需要计入未读数等。

在文件 CustomMessageConfig.java10 行定义.

类成员变量说明

◆ enableHistory

boolean com.netease.nimlib.sdk.msg.model.CustomMessageConfig.enableHistory = true

该消息是否要保存到服务器,如果为false,通过MsgService#pullMessageHistory(IMMessage, int, boolean)拉取的结果将不包含该条消息。
默认为true。

在文件 CustomMessageConfig.java28 行定义.

◆ enablePersist

boolean com.netease.nimlib.sdk.msg.model.CustomMessageConfig.enablePersist = true

该消息是否要存离线 默认为true

在文件 CustomMessageConfig.java70 行定义.

◆ enablePush

boolean com.netease.nimlib.sdk.msg.model.CustomMessageConfig.enablePush = true

该消息是否要消息提醒,如果为true,那么对方收到消息后,系统通知栏会有提醒。 默认为true

在文件 CustomMessageConfig.java46 行定义.

◆ enablePushNick

boolean com.netease.nimlib.sdk.msg.model.CustomMessageConfig.enablePushNick = true

该消息是否需要推送昵称(针对iOS客户端有效),如果为true,那么对方收到消息后,iOS端将显示推送昵称。 默认为true

在文件 CustomMessageConfig.java52 行定义.

◆ enableRoaming

boolean com.netease.nimlib.sdk.msg.model.CustomMessageConfig.enableRoaming = true

该消息是否需要漫游。如果为false,一旦某一个客户端收取过该条消息,其他端将不会再漫游到该条消息。
默认为true

在文件 CustomMessageConfig.java34 行定义.

◆ enableRoute

boolean com.netease.nimlib.sdk.msg.model.CustomMessageConfig.enableRoute = true

该消息是否支持路由,如果为true,默认按照app的路由开关(如果有配置抄送地址则将抄送该消息) 默认为true

在文件 CustomMessageConfig.java64 行定义.

◆ enableSelfSync

boolean com.netease.nimlib.sdk.msg.model.CustomMessageConfig.enableSelfSync = true

多端同时登录时,发送一条自定义消息后,是否要同步到其他同时登录的客户端。
默认为true

在文件 CustomMessageConfig.java40 行定义.

◆ enableUnreadCount

boolean com.netease.nimlib.sdk.msg.model.CustomMessageConfig.enableUnreadCount = true

该消息是否要计入未读数,如果为true,那么对方收到消息后,最近联系人列表中未读数加1。 默认为true

在文件 CustomMessageConfig.java58 行定义.

◆ KEY_ENABLE_HISTORY

final String com.netease.nimlib.sdk.msg.model.CustomMessageConfig.KEY_ENABLE_HISTORY = "KEY_ENABLE_HISTORY"
static

在文件 CustomMessageConfig.java12 行定义.

◆ KEY_ENABLE_PERSIST

final String com.netease.nimlib.sdk.msg.model.CustomMessageConfig.KEY_ENABLE_PERSIST = "KEY_ENABLE_PERSIST"
static

在文件 CustomMessageConfig.java16 行定义.

◆ KEY_ENABLE_PUSH

final String com.netease.nimlib.sdk.msg.model.CustomMessageConfig.KEY_ENABLE_PUSH = "KEY_ENABLE_PUSH"
static

在文件 CustomMessageConfig.java15 行定义.

◆ KEY_ENABLE_PUSH_NICK

final String com.netease.nimlib.sdk.msg.model.CustomMessageConfig.KEY_ENABLE_PUSH_NICK = "KEY_ENABLE_PUSH_NICK"
static

在文件 CustomMessageConfig.java17 行定义.

◆ KEY_ENABLE_ROAMING

final String com.netease.nimlib.sdk.msg.model.CustomMessageConfig.KEY_ENABLE_ROAMING = "KEY_ENABLE_ROAMING"
static

在文件 CustomMessageConfig.java13 行定义.

◆ KEY_ENABLE_ROUTE

final String com.netease.nimlib.sdk.msg.model.CustomMessageConfig.KEY_ENABLE_ROUTE = "KEY_ENABLE_ROUTE"
static

在文件 CustomMessageConfig.java19 行定义.

◆ KEY_ENABLE_SELF_SYNC

final String com.netease.nimlib.sdk.msg.model.CustomMessageConfig.KEY_ENABLE_SELF_SYNC = "KEY_ENABLE_SELF_SYNC"
static

在文件 CustomMessageConfig.java14 行定义.

◆ KEY_ENABLE_UNREAD_COUNT

final String com.netease.nimlib.sdk.msg.model.CustomMessageConfig.KEY_ENABLE_UNREAD_COUNT = "KEY_ENABLE_UNREAD_COUNT"
static

在文件 CustomMessageConfig.java18 行定义.

◆ KEY_V2_CONVERSATION_UPDATE_ENABLED

final String com.netease.nimlib.sdk.msg.model.CustomMessageConfig.KEY_V2_CONVERSATION_UPDATE_ENABLED = "KEY_V2_CONVERSATION_UPDATE_ENABLED"
static

在文件 CustomMessageConfig.java22 行定义.

◆ KEY_V2_ROUTE_ENV

final String com.netease.nimlib.sdk.msg.model.CustomMessageConfig.KEY_V2_ROUTE_ENV = "KEY_V2_ROUTE_ENV"
static

在文件 CustomMessageConfig.java21 行定义.


该类的文档由以下文件生成: