Click or drag to resize

IMessage Methods

version: 10.21.0

The IMessage type exposes the following members.

Methods
  NameDescription
Public methodCreateUserPropertyMap
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

Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable.)
Public methodDump
Returns a string representation of the contents of a message in human-readable form.
Public methodDump(MessageDump)
Returns a string representation of the contents of a message in human-readable form. Dump(MessageDump.Full) is equivalent to calling Dump().
Public methodGetBinaryAttachment
Gets the binary attachment part of the message. If not present, null is returned to the user.
Public methodGetDestinationTopicSuffix
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.
Public methodGetUserData
Gets the user data part of the message. Returns null if not present.
Public methodGetXmlContent
Gets the XML content part of the message. Returns null if not present.
Public methodReset
Release all memory associated with this message, returning it to its original state, as if it has just been created.
Public methodSetAsReplyMessage
Sets the reply attribute of the message.
Public methodSetBinaryAttachment
Sets the binary attachment part of the message.
Public methodSetReplyToSuffix
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.
Public methodSetUserData
Sets the user data part of the message.
Public methodSetXmlContent
Sets the XML content part of the message.
Top
See Also