Class EventData
EventData containing data related to event handlers
Carrier object for EventData. Services for the EventData Carrier is available from the CustomerService Agent.Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.7.0.0")]
public class EventData : CarrierConstructors
EventData()
Default constructor
Declaration
public EventData()See Also
Properties
BlockExecution
Whether the context should stop what it is doing, e.g. saving a sale
Declaration
[DataMember]
public virtual bool BlockExecution { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
See Also
CgiContent
The Cgi content/body, sent by some events
Declaration
[DataMember]
public virtual string CgiContent { get; set; }Property Value
| Type | Description |
|---|---|
| string |
See Also
CgiVariables
Cgi variables sent by some events
Declaration
[DataMember]
public virtual StringDictionary CgiVariables { get; set; }Property Value
| Type | Description |
|---|---|
| StringDictionary |
See Also
Exception
String containing error message from handler system if it failed
Declaration
[DataMember]
public virtual string Exception { get; set; }Property Value
| Type | Description |
|---|---|
| string |
See Also
Headers
Incoming headers if sent by the context which the script is executed from
Declaration
[DataMember]
public virtual StringDictionary Headers { get; set; }Property Value
| Type | Description |
|---|---|
| StringDictionary |
See Also
InputValues
Environment values sent to the event handler
Declaration
[DataMember]
public virtual StringDictionary InputValues { get; set; }Property Value
| Type | Description |
|---|---|
| StringDictionary |
See Also
Message
A message to be presented to the user
Declaration
[DataMember]
public virtual string Message { get; set; }Property Value
| Type | Description |
|---|---|
| string |
See Also
NavigateTo
Where the context should naviate afterwards
Declaration
[DataMember]
public virtual string NavigateTo { get; set; }Property Value
| Type | Description |
|---|---|
| string |
See Also
OutputValues
Values sent back to the environment from the event handler
Declaration
[DataMember]
public virtual StringDictionary OutputValues { get; set; }Property Value
| Type | Description |
|---|---|
| StringDictionary |
See Also
ParserValues
Parser values sent to the event handler
Declaration
[DataMember]
public virtual StringDictionary ParserValues { get; set; }Property Value
| Type | Description |
|---|---|
| StringDictionary |
See Also
ShowDialog
JSON structure of dialog to show
Declaration
[DataMember]
public virtual string ShowDialog { get; set; }Property Value
| Type | Description |
|---|---|
| string |
See Also
StateValues
Values kept between event handlers
Declaration
[DataMember]
public virtual StringDictionary StateValues { get; set; }Property Value
| Type | Description |
|---|---|
| StringDictionary |
See Also
TraceExecution
If true, then the execution will be traced
Declaration
[DataMember]
public virtual bool TraceExecution { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
See Also
Type
The type of event we are triggered by
Declaration
[DataMember]
public virtual EventHandlerType Type { get; set; }Property Value
| Type | Description |
|---|---|
| EventHandlerType |
See Also
Methods
ToString()
Returns the carrier contents as a formatted string.
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| string | The carrier contents. |
See Also
ToString(string)
Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.
Declaration
public string ToString(string prefix)Parameters
| Type | Name | Description |
|---|---|---|
| string | prefix | The line prefix (typically used for indenting) |
Returns
| Type | Description |
|---|---|
| string | The carrier contents. |