com.interfaceware.iguana.plugin
Class DestinationMessageReceivedEventInputs

java.lang.Object
  extended by com.interfaceware.iguana.plugin.DestinationMessageReceivedEventInputs

public class DestinationMessageReceivedEventInputs
extends java.lang.Object

This class is used to pass data from Iguana to messageReceived and resubmissionPreviewMessageReceived event handlers.


Constructor Summary
DestinationMessageReceivedEventInputs()
           
DestinationMessageReceivedEventInputs(long Handle)
           
 
Method Summary
protected  void finalize()
           
 java.lang.String getMessage()
           Message received from Iguana.
 java.lang.String getMessageLogId()
           Id assigned by Iguana uniquely identifying the received message within Iguana's logs.
 void release()
           
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DestinationMessageReceivedEventInputs

public DestinationMessageReceivedEventInputs()
                                      throws PluginException
Throws:
PluginException

DestinationMessageReceivedEventInputs

public DestinationMessageReceivedEventInputs(long Handle)
                                      throws PluginException
Throws:
PluginException
Method Detail

release

public void release()
             throws PluginException
Throws:
PluginException

finalize

protected void finalize()
                 throws PluginException
Overrides:
finalize in class java.lang.Object
Throws:
PluginException

getMessage

public java.lang.String getMessage()
                            throws PluginException

Message received from Iguana.

Throws:
PluginException

getMessageLogId

public java.lang.String getMessageLogId()
                                 throws PluginException

Id assigned by Iguana uniquely identifying the received message within Iguana's logs.

The Message Log Id may be used to query Iguana for additional message-related information.

See

http://www.interfaceware.com/manual/iguana4_using_message_id.html

Note that Message Log Ids are not supplied to resubmissionPreviewMessageReceived events, since Iguana does not assign Message Log Ids to resubmission preview messages.

Throws:
PluginException