QATextMessage class

QATextMessage inherits from the QAMessage class and adds a text message body.

Syntax

public class QATextMessage : QAMessage

Members

All members of QATextMessage class, including all inherited members.

Name	Description
beginEnumPropertyNames method	Begins an enumeration of message property names.
castToBinaryMessage method	Casts this QAMessage to a QABinaryMessage.
castToTextMessage method	Casts this QAMessage to a QATextMessage.
clearProperties method	Clears a message's properties.
endEnumPropertyNames method	Frees the resources associated with a message property name enumeration.
getAddress method	Gets the destination address for the QAMessage instance.
getBooleanProperty method	Gets the value of the qa_bool property with the specified name.
getByteProperty method	Gets the value of the qa_byte property with the specified name.
getDoubleProperty method	Gets the value of the qa_double property with the specified name.
getExpiration method	Gets the message's expiration time.
getFloatProperty method	Gets the value of the qa_float property with the specified name.
getInReplyToID method	Gets the ID of the message that this message is in reply to.
getIntProperty method	Gets the value of the qa_int property with the specified name.
getLongProperty method	Gets the value of the qa_long property with the specified name.
getMessageID method	Gets the message ID.
getPriority method	Gets the message priority level.
getPropertyType method	Returns the type of a property with the given name.
getRedelivered method	Indicates whether the message has been previously received but not acknowledged.
getReplyToAddress method	Gets the address to which a reply to this message should be sent.
getShortProperty method	Gets the value of the qa_short property with the specified name.
getStringProperty method	Gets the value of the qa_string property with the specified name.
getText method	Gets the string containing this message's data.
getTextLength method	Returns the text length.
getTimestamp method	Gets the message timestamp.
getTimestampAsString method	Gets the message timestamp as a formatted string.
nextPropertyName method	Returns the message property name for the given enumeration, returning -1 if there are no more property names.
propertyExists method	Indicates whether a property value exists.
readText method	Reads the requested length of text from the current text position into a buffer.
reset method	Repositions the current text position to the beginning.
setAddress method	Sets the destination address for this message.
setBooleanProperty method	Sets the qa_bool property with the specified name to the specified value.
setByteProperty method	Sets a qa_byte property with the specified name to the specified value.
setDoubleProperty method	Sets the qa_double property with the specified name to the specified value.
setFloatProperty method	Sets the qa_float property with the specified name to the specified value.
setInReplyToID method	Sets the In-Reply-To ID for the message.
setIntProperty method	Sets the qa_int property with the specified name to the specified value.
setLongProperty method	Sets the qa_long property with the specified name to the specified value.
setMessageID method	Sets the message ID.
setPriority method	Sets the priority level for this message.
setRedelivered method	Sets an indication of whether this message was redelivered.
setReplyToAddress method	Sets the address to which a reply to this message should be sent.
setShortProperty method	Sets e qa_short property with the specified name to the specified value.
setStringProperty method	Sets a qa_string property with the specified name to the specified value.
setText method	Sets the string containing this message's data.
setTimestamp method	Sets the message timestamp.
writeText method	Concatenates text to the current text.
DEFAULT_PRIORITY variable	The default message priority.
DEFAULT_TIME_TO_LIVE variable	The default message time-to-live value.

Remarks

QATextMessage provides methods to read from and write to the text message body.

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 of values starts from the beginning of the message body. If a client attempts to write a message in read-only mode, a COMMON_MSG_NOT_WRITEABLE_ERROR is set.