io.rong.models.message

类 UltraGroupMessage

java.lang.Object

io.rong.models.message.MessageModel

io.rong.models.message.UltraGroupMessage

public class UltraGroupMessage
extends MessageModel

超级群消息体

字段概要

字段

限定符和类型	字段和说明
String	busChannel 频道ID，发消息时会对群 ID 下的频道 ID 做合法性校验，如果群 ID 下无此频道 ID 则消息发送终止, 参数合法性校验: a-zA-Z0-9, 禁止包含其它字符，下划线也不行，最长 20 个字符。
Integer	contentAvailable ios静默推送 0关闭 1开启
Integer	isMentioned 是否为 @消息，0 表示为普通消息，1 表示为 @消息，默认为 0。
Integer	isPersisted 针对融云服务端历史消息中是否存储此条消息，客户端则根据消息注册的 ISPERSISTED 标识判断是否存储；针对自定义消息，如果旧版客户端上未注册该消息时，根据此属性确定是否存储在本地，但无法解析显示。

构造器概要

构造器

构造器和说明
UltraGroupMessage()
UltraGroupMessage(String senderId, String[] targetId, String objectName, BaseMessage content, String pushContent, String pushData, Integer isPersisted, Integer contentAvailable)
UltraGroupMessage(String senderId, String[] targetId, String objectName, BaseMessage content, String pushContent, String pushData, Integer isPersisted, Integer contentAvailable, Integer isMentioned)
UltraGroupMessage(String senderId, String[] targetId, String objectName, BaseMessage content, String pushContent, String pushData, Integer isPersisted, Integer contentAvailable, String busChannel)
UltraGroupMessage(String senderId, String[] targetId, String objectName, BaseMessage content, String pushContent, String pushData, String pushExt, Integer isPersisted, Integer contentAvailable)
UltraGroupMessage(String senderId, String[] targetId, String objectName, BaseMessage content, String pushContent, String pushData, String pushExt, Integer isPersisted, Integer contentAvailable, String busChannel)
UltraGroupMessage(String senderId, String[] targetId, String objectName, BaseMessage content, String pushContent, String pushData, String pushExt, Integer isPersisted, Integer contentAvailable, String busChannel, Integer isMentioned)

方法概要

限定符和类型	方法和说明
String	getBusChannel()
Integer	getContentAvailable()
Integer	getIsMentioned()
Integer	getIsPersisted()
String[]	getTargetId() 获取接收群组Id
void	setBusChannel(String busChannel)
UltraGroupMessage	setContent(BaseMessage content)
UltraGroupMessage	setContentAvailable(Integer contentAvailable)
void	setIsMentioned(Integer isMentioned)
UltraGroupMessage	setIsPersisted(Integer isPersisted)
UltraGroupMessage	setObjectName(String objectName) 此属性已经不再使用了，消息类型改为通过 BaseMessage 里的 getType 获取
UltraGroupMessage	setPushContent(String pushContent)
UltraGroupMessage	setPushData(String pushData)
UltraGroupMessage	setPushExt(PushExt pe) 获取PushExt json参数
UltraGroupMessage	setPushExt(String pushExt)
UltraGroupMessage	setSenderId(String senderId)
UltraGroupMessage	setTargetId(String[] targetId) 设置接收群组Id

从类继承的方法 io.rong.models.message.MessageModel

getContent, getObjectName, getPushContent, getPushData, getPushExt, getSenderId

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

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

字段详细资料

isPersisted

public Integer isPersisted

针对融云服务端历史消息中是否存储此条消息，客户端则根据消息注册的 ISPERSISTED 标识判断是否存储；针对自定义消息，如果旧版客户端上未注册该消息时，根据此属性确定是否存储在本地，但无法解析显示。0 表示为不存储、 1 表示为存储，默认为 1 存储消息，此属性不影响离线消息功能，用户未在线时都会转为离线消息存储。

contentAvailable

public Integer contentAvailable

ios静默推送 0关闭 1开启

isMentioned

public Integer isMentioned

是否为 @消息，0 表示为普通消息，1 表示为 @消息，默认为 0。当为 1 时 content 参数中必须携带 mentionedInfo @消息的详细内容。为 0 时则不需要携带 mentionedInfo

busChannel

public String busChannel

频道ID，发消息时会对群 ID 下的频道 ID 做合法性校验，如果群 ID 下无此频道 ID 则消息发送终止, 参数合法性校验: a-zA-Z0-9, 禁止包含其它字符，下划线也不行，最长 20 个字符。

构造器详细资料

UltraGroupMessage

public UltraGroupMessage()

UltraGroupMessage

public UltraGroupMessage(String senderId,
                         String[] targetId,
                         String objectName,
                         BaseMessage content,
                         String pushContent,
                         String pushData,
                         Integer isPersisted,
                         Integer contentAvailable)

参数:

senderId:发送人用户 - Id 。（必传）

targetId:接收群Id，提供多个本参数可以实现向多群发送消息，最多不超过 - 3 个群组。（必传）

content:发送消息内容，参考融云消息类型表.示例说明；如果 - objectName 为自定义消息类型，该参数可自定义格式。（必传）

pushContent:定义显示的 - Push 内容，如果 objectName 为融云内置消息类型时，则发送后用户一定会收到 Push 信息. 如果为自定义消息，则 pushContent 为自定义消息显示的 Push 内容，如果不传则用户不会收到 Push 通知。（可选）

pushData:针对 - iOS 平台为 Push 通知时附加到 payload 中，Android 客户端收到推送消息时对应字段名为 pushData。（可选）

isPersisted:当前版本有新的自定义消息，而老版本没有该自定义消息时，老版本客户端收到消息后是否进行存储，0 - 表示为不存储、 1 表示为存储，默认为 1 存储消息。（可选）

UltraGroupMessage

public UltraGroupMessage(String senderId,
                         String[] targetId,
                         String objectName,
                         BaseMessage content,
                         String pushContent,
                         String pushData,
                         Integer isPersisted,
                         Integer contentAvailable,
                         Integer isMentioned)

UltraGroupMessage

public UltraGroupMessage(String senderId,
                         String[] targetId,
                         String objectName,
                         BaseMessage content,
                         String pushContent,
                         String pushData,
                         String pushExt,
                         Integer isPersisted,
                         Integer contentAvailable)

UltraGroupMessage

public UltraGroupMessage(String senderId,
                         String[] targetId,
                         String objectName,
                         BaseMessage content,
                         String pushContent,
                         String pushData,
                         Integer isPersisted,
                         Integer contentAvailable,
                         String busChannel)

UltraGroupMessage

public UltraGroupMessage(String senderId,
                         String[] targetId,
                         String objectName,
                         BaseMessage content,
                         String pushContent,
                         String pushData,
                         String pushExt,
                         Integer isPersisted,
                         Integer contentAvailable,
                         String busChannel)

UltraGroupMessage

public UltraGroupMessage(String senderId,
                         String[] targetId,
                         String objectName,
                         BaseMessage content,
                         String pushContent,
                         String pushData,
                         String pushExt,
                         Integer isPersisted,
                         Integer contentAvailable,
                         String busChannel,
                         Integer isMentioned)

方法详细资料

setSenderId

public UltraGroupMessage setSenderId(String senderId)

覆盖:

setSenderId 在类中 MessageModel

getTargetId

public String[] getTargetId()

获取接收群组Id

覆盖:

getTargetId 在类中 MessageModel

返回:

String

setTargetId

public UltraGroupMessage setTargetId(String[] targetId)

设置接收群组Id

覆盖:

setTargetId 在类中 MessageModel

返回:

String

setContent

public UltraGroupMessage setContent(BaseMessage content)

覆盖:

setContent 在类中 MessageModel

setPushContent

public UltraGroupMessage setPushContent(String pushContent)

覆盖:

setPushContent 在类中 MessageModel

setPushData

public UltraGroupMessage setPushData(String pushData)

覆盖:

setPushData 在类中 MessageModel

setPushExt

public UltraGroupMessage setPushExt(String pushExt)

覆盖:

setPushExt 在类中 MessageModel

setPushExt

public UltraGroupMessage setPushExt(PushExt pe)

从类复制的说明: MessageModel

获取PushExt json参数

覆盖:

setPushExt 在类中 MessageModel

参数:

pe - 构建的 PushExt 对象

返回:

getIsPersisted

public Integer getIsPersisted()

setIsPersisted

public UltraGroupMessage setIsPersisted(Integer isPersisted)

getContentAvailable

public Integer getContentAvailable()

setContentAvailable

public UltraGroupMessage setContentAvailable(Integer contentAvailable)

setObjectName

public UltraGroupMessage setObjectName(String objectName)

从类复制的说明: MessageModel

此属性已经不再使用了，消息类型改为通过 BaseMessage 里的 getType 获取

覆盖:

setObjectName 在类中 MessageModel

getBusChannel

public String getBusChannel()

setBusChannel

public void setBusChannel(String busChannel)

getIsMentioned

public Integer getIsMentioned()

setIsMentioned

public void setIsMentioned(Integer isMentioned)