cn.jpush.im.android.api.options

类 MessageSendingOptions

java.lang.Object

cn.jpush.im.android.api.options.MessageSendingOptions

public class MessageSendingOptions
extends java.lang.Object

针对消息发送动作的控制选项.

从以下版本开始:

2.2.0

构造器概要

构造器

构造器和说明
MessageSendingOptions()

方法概要

限定符和类型	方法和说明
int	getMsgCount() 获取这条消息设置的会话未读消息数量，默认值是1
java.lang.String	getNotificationAtPrefix() 获取当前设置的自定义此条消息在接收方通知栏所展示通知的at信息前缀
java.lang.String	getNotificationText() 获取当前设置的自定义此条消息在接收方通知栏所展示通知的text
java.lang.String	getNotificationTitle() 获取当前设置的自定义此条消息在接收方通知栏所展示通知的title
boolean	isCustomNotficationEnabled() 是否开启了自定义接收方通知栏功能
boolean	isNeedReadReceipt() 获取当前消息发送是否需要对方的已读回执，默认为false.
boolean	isRetainOffline() 是否让后台在对方不在线时保存这条离线消息，等到对方上线后再推送给对方。
boolean	isShowNotification() 接收方是否针对此次消息发送展示通知栏通知
void	setCustomNotificationEnabled(boolean customNotificationEnabled) 设置是否启用自定义这条消息在接收方通知栏所展示的文字.
void	setMsgCount(int msgCount) 设置这条消息的会话未读消息数量，不设置时默认是1，即对方收到消息时会话未读数会加1，设置后对方收到消息时会话未读数会加msgCount
void	setNeedReadReceipt(boolean needReadReceipt) 设置这条消息的发送是否需要对方发送已读回执 开启之后，对方收到消息后，如果调用了Message.setHaveRead(BasicCallback)接口， 则作为消息发送方，会收到事件通知MessageReceiptStatusChangeEvent
void	setNotificationAtPrefix(java.lang.String notificationAtPrefix) 设置此条消息在接收方通知栏所展示通知的at信息前缀.
void	setNotificationText(java.lang.String notificationText) 设置此条消息在接收方通知栏所展示通知的text.
void	setNotificationTitle(java.lang.String notificationTitle) 设置此条消息在接收方通知栏所展示通知的title.
void	setRetainOffline(boolean retainOffline) 设置是否让后台在对方不在线时保存这条离线消息，等到对方上线后再推送给对方。
void	setShowNotification(boolean showNotification) 设置针对本次消息发送，是否需要在消息接收方的通知栏上展示通知

从类继承的方法 java.lang.Object

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

构造器详细资料

MessageSendingOptions

public MessageSendingOptions()

方法详细资料

isRetainOffline

public boolean isRetainOffline()

是否让后台在对方不在线时保存这条离线消息，等到对方上线后再推送给对方。

返回:

true - 保存离线消息，false - 不保存这条离线消息。默认为true

setRetainOffline

public void setRetainOffline(boolean retainOffline)

设置是否让后台在对方不在线时保存这条离线消息，等到对方上线后再推送给对方。 如果设置为false，则当发送方发送消息时，如果接收方不在线，则后台不会保存这条离线消息， 这样对方之后上线了也不会收到这条消息。

参数:

retainOffline - true - 保存离线消息，false - 不保存这条离线消息。默认为true

isShowNotification

public boolean isShowNotification()

接收方是否针对此次消息发送展示通知栏通知

返回:

true - 展示，false - 不展示，默认为true

setShowNotification

public void setShowNotification(boolean showNotification)

设置针对本次消息发送，是否需要在消息接收方的通知栏上展示通知

参数:

showNotification - true - 展示，false - 不展示，默认为true

getNotificationTitle

public java.lang.String getNotificationTitle()

获取当前设置的自定义此条消息在接收方通知栏所展示通知的title

返回:

自定义的title

setNotificationTitle

public void setNotificationTitle(java.lang.String notificationTitle)

设置此条消息在接收方通知栏所展示通知的title. 设置之后，消息接收方原本通知栏所展示的通知的title会被替换。 注意需要调用setCustomNotificationEnabled(boolean)接口 启用自定义通知栏功能之后，该设置才会生效。

参数:

notificationTitle - 在接收方通知栏通知所展示的title

getNotificationAtPrefix

public java.lang.String getNotificationAtPrefix()

获取当前设置的自定义此条消息在接收方通知栏所展示通知的at信息前缀

返回:

自定义的at信息前缀

setNotificationAtPrefix

public void setNotificationAtPrefix(java.lang.String notificationAtPrefix)

设置此条消息在接收方通知栏所展示通知的at信息前缀. 设置之后，如果发送的这条消息是at对方的消息，则会在对方通知栏的text前面加上当前设置的这个前缀。 注意需要调用setCustomNotificationEnabled(boolean)接口 启用自定义通知栏功能之后，该设置才会生效。

参数:

notificationAtPrefix - 在接收方通知栏通知所展示的text

getNotificationText

public java.lang.String getNotificationText()

获取当前设置的自定义此条消息在接收方通知栏所展示通知的text

返回:

自定义的text

setNotificationText

public void setNotificationText(java.lang.String notificationText)

设置此条消息在接收方通知栏所展示通知的text. 设置之后，消息接收方原本通知栏所展示的通知的text会被替换。 注意需要调用setCustomNotificationEnabled(boolean)接口 启用自定义通知栏功能之后，该设置才会生效。

参数:

notificationText - 在接收方通知栏通知所展示的text

isCustomNotficationEnabled

public boolean isCustomNotficationEnabled()

是否开启了自定义接收方通知栏功能

返回:

true - 开启，false - 关闭

setCustomNotificationEnabled

public void setCustomNotificationEnabled(boolean customNotificationEnabled)

设置是否启用自定义这条消息在接收方通知栏所展示的文字. 开启之后，可以通过setNotificationTitle(String) setNotificationText(String) 接口来自定义这条消息在接收方通知栏上所展示的title和text.

参数:

customNotificationEnabled - true - 开启 false - 关闭

isNeedReadReceipt

public boolean isNeedReadReceipt()

获取当前消息发送是否需要对方的已读回执，默认为false.

返回:

是否需要接收方发送已读回执.true - 是,false - 否.

从以下版本开始:

2.3.0

setNeedReadReceipt

public void setNeedReadReceipt(boolean needReadReceipt)

设置这条消息的发送是否需要对方发送已读回执 开启之后，对方收到消息后，如果调用了Message.setHaveRead(BasicCallback)接口， 则作为消息发送方，会收到事件通知MessageReceiptStatusChangeEvent

参数:

needReadReceipt - 是否需要接收方发送已读回执. true - 是,false - 否.

从以下版本开始:

2.3.0

setMsgCount

public void setMsgCount(int msgCount)

设置这条消息的会话未读消息数量，不设置时默认是1，即对方收到消息时会话未读数会加1，设置后对方收到消息时会话未读数会加msgCount

参数:

msgCount - 未读消息数量

从以下版本开始:

2.9.0

getMsgCount

public int getMsgCount()

获取这条消息设置的会话未读消息数量，默认值是1

返回:

未读消息数量

从以下版本开始:

2.9.0