The IMapMessage type exposes the following members.

Methods

  NameDescription
Public methodAcknowledge
Acknowledges all consumed messages of the session of this consumed message.

All consumed JMS messages support the acknowledge method for use when a client has specified that its JMS session's consumed messages are to be explicitly acknowledged. By invoking acknowledge on a consumed message, a client acknowledges all messages consumed by the session that the message was delivered to.

Calls to acknowledge are ignored for both transacted sessions and sessions specified to use implicit acknowledgement modes.

A client may individually acknowledge each message as it is consumed, or it may choose to acknowledge messages as an application-defined group (which is done by calling acknowledge on the last received message of the group, thereby acknowledging all messages consumed by the session.)

Messages that have been received but not acknowledged may be redelivered.

(Inherited from IMessage.)
Public methodClearBody
Clears out the message body. Clearing a message's body does not clear its header values or property entries.

If this message body was read-only, calling this method leaves the message body in the same state as an empty body in a newly created message.

(Inherited from IMessage.)
Public methodClearProperties
Clears a message's properties.

The message's header fields and body are not cleared.

(Inherited from IMessage.)
Public methodGetBoolean
Returns the boolean value with the specified name.
Public methodGetBooleanProperty
Returns the value of the boolean property with the specified name.
(Inherited from IMessage.)
Public methodGetByte
Returns the byte value with the specified name.
Public methodGetByteProperty
Returns the value of the byte property with the specified name.
(Inherited from IMessage.)
Public methodGetBytes
Returns the byte array value with the specified name.
Public methodGetChar
Returns the Unicode character value with the specified name.
Public methodGetDouble
Returns the double value with the specified name.
Public methodGetDoubleProperty
Returns the value of the double property with the specified name.
(Inherited from IMessage.)
Public methodGetFloat
Returns the float value with the specified name.
Public methodGetFloatProperty
Returns the value of the float property with the specified name.
(Inherited from IMessage.)
Public methodGetInt
Returns the int value with the specified name.
Public methodGetIntProperty
Returns the value of the int property with the specified name.
(Inherited from IMessage.)
Public methodGetLong
Returns the long value with the specified name.
Public methodGetLongProperty
Returns the value of the long property with the specified name.
(Inherited from IMessage.)
Public methodGetObject
Returns the value of the object with the specified name.

This method can be used to return, in objectified format, an object that had been stored in the Map with the equivalent setObject method call, or its equivalent primitive settype method.

Note that byte values are returned as byte[], not Byte[].

Public methodGetObjectProperty
Returns the value of the object property with the specified name.

This method can be used to return, in objectified format, an object that has been stored as a property in the message with the equivalent SetObjectProperty method call, or its equivalent primitive SettypeProperty method.

(Inherited from IMessage.)
Public methodGetShort
Returns the short value with the specified name.
Public methodGetShortProperty
Returns the value of the short property with the specified name.
(Inherited from IMessage.)
Public methodGetString
Returns the String value with the specified name.
Public methodGetStringProperty
Returns the value of the String property with the specified name.
(Inherited from IMessage.)
Public methodItemExists
Indicates whether an item exists in this IMapMessage object.
Public methodPropertyExists
Indicates whether a property value exists.
(Inherited from IMessage.)
Public methodSetBoolean
Sets a boolean value with the specified name into the Map.
Public methodSetBooleanProperty
Sets a boolean property value with the specified name into the message.
(Inherited from IMessage.)
Public methodSetByte
Sets a byte value with the specified name into the Map.
Public methodSetByteProperty
Sets a byte property value with the specified name into the message.
(Inherited from IMessage.)
Public methodSetBytes(String, array<Byte>[]()[][])
Sets a byte array value with the specified name into the Map.
Public methodSetBytes(String, array<Byte>[]()[][], Int32, Int32)
Sets a portion of the byte array value with the specified name into the Map.
Public methodSetChar
Sets a Unicode character value with the specified name into the Map.
Public methodSetDouble
Sets a double value with the specified name into the Map.
Public methodSetDoubleProperty
Sets a double property value with the specified name into the message.
(Inherited from IMessage.)
Public methodSetFloat
Sets a float value with the specified name into the Map.
Public methodSetFloatProperty
Sets a float property value with the specified name into the message.
(Inherited from IMessage.)
Public methodSetInt
Sets an int value with the specified name into the Map.
Public methodSetIntProperty
Sets an int property value with the specified name into the message.
(Inherited from IMessage.)
Public methodSetLong
Sets a long value with the specified name into the Map.
Public methodSetLongProperty
Sets a long property value with the specified name into the message.
(Inherited from IMessage.)
Public methodSetObject
Sets an object value with the specified name into the Map.

This method works only for the objectified primitive object types (Integer, Double, Long...), String objects, and byte arrays.

Public methodSetObjectProperty
Sets a object property value with the specified name into the message.

Note that this method works only for the objectified primitive object types (Integer, Double, Long ...) and String objects.

(Inherited from IMessage.)
Public methodSetShort
Sets a short value with the specified name into the Map.
Public methodSetShortProperty
Sets a short property value with the specified name into the message.
(Inherited from IMessage.)
Public methodSetString
Sets a String value with the specified name into the Map.
Public methodSetStringProperty
Sets a String property value with the specified name into the message.
(Inherited from IMessage.)

See Also