Message (android API)

java.lang.Object
- cn.jpush.im.android.api.model.Message

所有已实现的接口:: java.io.Serializable

public abstract class Message
extends java.lang.Object
implements java.io.Serializable

另请参阅:: 序列化表格

方法概要

所有方法静态方法实例方法抽象方法具体方法已过时的方法
限定符和类型	方法和说明
`abstract void`	`cancelSend()` 取消消息的发送，如果消息需要上传附件(图片、语音、文件等)，上传会中断，消息状态变为`MessageStatus.send_cancelled`。
`static java.lang.String`	`collectionToJson(java.util.Collection<Message> messages)` 将Message对象的集合类转换为Json字符串，使用`fromJsonToCollection(String)`转换回来
`static Message`	`fromJson(java.lang.String jsonString)` 从Json字符串转换成Message对象, 转换失败返回null
`static java.util.Collection<Message>`	`fromJsonToCollection(java.lang.String jsonString)` 从Json字符串转换成Collection对象，方便Message的集合类的转换，转换失败返回null
`abstract void`	`getAtUserList(GetUserInfoListCallback callback)` 获取@的群成员userInfo列表
`MessageContent`	`getContent()` 获取消息的内容对象
`ContentType`	`getContentType()` 获取消息的内容类型
`long`	`getCreateTime()` 获取消息被创建的时间
`MessageDirect`	`getDirect()` 获取消息的方向。
`abstract java.lang.String`	`getFromAppKey()` 获取消息发送者的appkey
`java.lang.String`	`getFromID()` 已过时。 deprecated in sdk version 1.1.4. Use `getFromUser()` instead.
`java.lang.String`	`getFromName()` 已过时。 deprecated in sdk version 1.1.4. Use `getFromUser()` instead.
`java.lang.String`	`getFromType()` 获取消息发送者的类型，（sdk用户发送的消息都默认为“user”）
`abstract UserInfo`	`getFromUser()` 获取消息发送者的UserInfo。
`int`	`getId()`
`abstract void`	`getReceiptDetails(GetReceiptDetailsCallback callback)` 获取这条消息的已读回执详情.
`int`	`getSenderUserInfoMTime()` 获取消息发送者userinfo最后的更新时间。
`java.lang.Long`	`getServerMessageId()` 获取消息对应服务器端的messageId
`MessageStatus`	`getStatus()` 获取消息的状态
`abstract java.lang.String`	`getTargetAppKey()` 获取消息发送对象的appkey
`abstract java.lang.String`	`getTargetID()` 已过时。 deprecated in sdk version 1.1.4. Use `getTargetInfo()` instead.
`java.lang.Object`	`getTargetInfo()` 获取消息对象的targetInfo。
`abstract java.lang.String`	`getTargetName()` 已过时。 deprecated in sdk version 1.1.4. Use `getTargetInfo()` instead.
`ConversationType`	`getTargetType()` 获取消息发送对象的类型。
`abstract int`	`getUnreceiptCnt()` 获取针对这条消息还没有发送已读回执的人数.
`abstract long`	`getUnreceiptMtime()` 获取这条消息的未回执人数最后一次更新的时间
`abstract boolean`	`haveRead()` 这条消息的已读状态.
`abstract boolean`	`isAtAll()` 判断消息是否是@所有人消息
`abstract boolean`	`isAtMe()` 判断自己是否在被@的列表中
`abstract boolean`	`isContentDownloadProgressCallbackExists()` 判断这条消息是否已设置了监听下载进度的回调接口
`abstract boolean`	`isContentUploadProgressCallbackExists()` 判断这条消息是否已设置了监听上传进度的回调接口
`abstract boolean`	`isSendCompleteCallbackExists()` 判断这条消息是否已设置了监听发送完成的回调接口
`boolean`	`isSupportForward()` 消息是否支持转发，只有发送成功或收到的消息才可转发`MessageStatus`, 消息类型未知时也不支持转发`ContentType.unknown`
`abstract void`	`setHaveRead(BasicCallback callback)` 将这条消息标记为已读。
`abstract void`	`setOnContentDownloadProgressCallback(ProgressUpdateCallback callback)` 设置监听消息所带附件(图片、语音等)下载进度的回调接口
`abstract void`	`setOnContentUploadProgressCallback(ProgressUpdateCallback callback)` 设置监听消息所带附件(图片、语音等)上传进度的回调接口
`abstract void`	`setOnSendCompleteCallback(BasicCallback sendCompleteCallback)` 设置监听消息发送完成的回调接口
`abstract void`	`setUnreceiptCnt(int unreceipteCnt)` 设置这条消息的未回执人数。
`abstract void`	`setUnreceiptMtime(long unreceipteMtime)` 设置这条消息的未回执人数更新时间。
`java.lang.String`	`toJson()` 将对象转换为Json字符串,使用`fromJson(String)`转换回来

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 方法详细资料
  - getId
```
public int getId()
```
  - getAtUserList
```
public abstract void getAtUserList(GetUserInfoListCallback callback)
```
    获取@的群成员userInfo列表
    
    参数:
    
    callback - 接口回调
    
    从以下版本开始:
    
    2.1.0
  - isAtMe
```
public abstract boolean isAtMe()
```
    判断自己是否在被@的列表中
    
    返回:
    
    true 在;false 不在
    
    从以下版本开始:
    
    2.1.0
  - isAtAll
```
public abstract boolean isAtAll()
```
    判断消息是否是@所有人消息
    
    返回:
    
    true 是 ; false 不是
    
    从以下版本开始:
    
    2.2.0
  - getContent
```
public MessageContent getContent()
```
    获取消息的内容对象
    
    返回:
    
    消息的内容对象
  - getContentType
```
public ContentType getContentType()
```
    获取消息的内容类型
    
    返回:
    
    消息的内容类型
  - getStatus
```
public MessageStatus getStatus()
```
    获取消息的状态
    
    返回:
    
    消息的状态
  - getDirect
```
public MessageDirect getDirect()
```
    获取消息的方向。
    发送（send）或者接收(receive)
    
    返回:
    
    消息的方向
  - getTargetType
```
public ConversationType getTargetType()
```
    获取消息发送对象的类型。
    
    返回:
    
    消息发送对象的类型
  - getCreateTime
```
public long getCreateTime()
```
    获取消息被创建的时间
    
    返回:
    
    消息被创建的时间
  - getFromType
```
public java.lang.String getFromType()
```
    获取消息发送者的类型，（sdk用户发送的消息都默认为“user”）
    
    返回:
    
    消息发送者的类型
  - getFromName
```
@Deprecated
public java.lang.String getFromName()
```
    已过时。 deprecated in sdk version 1.1.4. Use getFromUser() instead.
    
    获取发送者的displayName
    
    返回:
    
    发送者的displayName
  - getFromID
```
@Deprecated
public java.lang.String getFromID()
```
    已过时。 deprecated in sdk version 1.1.4. Use getFromUser() instead.
    
    获取消息发送者的username
    
    返回:
    
    消息发送者的username
  - getFromAppKey
```
public abstract java.lang.String getFromAppKey()
```
    获取消息发送者的appkey
    
    返回:
    
    消息发送者的appkey
  - getFromUser
```
public abstract UserInfo getFromUser()
```
    获取消息发送者的UserInfo。如果这是一条发送的消息（direct == send）,fromUser是用户自己。若是接收到的消息（direct == receive）,fromUser则是消息发送方。
    
    返回:
    
    消息发送者的UserInfo
  - getTargetName
```
@Deprecated
public abstract java.lang.String getTargetName()
```
    已过时。 deprecated in sdk version 1.1.4. Use getTargetInfo() instead.
    
    获取消息发送对象的displayName
    
    返回:
    
    消息发送对象的displayName
  - getTargetID
```
@Deprecated
public abstract java.lang.String getTargetID()
```
    已过时。 deprecated in sdk version 1.1.4. Use getTargetInfo() instead.
    
    获取消息发送对象的targetID,如果是单聊即是会话对象用户的username,如果是群聊则是对象群的groupID
    
    返回:
    
    会话对象的targetID
  - getTargetAppKey
```
public abstract java.lang.String getTargetAppKey()
```
    获取消息发送对象的appkey
    
    返回:
    
    消息发送对象的appkey
  - getTargetInfo
```
public java.lang.Object getTargetInfo()
```
    获取消息对象的targetInfo。如果这是一条单聊消息，则targetInfo就是聊天对象的UserInfo。如果是群聊消息，则targetInfo就是对象群的GroupInfo。
    使用的时候需要强制转换一下类型。
    
    返回:
    
    消息对象的targetInfo
  - setOnContentUploadProgressCallback
```
public abstract void setOnContentUploadProgressCallback(ProgressUpdateCallback callback)
```
    设置监听消息所带附件(图片、语音等)上传进度的回调接口
    
    参数:
    
    callback -
  - isContentUploadProgressCallbackExists
```
public abstract boolean isContentUploadProgressCallbackExists()
```
    判断这条消息是否已设置了监听上传进度的回调接口
    
    返回:
    
    true表示已存在，其他情况为false
  - setOnContentDownloadProgressCallback
```
public abstract void setOnContentDownloadProgressCallback(ProgressUpdateCallback callback)
```
    设置监听消息所带附件(图片、语音等)下载进度的回调接口
    
    参数:
    
    callback -
  - isContentDownloadProgressCallbackExists
```
public abstract boolean isContentDownloadProgressCallbackExists()
```
    判断这条消息是否已设置了监听下载进度的回调接口
    
    返回:
    
    true表示已存在，其他情况为false
  - setOnSendCompleteCallback
```
public abstract void setOnSendCompleteCallback(BasicCallback sendCompleteCallback)
```
    设置监听消息发送完成的回调接口
    
    参数:
    
    sendCompleteCallback -
  - isSendCompleteCallbackExists
```
public abstract boolean isSendCompleteCallbackExists()
```
    判断这条消息是否已设置了监听发送完成的回调接口
    
    返回:
    
    true表示已存在，其他情况为false
  - getServerMessageId
```
public java.lang.Long getServerMessageId()
```
    获取消息对应服务器端的messageId
    
    返回:
  - getSenderUserInfoMTime
```
public int getSenderUserInfoMTime()
```
    获取消息发送者userinfo最后的更新时间。
    
    返回:
    
    消息发送者userinfo最后更新事件，单位-秒
  - haveRead
```
public abstract boolean haveRead()
```
    这条消息的已读状态. 默认所有消息的已读状态都是false,当上层调用setHaveRead(BasicCallback)接口成功后，这条消息的已读状态被更新为true.
    注意这个已读状态只会保存在本地，当本地数据被清除，或者用户更换设备登陆之后，已读状态会被重置为false.
    
    返回:
    
    消息的已读状态. true - 已读,false - 未读
    
    从以下版本开始:
    
    2.3.0
  - setHaveRead
```
public abstract void setHaveRead(BasicCallback callback)
```
    将这条消息标记为已读。如果这条消息的发送方设置了需要已读回执，此时还会给消息发送方发送已读回执，通知发送方此条消息已被阅读. 已读回执发送成功后，消息发送方会收到MessageReceiptStatusChangeEvent事件通知
    对于已发送过已读回执的消息，重复调用此接口也不会重复给对方发送回执。
    注意设置成功之后，这个已读状态只会保存在本地，当本地数据被清除，或者用户更换设备登陆之后，已读状态会被重置为false.
    
    参数:
    
    callback - 回调接口
    
    从以下版本开始:
    
    2.3.0
  - getUnreceiptCnt
```
public abstract int getUnreceiptCnt()
```
    获取针对这条消息还没有发送已读回执的人数. 注意只有当消息的direct为MessageDirect.send,而且发送方在发送消息的时候通过 MessageSendingOptions.setNeedReadReceipt(boolean)接口设置了需要已读回执之后这个接口才会正常返回人数，否则将返回0。
    
    返回:
    
    还未发送已读回执的人数.
    
    从以下版本开始:
    
    2.3.0
  - getUnreceiptMtime
```
public abstract long getUnreceiptMtime()
```
    获取这条消息的未回执人数最后一次更新的时间
    
    返回:
    
    未回执人数最后一次更新的时间，单位毫秒
    
    从以下版本开始:
    
    2.3.0
  - setUnreceiptCnt
```
public abstract void setUnreceiptCnt(int unreceipteCnt)
```
    设置这条消息的未回执人数。
    注意这个接口设置的值仅仅是保存在内存中，不会写入到数据库或者更新到后台
    
    参数:
    
    unreceipteCnt - 未回执人数
    
    从以下版本开始:
    
    2.3.0
  - setUnreceiptMtime
```
public abstract void setUnreceiptMtime(long unreceipteMtime)
```
    设置这条消息的未回执人数更新时间。
    注意这个接口设置的值仅仅是保存在内存中，不会写入到数据库或者更新到后台
    
    参数:
    
    unreceipteMtime - 未回执人数更新时间
    
    从以下版本开始:
    
    2.3.0
  - getReceiptDetails
```
public abstract void getReceiptDetails(GetReceiptDetailsCallback callback)
```
    获取这条消息的已读回执详情. 包括已发送已读回执的UserInfo列表以及未发送已读回执的UserInfo列表。
    只有当消息的MessageDirect为MessageDirect.send、而且这条消息的MessageStatus是 MessageStatus.send_success时，可以查看这条消息的已读回执详情
    
    参数:
    
    callback - 回调接口
    
    从以下版本开始:
    
    2.3.0
  - cancelSend
```
public abstract void cancelSend()
```
    取消消息的发送，如果消息需要上传附件(图片、语音、文件等)，上传会中断，消息状态变为MessageStatus.send_cancelled。
    注意取消操作不一定会成功，通过设置的消息发送回调setOnSendCompleteCallback(BasicCallback)来获取消息发送最终结果，如果消息发送被取消的话回调中错误码为cn.jpush.im.android.ErrorCode.LOCAL_ERROR#LOCAL_OPERATION_CANCELLED代表消息发送取消。
    
    从以下版本开始:
    
    2.8.2
  - toJson
```
public java.lang.String toJson()
```
    将对象转换为Json字符串,使用fromJson(String)转换回来
    
    返回:
    
    json格式的String
    
    从以下版本开始:
    
    2.6.1
  - collectionToJson
```
public static java.lang.String collectionToJson(java.util.Collection<Message> messages)
```
    将Message对象的集合类转换为Json字符串，使用fromJsonToCollection(String)转换回来
    
    参数:
    
    messages -
    
    返回:
    
    json格式的String
    
    从以下版本开始:
    
    2.6.1
  - fromJson
```
public static Message fromJson(java.lang.String jsonString)
```
    从Json字符串转换成Message对象, 转换失败返回null
    
    参数:
    
    jsonString -
    
    返回:
    
    Message，失败返回null
    
    从以下版本开始:
    
    2.6.0
  - fromJsonToCollection
```
public static java.util.Collection<Message> fromJsonToCollection(java.lang.String jsonString)
```
    从Json字符串转换成Collection对象，方便Message的集合类的转换，转换失败返回null
    
    参数:
    
    jsonString -
    
    返回:
    
    Collection，失败返回null
    
    从以下版本开始:
    
    2.6.0
  - isSupportForward
```
public boolean isSupportForward()
```
    消息是否支持转发，只有发送成功或收到的消息才可转发MessageStatus, 消息类型未知时也不支持转发ContentType.unknown
    
    返回:
    
    boolean
    
    从以下版本开始:
    
    2.7.1

类 Message

方法概要

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

方法详细资料

getId

getAtUserList

isAtMe

isAtAll

getContent

getContentType

getStatus

getDirect

getTargetType

getCreateTime

getFromType

getFromName

getFromID

getFromAppKey

getFromUser

getTargetName

getTargetID

getTargetAppKey

getTargetInfo

setOnContentUploadProgressCallback

isContentUploadProgressCallbackExists

setOnContentDownloadProgressCallback

isContentDownloadProgressCallbackExists

setOnSendCompleteCallback

isSendCompleteCallbackExists

getServerMessageId

getSenderUserInfoMTime

haveRead

setHaveRead

getUnreceiptCnt

getUnreceiptMtime

setUnreceiptCnt

setUnreceiptMtime

getReceiptDetails

cancelSend

toJson

collectionToJson

fromJson

fromJsonToCollection

isSupportForward