An NDoc Documented Class Library

MessageRequestResponse Members

MessageRequestResponse overview

Public Instance Constructors

MessageRequestResponse Overloaded. Initializes a new instance of the MessageRequestResponse class.

Public Instance Properties

MessageId This is the Plugin Message ID value returned in OnMessageRequestCompleted. The received Plugin Message ID indicates that the message was processed.
MessageIsErrorObsolete. MessageIsError has been superseded by the more general addLogMessage method. This method is retained for backwards compatibility with existing plugins. New or updated plugins should use the addLogMessage method instead. Indicates that OutboundMessage should be interpreted as an error-level log message.
OutboundMessage Set to either the generated message, or to an empty string if a message is unavailable (Iguana will poll again later). Ignored if StopChannel is set - it is not possible to transmit a message and request 'stop channel' simultaneously. Deprecated behavior: if MessageIsError is set, the contents of OutboundMessage are interpreted as an error-level log message. This behavior has been retained for backwards compatibility with existing plugins. New or updated plugins should use the addLogMessage method instead.
StopChannel Requests that Iguana stop the channel.
StopChannelErrorFlag Requests that Iguana stop the channel with the error flag set. Only applicable if StopChannel is also set.
StopChannelReason Describes the reason for the 'stop channel' request. Only applicable if StopChannel is also set.

Public Instance Methods

addLogMessage Adds a log message to the Iguana logs.
AddLogValue Add a name-value pair to the logs. This will be inserted by Iguana into the logging system once message processing is complete.
Equals (inherited from Object) 
GetHashCode (inherited from Object) 
GetType (inherited from Object) 
logValue Get the log value associated with a log key. LogValue will hold the value tied to LogKey. If no value is found, LogValue will be "".
RemoveLogValue Remove a name-value pair from the logs.
ToString (inherited from Object) 

Protected Instance Methods

Finalize Destructor.
MemberwiseClone (inherited from Object) 

See Also

MessageRequestResponse Class | iNTERFACEWARE.IGC Namespace