com.aliyun.mns.model

Class Message

java.lang.Object

com.aliyun.mns.model.BaseMessage

com.aliyun.mns.model.Message

public final class Message
extends BaseMessage

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Message.MessageBodyType

Constructor Summary

Constructors

Constructor and Description
Message()
Message(byte[] messageBody)
Message(String messageBody)

Method Summary

Modifier and Type	Method and Description
Integer	getDelaySeconds() 获取消息延时，单位是秒
Integer	getDequeueCount() 获取消息出队次数
Date	getEnqueueTime() 获取消息入队时间
ErrorMessageResult	getErrorMessage()
ErrorMessageResult	getErrorMessageDetail()
Date	getFirstDequeueTime() 获取消息第一次入队时间
String	getMessageBody() 获取消息体，文本类型
String	getMessageBodyAsBase64() Deprecated.
byte[]	getMessageBodyAsBytes() 获取二进制消息体
byte[]	getMessageBodyAsRawBytes() 获取二进制消息体，仅支持转码为UTF－8
String	getMessageBodyAsRawString() 获取文本，UTF-8编码
String	getMessageBodyAsString() 获取文本消息体 解密：base64 charSet： UTF-8
String	getMessageBodyAsString(String charSet) 获取文本消息体，base 64 默认 解密
Date	getNextVisibleTime() 获取消息下次可见时间
Integer	getPriority() 获取消息的优先级
String	getReceiptHandle() 获取消息句柄
boolean	isErrorMessage()
void	setDelaySeconds(int delaySeconds) 设置消息延时，单位是秒
void	setDequeueCount(int dequeueCount)
void	setEnqueueTime(Date enqueueTime)
void	setErrorMessage(ErrorMessageResult errorMessage)
void	setFirstDequeueTime(Date firstDequeueTime)
void	setMessageBody(byte[] messageBody) 设置消息体，二进制类型
void	setMessageBody(byte[] messageBody, Message.MessageBodyType bodyType) 设置消息体，二进制类型 MessageBodyType 为 RAW_STRING时，原String仅支持UTF-8编码
void	setMessageBody(String messageBody) 设置消息体，文本类型，做Base64编码
void	setMessageBody(String messageBody, Message.MessageBodyType bodyType) 设置消息体，指定消息体的类型 MessageBodyType 为 RawString 时，使用UTF-8编码
void	setMessageBodyAsRawString(byte[] messageBody) 设置消息体，文本类型，不做Base64编码
void	setMessageBodyAsRawString(String messageBody) 设置消息体，文本类型，不做Base64编码
void	setNextVisibleTime(Date nextVisibleTime)
void	setPriority(int priority) 设置消息的优先级
void	setReceiptHandle(String receiptHandle) 设置消息句柄
String	toString()

Methods inherited from class com.aliyun.mns.model.BaseMessage

getMessageBodyBytes, getMessageBodyMD5, getMessageId, getOriginalMessageBody, getRequestId, setBaseMessageBody, setBaseMessageBody, setMessageBodyBytes, setMessageBodyMD5, setMessageId, setRequestId

Methods inherited from class java.lang.Object

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

Constructor Detail

Message

public Message()

Message

public Message(String messageBody)

Message

public Message(byte[] messageBody)

Method Detail

getDelaySeconds

public Integer getDelaySeconds()

获取消息延时，单位是秒

Returns:

delay second

setDelaySeconds

public void setDelaySeconds(int delaySeconds)

设置消息延时，单位是秒

Parameters:

delaySeconds - delay seconds

getReceiptHandle

public String getReceiptHandle()

获取消息句柄

Returns:

receipt handle

setReceiptHandle

public void setReceiptHandle(String receiptHandle)

设置消息句柄

Parameters:

receiptHandle - receipt handle

getEnqueueTime

public Date getEnqueueTime()

获取消息入队时间

Returns:

enqueue time

setEnqueueTime

public void setEnqueueTime(Date enqueueTime)

getNextVisibleTime

public Date getNextVisibleTime()

获取消息下次可见时间

Returns:

next visible time

setNextVisibleTime

public void setNextVisibleTime(Date nextVisibleTime)

getFirstDequeueTime

public Date getFirstDequeueTime()

获取消息第一次入队时间

Returns:

date

setFirstDequeueTime

public void setFirstDequeueTime(Date firstDequeueTime)

getDequeueCount

public Integer getDequeueCount()

获取消息出队次数

Returns:

count

setDequeueCount

public void setDequeueCount(int dequeueCount)

setMessageBody

public void setMessageBody(byte[] messageBody)

设置消息体，二进制类型

Specified by:

setMessageBody in class BaseMessage

Parameters:

messageBody - message body

setMessageBodyAsRawString

public void setMessageBodyAsRawString(byte[] messageBody)

设置消息体，文本类型，不做Base64编码

setMessageBody

public void setMessageBody(byte[] messageBody,
                           Message.MessageBodyType bodyType)

设置消息体，二进制类型 MessageBodyType 为 RAW_STRING时，原String仅支持UTF-8编码

Parameters:

messageBody - message body

bodyType - body type

setMessageBody

public void setMessageBody(String messageBody)

设置消息体，文本类型，做Base64编码

Specified by:

setMessageBody in class BaseMessage

Parameters:

messageBody - message body

setMessageBodyAsRawString

public void setMessageBodyAsRawString(String messageBody)

设置消息体，文本类型，不做Base64编码

setMessageBody

public void setMessageBody(String messageBody,
                           Message.MessageBodyType bodyType)

设置消息体，指定消息体的类型 MessageBodyType 为 RawString 时，使用UTF-8编码

Parameters:

messageBody - message body

bodyType - body type

getMessageBody

public String getMessageBody()

获取消息体，文本类型

Specified by:

getMessageBody in class BaseMessage

Returns:

message body

getMessageBodyAsBase64

@Deprecated
public String getMessageBodyAsBase64()

Deprecated.

获取Base64编码的消息体，即 不进行 base64 解密 推荐 getMessageBodyAsRawString()作为替代

getMessageBodyAsString

public String getMessageBodyAsString()

获取文本消息体 解密：base64 charSet： UTF-8

Returns:

message body

getMessageBodyAsString

public String getMessageBodyAsString(String charSet)

获取文本消息体，base 64 默认 解密

getMessageBodyAsRawString

public String getMessageBodyAsRawString()

获取文本，UTF-8编码

Returns:

message body

getMessageBodyAsBytes

public byte[] getMessageBodyAsBytes()

获取二进制消息体

Returns:

message body

getMessageBodyAsRawBytes

public byte[] getMessageBodyAsRawBytes()

获取二进制消息体，仅支持转码为UTF－8

Returns:

message body

getPriority

public Integer getPriority()

获取消息的优先级

Returns:

priority

setPriority

public void setPriority(int priority)

设置消息的优先级

Parameters:

priority - priority

getErrorMessageDetail

public ErrorMessageResult getErrorMessageDetail()

isErrorMessage

public boolean isErrorMessage()

toString

public String toString()

Overrides:

toString in class BaseMessage

getErrorMessage

public ErrorMessageResult getErrorMessage()

setErrorMessage

public void setErrorMessage(ErrorMessageResult errorMessage)