QATextMessage interface

QATextMessage inherits from the QAMessage class and adds a text message body, and methods to read from and write to the text message body.

Syntax

public interface QATextMessage

Members

All members of QATextMessage interface, including all inherited members.

Name	Description
clearProperties method	Clear all the properties of the message.
getAddress method	Returns the destination address for the QAMessage instance.
getBooleanProperty method	Gets a boolean message property.
getByteProperty method	Gets a signed byte message property.
getDoubleProperty method	Gets a double message property.
getExpiration method	Returns the message's expiration value, or null if the message does not expire or has not yet been sent.
getFloatProperty method	Gets a float message property.
getInReplyToID method	Returns the message ID of the message to which this message is a reply.
getIntProperty method	Gets an int message property.
getLongProperty method	Gets a long message property.
getMessageID method	Returns the globally unique message ID of the message.
getPriority method	Returns the priority of the message (ranging from 0 to 9).
getProperty method	Gets a message property.
getPropertyNames method	Gets an enumerator over the property names of the message.
getPropertyType method	Returns the property type of the given property.
getRedelivered method	Indicates whether the message has been previously received but not acknowledged.
getReplyToAddress method	Returns the reply-to address of this message.
getShortProperty method	Gets a short message property.
getStringProperty method	Gets a String message property.
getText method	Returns the message text.
getTextLength method	Returns the length, in characters, of the message.
getTimestamp method	Returns the message timestamp, which is the time the message was created.
propertyExists method	Indicates whether the given property has been set for this message.
readText method	Returns unread text from the message.
reset method	Resets the text position of the message to the beginning.
setBooleanProperty method	Sets a boolean property.
setByteProperty method	Sets a signed byte property.
setDoubleProperty method	Sets a double property.
setFloatProperty method	Sets a float property.
setInReplyToID method	Sets the in reply to ID, which identifies the message this message is a reply to.
setIntProperty method	Sets an int property.
setLongProperty method	Sets a long property.
setPriority method	Sets the priority of the message (ranging from 0 to 9).
setProperty method	Sets a property.
setReplyToAddress method	Sets the reply-to address.
setShortProperty method	Sets a short property.
setStringProperty method	Sets a string property.
setText method	Overwrites the message text.
writeText method	Appends text to the text of the message.
DEFAULT_PRIORITY variable	The default message priority.
DEFAULT_TIME_TO_LIVE variable	The default time-to-live value.

When the message is first created, the body of the message is in write-only mode. After a message has been sent, the client that sent it can retain and modify it without affecting the message that has been sent. The same message object can be sent multiple times.

When a message is received, the provider has called QATextMessage.reset() so that the message body is in read-only mode and reading values starts from the beginning of the message body.