Class Message
-
- All Implemented Interfaces:
public class Message消息实体,用来容纳和存储客户端收到的消息信息,对应聊天界面中的消息。
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enumMessage.MessageDirection消息方向枚举。
public enumMessage.SentStatus发送出的消息的状态。
public classMessage.ReceivedStatus接收到的消息的状态。
是一个按位标记的枚举,可以进行位运算。
-
Field Summary
Fields Modifier and Type Field Description public final static Creator<Message>CREATORpublic ConversationTypeconversationTypepublic StringtargetIdpublic StringchannelIdpublic intmessageIdpublic Message.MessageDirectionmessageDirectionpublic StringsenderUserIdpublic Message.ReceivedStatusreceivedStatuspublic Message.SentStatussentStatuspublic longreceivedTimepublic longsentTimepublic longreadTimepublic StringobjectNamepublic MessageContentcontentpublic Stringextrapublic ReadReceiptInforeadReceiptInfopublic ReadReceiptInfoV4readReceiptInfoV4public MessageConfigmessageConfigpublic MessagePushConfigmessagePushConfigpublic booleanisOfflinepublic Map<String, String>expansionpublic booleanisEmptyContent
-
Constructor Summary
Constructors Constructor Description Message()默认构造函数。 Message(NativeObject.Message msg)构造函数 Message(Parcel in)
-
Method Summary
Modifier and Type Method Description ConversationTypegetConversationType()获取会话类型。 voidsetConversationType(ConversationType conversationType)设置会话类型。 StringgetTargetId()获取目标 id。 根据不同的 conversationType,可能是聊天 id、讨论组 id、群组 id 或聊天室 id。 voidsetTargetId(String targetId)设置目标 id。 根据不同的 conversationType,可能是聊天 id、讨论组 id、群组 id 或聊天室 id。 StringgetChannelId()voidsetChannelId(String channelId)intgetMessageId()获取本地存储的消息的唯一值(数据库索引唯一值)。 voidsetMessageId(int messageId)设置本地存储的消息的唯一值(数据库索引唯一值)。 Message.MessageDirectiongetMessageDirection()获取消息方向。 voidsetMessageDirection(Message.MessageDirection messageDirection)设置消息方向。 StringgetSenderUserId()获取发送消息的用户 id。 voidsetSenderUserId(String senderUserId)设置发送消息的用户 id。 Message.ReceivedStatusgetReceivedStatus()获取消息的接收状态。 voidsetReceivedStatus(Message.ReceivedStatus receivedStatus)设置消息的接收状态。 Message.SentStatusgetSentStatus()获取消息的发送状态。 voidsetSentStatus(Message.SentStatus sentStatus)设置消息的发送状态。 longgetReceivedTime()获取消息接收时间(Unix 时间戳、毫秒)。 接收时间为消息到达接收客户端时客户端的本地时间。 voidsetReceivedTime(long receivedTime)设置消息接收时间(Unix 时间戳、毫秒)。 接收时间为消息到达接收客户端时客户端的本地时间。 longgetSentTime()获取消息发送时间(Unix 时间戳、毫秒)。 发送时间为消息从发送客户端到达服务器时服务器的本地时间。 voidsetSentTime(long sentTime)设置消息发送时间(Unix 时间戳、毫秒)。 发送时间为消息从发送客户端到达服务器时服务器的本地时间。 longgetReadTime()voidsetReadTime(long readTime)StringgetObjectName()获取消息对象名称。 消息对象名称即 io.rong.imlib. voidsetObjectName(String objectName)设置消息对象名称。 消息对象名称即 io.rong.imlib. MessageContentgetContent()获取消息内容。 voidsetContent(MessageContent content)设置消息内容。 StringgetExtra()获取消息的附加信息。 voidsetExtra(String extra)设置消息的附加信息。 ReadReceiptInfogetReadReceiptInfo()voidsetReadReceiptInfo(ReadReceiptInfo readReceiptInfo)ReadReceiptInfoV4getReadReceiptInfoV4()voidsetReadReceiptInfoV4(ReadReceiptInfoV4 readReceiptInfo)MessageConfiggetMessageConfig()获取消息配置 voidsetMessageConfig(MessageConfig messageConfig)设置消息配置 MessagePushConfiggetMessagePushConfig()获取推送配置 voidsetMessagePushConfig(MessagePushConfig messagePushConfig)设置推送配置 booleanisOffline()是否是离线消息,只在接收消息的回调方法中有效,如果消息为离线消息,则为 YES ;其他情况均为 NO voidsetOffline(boolean offLine)Map<String, String>getExpansion()消息扩展信息列表 booleanisEmptyContent()static Messageobtain(String targetId, ConversationType type, MessageContent content)static Messageobtain(ConversationIdentifier conversationIdentifier, MessageContent content)static Messageobtain(String targetId, ConversationType type, String channelId, MessageContent content)intdescribeContents()voidwriteToParcel(Parcel dest, int flags)StringgetUId()获取服务器消息唯一 id(在同一个 Appkey 下全局唯一) voidsetUId(String UId)设置服务器消息唯一 id(在同一个 Appkey 下全局唯一) booleanisCanIncludeExpansion()消息是否可以包含扩展信息 该属性在消息发送时确定,发送之后不能再做修改;扩展信息只支持单聊和群组,其它会话类型不能设置扩展信息。 voidsetExpansion(HashMap<String, String> expansion)设置消息扩展信息列表 扩展信息只支持单聊和群组,其它t会话类型不能设置扩展信息。 默认消息扩展字典 key 长度不超过 32 ,value 长度不超过 4096 ,单次设置扩展数量最大为 20,消息的扩展总数不能超过 300 GroupReadReceiptInfoV2getGroupReadReceiptInfoV2()voidsetGroupReadReceiptInfoV2(GroupReadReceiptInfoV2 v2)booleanisMayHasMoreMessagesBefore()booleanisHasChanged()inthashCode()booleanequals(Object o)StringtoString()voidsetCanIncludeExpansion(boolean canIncludeExpansion)设置是否可以包含扩展信息 voidsetHasChanged(boolean hasChanged)-
-
Constructor Detail
-
Message
Message()
默认构造函数。
-
Message
Message(NativeObject.Message msg)
构造函数- Parameters:
msg- 初始化消息实体
-
Message
Message(Parcel in)
-
-
Method Detail
-
getConversationType
ConversationType getConversationType()
获取会话类型。
- Returns:
会话类型。
-
setConversationType
void setConversationType(ConversationType conversationType)
设置会话类型。
- Parameters:
conversationType- 会话类型。
-
getTargetId
String getTargetId()
获取目标 id。
根据不同的 conversationType,可能是聊天 id、讨论组 id、群组 id 或聊天室 id。
- Returns:
目标 id 的值。
-
setTargetId
void setTargetId(String targetId)
设置目标 id。
根据不同的 conversationType,可能是聊天 id、讨论组 id、群组 id 或聊天室 id。
- Parameters:
targetId- 目标 id 的值。
-
getChannelId
String getChannelId()
-
setChannelId
void setChannelId(String channelId)
-
getMessageId
int getMessageId()
获取本地存储的消息的唯一值(数据库索引唯一值)。
- Returns:
消息本地存储的消息的唯一值(数据库索引唯一值)。
-
setMessageId
void setMessageId(int messageId)
设置本地存储的消息的唯一值(数据库索引唯一值)。
- Parameters:
messageId- 本地存储的消息的唯一值(数据库索引唯一值)。
-
getMessageDirection
Message.MessageDirection getMessageDirection()
获取消息方向。
- Returns:
消息方向。
-
setMessageDirection
void setMessageDirection(Message.MessageDirection messageDirection)
设置消息方向。
- Parameters:
messageDirection- 消息方向。
-
getSenderUserId
String getSenderUserId()
获取发送消息的用户 id。
- Returns:
发送消息的用户 id。
-
setSenderUserId
void setSenderUserId(String senderUserId)
设置发送消息的用户 id。
- Parameters:
senderUserId- 发送消息的用户 id。
-
getReceivedStatus
Message.ReceivedStatus getReceivedStatus()
获取消息的接收状态。
- Returns:
消息的接收状态。
-
setReceivedStatus
void setReceivedStatus(Message.ReceivedStatus receivedStatus)
设置消息的接收状态。
- Parameters:
receivedStatus- 消息的接收状态。
-
getSentStatus
Message.SentStatus getSentStatus()
获取消息的发送状态。
- Returns:
消息的发送状态。
-
setSentStatus
void setSentStatus(Message.SentStatus sentStatus)
设置消息的发送状态。
- Parameters:
sentStatus- 消息的发送状态。
-
getReceivedTime
long getReceivedTime()
获取消息接收时间(Unix 时间戳、毫秒)。
接收时间为消息到达接收客户端时客户端的本地时间。
- Returns:
消息接收时间(Unix 时间戳、毫秒)。
-
setReceivedTime
void setReceivedTime(long receivedTime)
设置消息接收时间(Unix 时间戳、毫秒)。
接收时间为消息到达接收客户端时客户端的本地时间。
- Parameters:
receivedTime- 消息接收时间(Unix 时间戳、毫秒)。
-
getSentTime
long getSentTime()
获取消息发送时间(Unix 时间戳、毫秒)。
发送时间为消息从发送客户端到达服务器时服务器的本地时间。
- Returns:
消息发送时间(Unix 时间戳、毫秒)。
-
setSentTime
void setSentTime(long sentTime)
设置消息发送时间(Unix 时间戳、毫秒)。
发送时间为消息从发送客户端到达服务器时服务器的本地时间。
- Parameters:
sentTime- 消息发送时间(Unix 时间戳、毫秒)。
-
getReadTime
long getReadTime()
-
setReadTime
void setReadTime(long readTime)
-
getObjectName
String getObjectName()
获取消息对象名称。
消息对象名称即 io.rong.imlib.MessageTag 注解中的 value 值。
- Returns:
消息对象名称。
-
setObjectName
void setObjectName(String objectName)
设置消息对象名称。
消息对象名称即 io.rong.imlib.MessageTag 注解中的 value 值。
- Parameters:
objectName- 消息对象名称。
-
getContent
MessageContent getContent()
获取消息内容。
- Returns:
消息内容。
-
setContent
void setContent(MessageContent content)
设置消息内容。
- Parameters:
content- 消息内容。
-
getExtra
String getExtra()
获取消息的附加信息。
- Returns:
消息的附加信息。
-
setExtra
void setExtra(String extra)
设置消息的附加信息。
- Parameters:
extra- 消息的附加信息。
-
getReadReceiptInfo
ReadReceiptInfo getReadReceiptInfo()
-
setReadReceiptInfo
void setReadReceiptInfo(ReadReceiptInfo readReceiptInfo)
-
getReadReceiptInfoV4
ReadReceiptInfoV4 getReadReceiptInfoV4()
-
setReadReceiptInfoV4
void setReadReceiptInfoV4(ReadReceiptInfoV4 readReceiptInfo)
-
getMessageConfig
MessageConfig getMessageConfig()
获取消息配置
- Returns:
MessageConfig 消息配置
-
setMessageConfig
void setMessageConfig(MessageConfig messageConfig)
设置消息配置
- Parameters:
messageConfig- 消息配置
-
getMessagePushConfig
MessagePushConfig getMessagePushConfig()
获取推送配置
- Returns:
MessagePushConfig 推送配置
-
setMessagePushConfig
void setMessagePushConfig(MessagePushConfig messagePushConfig)
设置推送配置
- Parameters:
messagePushConfig- 推送配置
-
isOffline
boolean isOffline()
是否是离线消息,只在接收消息的回调方法中有效,如果消息为离线消息,则为 YES ;其他情况均为 NO
-
setOffline
void setOffline(boolean offLine)
-
getExpansion
Map<String, String> getExpansion()
消息扩展信息列表
- Returns:
消息扩展信息列表
-
isEmptyContent
boolean isEmptyContent()
-
obtain
static Message obtain(String targetId, ConversationType type, String channelId, MessageContent content)
-
describeContents
int describeContents()
-
writeToParcel
void writeToParcel(Parcel dest, int flags)
-
getUId
String getUId()
获取服务器消息唯一 id(在同一个 Appkey 下全局唯一)
- Returns:
uid 服务器消息唯一 id(在同一个 Appkey 下全局唯一)
-
setUId
void setUId(String UId)
设置服务器消息唯一 id(在同一个 Appkey 下全局唯一)
- Parameters:
UId- 服务器消息唯一 id(在同一个 Appkey 下全局唯一)
-
isCanIncludeExpansion
boolean isCanIncludeExpansion()
消息是否可以包含扩展信息
该属性在消息发送时确定,发送之后不能再做修改;扩展信息只支持单聊和群组,其它会话类型不能设置扩展信息。
- Returns:
消息是否可以包含扩展信息
-
setExpansion
void setExpansion(HashMap<String, String> expansion)
设置消息扩展信息列表
扩展信息只支持单聊和群组,其它t会话类型不能设置扩展信息。
默认消息扩展字典 key 长度不超过 32 ,value 长度不超过 4096 ,单次设置扩展数量最大为 20,消息的扩展总数不能超过 300
- Parameters:
expansion- 消息扩展信息列表
-
getGroupReadReceiptInfoV2
GroupReadReceiptInfoV2 getGroupReadReceiptInfoV2()
-
setGroupReadReceiptInfoV2
void setGroupReadReceiptInfoV2(GroupReadReceiptInfoV2 v2)
-
isMayHasMoreMessagesBefore
boolean isMayHasMoreMessagesBefore()
-
isHasChanged
boolean isHasChanged()
-
hashCode
int hashCode()
-
equals
boolean equals(Object o)
-
toString
String toString()
-
setCanIncludeExpansion
void setCanIncludeExpansion(boolean canIncludeExpansion)
设置是否可以包含扩展信息
- Parameters:
canIncludeExpansion- 是否可以包含扩展信息
-
setHasChanged
void setHasChanged(boolean hasChanged)
-
-
-
-