Packagecom.kaazing.gateway.jms.client
Interfacepublic interface TextMessage extends Message

A TextMessage object is used to send a message containing a String. It inherits from the Message interface and adds a text message body.

This message type can be used to transport text-based messages, including those with XML content.

When a client receives a TextMessage, it is in read-only mode. If a client attempts to write to the message at this point, a MessageNotWriteableException is thrown. If clearBody is called, the message can now be both read from and written to.



Public Properties
 PropertyDefined by
 InheritedcorrelationId : String
Gets the correlation ID for the message.
Message
 InheriteddeliveryMode : int
Gets the DeliveryMode value specified for this message.
Message
 Inheriteddestination : Destination
Gets the Destination object for this message.
Message
 Inheritedexpiration : Number
Gets the message's expiration value.
Message
 InheritedmessageId : String
Gets the message ID.
Message
 Inheritedpriority : int
Gets the message priority level.
Message
 Inheritedredelivered : Boolean
Gets an indication of whether this message is being redelivered.
Message
 InheritedreplyTo : Destination
Gets the Destination object to which a reply to this message should be sent.
Message
  text : String
Gets the string containing this message's data.
TextMessage
 Inheritedtimestamp : Number
Gets the message timestamp.
Message
 Inheritedtype : String
Gets the message type identifier supplied by the client when the message was sent.
Message
Public Methods
 MethodDefined by
 Inherited
acknowledge():void
Acknowledges all consumed messages of the session of this consumed message.
Message
 Inherited
clearBody():void
Clears out the message body.
Message
 Inherited
Clears a message's properties.
Message
 Inherited
getBooleanProperty(name:String):Boolean
Returns the value of the boolean property with the specified name.
Message
 Inherited
getByteProperty(name:String):int
Returns the value of the byte property with the specified name.
Message
 Inherited
getDoubleProperty(name:String):Number
Returns the value of the double property with the specified name.
Message
 Inherited
getFloatProperty(name:String):Number
Returns the value of the float property with the specified name.
Message
 Inherited
getIntProperty(name:String):int
Returns the value of the int property with the specified name.
Message
 Inherited
getLongProperty(name:String):Number
Returns the value of the long property with the specified name.
Message
 Inherited
getObjectProperty(name:String):Object
Returns the value of the object property with the specified name.
Message
 Inherited
Returns an Enumeration of all the property names.
Message
 Inherited
getShortProperty(name:String):int
Returns the value of the short property with the specified name.
Message
 Inherited
getStringProperty(name:String):String
Returns the value of the String property with the specified name.
Message
 Inherited
propertyExists(name:String):Boolean
Indicates whether a property value exists.
Message
 Inherited
setBooleanProperty(name:String, value:Boolean):void
Sets a boolean property value with the specified name into the message.
Message
 Inherited
setByteProperty(name:String, value:int):void
Sets a byte property value with the specified name into the message.
Message
 Inherited
setDoubleProperty(name:String, value:Number):void
Sets a double property value with the specified name into the message.
Message
 Inherited
setFloatProperty(name:String, value:Number):void
Sets a float property value with the specified name into the message.
Message
 Inherited
setIntProperty(name:String, value:int):void
Sets an int property value with the specified name into the message.
Message
 Inherited
setLongProperty(name:String, value:Number):void
Sets a long property value with the specified name into the message.
Message
 Inherited
setObjectProperty(name:String, value:Object):void
Sets a object property value with the specified name into the message.
Message
 Inherited
setShortProperty(name:String, value:int):void
Sets a short property value with the specified name into the message.
Message
 Inherited
setStringProperty(name:String, value:String):void
Sets a String property value with the specified name into the message.
Message
Property detail
textproperty
text:String  [read-write]

Gets the string containing this message's data. The default value is null.

Implementation
    public function get text():String
    public function set text(value:String):void