ECMessage (Android Full SDK v5.4.0r API文档)

java.lang.Object
- com.yuntongxun.ecsdk.ECMessage

所有已实现的接口:

android.os.Parcelable, java.lang.Cloneable
```
public class ECMessage
extends java.lang.Object
implements java.lang.Cloneable, android.os.Parcelable
```
IM消息对象

从以下版本开始:

2014-11-13

嵌套类概要

嵌套类
限定符和类型	类和说明
`static class`	`ECMessage.Direction` 消息传输类型（发送、接收、草稿）
`static class`	`ECMessage.MessageStatus` 消息状态
`static class`	`ECMessage.Type` 消息类型

从接口继承的嵌套类/接口 android.os.Parcelable
android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

字段概要

字段
限定符和类型字段和说明

java.lang.String apsAlert

static android.os.Parcelable.Creator<ECMessage> CREATOR

boolean isRead
- 从接口继承的字段 android.os.Parcelable
  CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

字段
限定符和类型	字段和说明
`java.lang.String`	`apsAlert`
`static android.os.Parcelable.Creator<ECMessage>`	`CREATOR`
`boolean`	`isRead`

方法概要

方法
限定符和类型	方法和说明
`java.lang.Object`	`clone()`
`static ECMessage`	`createECMessage(ECMessage.Type type)` 根据需要的类型创建对应的消息
`int`	`describeContents()`
`java.lang.String`	`getApsAlert()`
`ECMessageBody`	`getBody()` 消息内容
`ECMessage.Direction`	`getDirection()` 消息传输类型（发送、接收、草稿）
`java.lang.String`	`getForm()` 消息发送者
`long`	`getId()` 消息数据库中的ID
`java.lang.String`	`getMsgId()` 服务器存储的消息ID
`ECMessage.MessageStatus`	`getMsgStatus()` 消息发送状态
`long`	`getMsgTime()` 消息时间
`java.lang.String`	`getNickName()` 返回发送者昵称
`java.lang.String`	`getSessionId()` 消息会话ID（如果是群组消息则为群组ID、其他为消息创建者）
`java.lang.String`	`getTo()` 消息接收者
`ECMessage.Type`	`getType()` 消息类型
`java.lang.String`	`getUserData()` 消息扩展属性
`int`	`getVersion()`
`boolean`	`isAnonymity()` 是否匿名聊天消息
`boolean`	`isMultimediaBody()` 如果是多媒体消息内容（带附件）
`boolean`	`isNotify()` 判断此消息是否已经通知[通过状态栏提醒]
`boolean`	`isRead()`
`void`	`markNotify(boolean markNotify)` 标识此消息已经通知[通过状态栏提醒]
`void`	`readFromParcel(android.os.Parcel in)`
`void`	`setAnonymity(boolean isAnonymity)` 设置当前发送的消息是否匿名聊天消息
`void`	`setApsAlert(java.lang.String apsAlert)`
`void`	`setBody(ECMessageBody body)` 设置消息内容、可以是文本、附件等
`void`	`setDirection(ECMessage.Direction direction)` 设置消息传输类型
`void`	`setForm(java.lang.String from)` 已过时。
`void`	`setFrom(java.lang.String from)` 设置消息发送者
`void`	`setId(long id)`
`void`	`setIsRead(boolean isRead)`
`void`	`setMsgId(java.lang.String msgId)` 设置服务器存储的消息ID
`void`	`setMsgStatus(ECMessage.MessageStatus msgStatus)` 设置消息的发送状态
`void`	`setMsgTime(long msgTime)` 设置消息发送时间
`void`	`setNickName(java.lang.String nickName)` 将指定的发送者昵称更新到消息中
`void`	`setSessionId(java.lang.String sessionId)` 设置消息会话ID
`void`	`setTo(java.lang.String to)` 设置该消息的接收者
`void`	`setType(ECMessage.Type type)` 设置消息类型
`void`	`setUserData(java.lang.String userData)` 设置消息扩展属性
`void`	`setVersion(int version)`
`void`	`writeToParcel(android.os.Parcel dest, int flags)`

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

- 字段详细资料
  - isRead
```
public boolean isRead
```
  - apsAlert
```
public java.lang.String apsAlert
```
  - CREATOR
```
public static final android.os.Parcelable.Creator<ECMessage> CREATOR
```
- 方法详细资料
  - getApsAlert
```
public java.lang.String getApsAlert()
```
  - setApsAlert
```
public void setApsAlert(java.lang.String apsAlert)
```
  - isRead
```
public boolean isRead()
```
  - setIsRead
```
public void setIsRead(boolean isRead)
```
  - createECMessage
```
public static ECMessage createECMessage(ECMessage.Type type)
```
    根据需要的类型创建对应的消息
    
    参数:
    type - 需要创建的消息类型
    
    返回:
    ECMessage
  - getMsgId
```
public java.lang.String getMsgId()
```
    服务器存储的消息ID
    
    返回:
    the msgId
  - setMsgId
```
public void setMsgId(java.lang.String msgId)
```
    设置服务器存储的消息ID
    
    参数:
    msgId - 服务器存储的消息ID
  - getUserData
```
public java.lang.String getUserData()
```
    消息扩展属性
    
    返回:
    the userData
  - setUserData
```
public void setUserData(java.lang.String userData)
```
    设置消息扩展属性
    
    参数:
    userData - 消息扩展属性
  - getBody
```
public ECMessageBody getBody()
```
    消息内容
    
    返回:
    the body
  - setBody
```
public void setBody(ECMessageBody body)
```
    设置消息内容、可以是文本、附件等
    
    参数:
    body - 文本或者附件
  - getForm
```
public java.lang.String getForm()
```
    消息发送者
    
    返回:
    the form
  - getNickName
```
public java.lang.String getNickName()
```
    返回发送者昵称
    
    返回:
    发送者昵称
  - setNickName
```
public void setNickName(java.lang.String nickName)
```
    将指定的发送者昵称更新到消息中
    
    参数:
    nickName - 发送者昵称
  - setForm
```
@Deprecated
public void setForm(java.lang.String from)
```
    已过时。
    
    另请参阅:
    setFrom(String)
  - setFrom
```
public void setFrom(java.lang.String from)
```
    设置消息发送者
    
    参数:
    from - 消息发送者
  - getTo
```
public java.lang.String getTo()
```
    消息接收者
    
    返回:
    the to
  - setTo
```
public void setTo(java.lang.String to)
```
    设置该消息的接收者
    
    参数:
    to - 消息的接收者
  - getType
```
public ECMessage.Type getType()
```
    消息类型
    
    返回:
    the type
  - setType
```
public void setType(ECMessage.Type type)
```
    设置消息类型
    
    参数:
    type - the type to set
    另请参阅:
    ECMessage.Type
  - getMsgTime
```
public long getMsgTime()
```
    消息时间
    
    返回:
    the msgTime
  - setMsgTime
```
public void setMsgTime(long msgTime)
```
    设置消息发送时间
    
    参数:
    msgTime - the msgTime to set
  - getVersion
```
public int getVersion()
```
  - setVersion
```
public void setVersion(int version)
```
  - getMsgStatus
```
public ECMessage.MessageStatus getMsgStatus()
```
    消息发送状态
    
    返回:
    the msgStatus
  - setMsgStatus
```
public void setMsgStatus(ECMessage.MessageStatus msgStatus)
```
    设置消息的发送状态
    
    参数:
    msgStatus - the msgStatus to set
    另请参阅:
    ECMessage.MessageStatus
  - getId
```
public long getId()
```
    消息数据库中的ID
    
    返回:
    the id
  - setId
```
public void setId(long id)
```
    参数:
    id - the id to set
  - getSessionId
```
public java.lang.String getSessionId()
```
    消息会话ID（如果是群组消息则为群组ID、其他为消息创建者）
    
    返回:
    the sessionId
  - setSessionId
```
public void setSessionId(java.lang.String sessionId)
```
    设置消息会话ID
    
    参数:
    sessionId - 如果是群组消息则为群组ID、其他为消息创建者
  - getDirection
```
public ECMessage.Direction getDirection()
```
    消息传输类型（发送、接收、草稿）
    
    返回:
    the direction
  - setDirection
```
public void setDirection(ECMessage.Direction direction)
```
    设置消息传输类型
    
    参数:
    direction - （发送、接收、草稿）
    另请参阅:
    ECMessage.Direction
  - isAnonymity
```
public boolean isAnonymity()
```
    是否匿名聊天消息
    
    返回:
    是否匿名
  - setAnonymity
```
public void setAnonymity(boolean isAnonymity)
```
    设置当前发送的消息是否匿名聊天消息
    
    参数:
    isAnonymity - 是否匿名聊天消息
  - isMultimediaBody
```
public boolean isMultimediaBody()
```
    如果是多媒体消息内容（带附件）
    
    返回:
    是否多媒体
  - markNotify
```
public void markNotify(boolean markNotify)
```
    标识此消息已经通知[通过状态栏提醒]
  - isNotify
```
public boolean isNotify()
```
    判断此消息是否已经通知[通过状态栏提醒]
    
    返回:
    是否已经提醒
  - describeContents
```
public int describeContents()
```
    指定者:
    
    describeContents 在接口中 android.os.Parcelable
  - writeToParcel
```
public void writeToParcel(android.os.Parcel dest,
                 int flags)
```
    指定者:
    
    writeToParcel 在接口中 android.os.Parcelable
  - readFromParcel
```
public void readFromParcel(android.os.Parcel in)
```
  - clone
```
public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
```
    覆盖:
    
    clone 在类中 java.lang.Object
    
    抛出:
    
    java.lang.CloneNotSupportedException

类 ECMessage

嵌套类概要

从接口继承的嵌套类/接口 android.os.Parcelable

字段概要

从接口继承的字段 android.os.Parcelable

方法概要

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

字段详细资料

isRead

apsAlert

CREATOR

方法详细资料

getApsAlert

setApsAlert

isRead

setIsRead

createECMessage

getMsgId

setMsgId

getUserData

setUserData

getBody

setBody

getForm

getNickName

setNickName

setForm

setFrom

getTo

setTo

getType

setType

getMsgTime

setMsgTime

getVersion

setVersion

getMsgStatus

setMsgStatus

getId

setId

getSessionId

setSessionId

getDirection

setDirection

isAnonymity

setAnonymity

isMultimediaBody

markNotify

isNotify

describeContents

writeToParcel

readFromParcel

clone