IMessage Methods

Creates a user property map (of type IMapContainer) in the meta header of a message. Any existing user property map is overwritten. After adding user properties to this map, it must be closed; if not, it is automatically closed after the associated message is disposed IDisposable.

Whether it is explicitly closed by the client application, or implicitly by the API, any attempt to use this map results in an OperationErrorException with ParamNullReference

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Returns a string representation of the contents of a message in human-readable form.

Returns a string representation of the contents of a message in human-readable form. Dump(MessageDump.Full) is equivalent to calling Dump().

Gets the binary attachment part of the message. If not present, null is returned to the user.

A getter for the suffix of the topic string. If the received message contains a topic destination and the topic begins with the session's topic prefix, this method returns the string following the '/' delimiter that terminates the topic prefix. Returns null if not present.

Gets the user data part of the message. Returns null if not present.

Gets the XML content part of the message. Returns null if not present.

Release all memory associated with this message, returning it to its original state, as if it has just been created.

Sets the reply attribute of the message.

Sets the binary attachment part of the message.

Appends an application-specific suffix to the default topic destination for the session. When the session is established, a unique topic destination is created for the session. This topic is generated by the appliance, and the API subscribes to a wildcard extended topic that is derived by appending './>' to the unique topic destination.

Sets the user data part of the message.

Sets the XML content part of the message.