Class NSEventData
Data related to event handlers.
Constructors
NSEventData()
Initializes a new instance of the NSEventData class.
Declaration
NSEventDataMethods
GetBlockExecution()
Declaration
Bool GetBlockExecution()Examples
NSEventData thing;
Bool blockExecution = thing.GetBlockExecution();Returns
| Type | Description |
| Bool | Whether the context should stop what it is doing (for example, stop saving a sale). |
GetException()
Declaration
String GetException()Examples
NSEventData thing;
String exception = thing.GetException();Returns
| Type | Description |
| String | String containing error message from handler system if it failed. |
GetInputValues()
Declaration
Map GetInputValues()Examples
NSEventData thing;
Map inputValues = thing.GetInputValues();Returns
| Type | Description |
| Map | Environment values sent to the event handler. |
GetMessage()
Declaration
String GetMessage()Examples
NSEventData thing;
String message = thing.GetMessage();Returns
| Type | Description |
| String | A message to be presented to the user. |
Declaration
String GetNavigateTo()Examples
NSEventData thing;
String navigateTo = thing.GetNavigateTo();Returns
| Type | Description |
| String | Where the context should navigate afterwards. |
GetOutputValues()
Declaration
Map GetOutputValues()Examples
NSEventData thing;
Map outputValues = thing.GetOutputValues();Returns
| Type | Description |
| Map | Values sent back to the environment from the event handler. |
GetStateValues()
Declaration
Map GetStateValues()Examples
NSEventData thing;
Map stateValues = thing.GetStateValues();Returns
| Type | Description |
| Map | Values kept between event handlers. |
GetType()
Declaration
Integer GetType()Examples
NSEventData thing;
Integer type = thing.GetType();Returns
| Type | Description |
| Integer | The type of event we are triggered by. See <xref href="CRMScript.NetServer.EventHandlerType" data-throw-if-not-resolved="false"></xref> |
SetBlockExecution(Bool)
Declaration
Void SetBlockExecution(Bool blockExecution)Examples
NSEventData thing;
Bool blockExecution;
thing.SetBlockExecution(blockExecution);Parameters
| Type | Name | Description |
| Bool | blockExecution | Whether the context should stop what it is doing (for example, stop saving a sale). |
Returns
| Type | Description |
| Void |
SetException(String)
Declaration
Void SetException(String exception)Examples
NSEventData thing;
String exception;
thing.SetException(exception);Parameters
| Type | Name | Description |
| String | exception | String containing error message from handler system if it failed. |
Returns
| Type | Description |
| Void |
SetInputValues(Map)
Declaration
Void SetInputValues(Map inputValues)Examples
NSEventData thing;
Map inputValues;
thing.SetInputValues(inputValues);Parameters
| Type | Name | Description |
| Map | inputValues | Environment values sent to the event handler. |
Returns
| Type | Description |
| Void |
SetMessage(String)
Declaration
Void SetMessage(String message)Examples
NSEventData thing;
String message;
thing.SetMessage(message);Parameters
| Type | Name | Description |
| String | message | A message to be presented to the user. |
Returns
| Type | Description |
| Void |
Declaration
Void SetNavigateTo(String navigateTo)Examples
NSEventData thing;
String navigateTo;
thing.SetNavigateTo(navigateTo);Parameters
| Type | Name | Description |
| String | navigateTo | Where the context should navigate afterwards. |
Returns
| Type | Description |
| Void |
SetOutputValues(Map)
Declaration
Void SetOutputValues(Map outputValues)Examples
NSEventData thing;
Map outputValues;
thing.SetOutputValues(outputValues);Parameters
| Type | Name | Description |
| Map | outputValues | Values sent back to the environment from the event handler. |
Returns
| Type | Description |
| Void |
SetStateValues(Map)
Declaration
Void SetStateValues(Map stateValues)Examples
NSEventData thing;
Map stateValues;
thing.SetStateValues(stateValues);Parameters
| Type | Name | Description |
| Map | stateValues | Values kept between event handlers. |
Returns
| Type | Description |
| Void |
SetType(Integer)
Declaration
Void SetType(Integer type)Examples
NSEventData thing;
Integer type;
thing.SetType(type);Parameters
| Type | Name | Description |
| Integer | type | The type of event we are triggered by. See <xref href="CRMScript.NetServer.EventHandlerType" data-throw-if-not-resolved="false"></xref>. |
Returns
| Type | Description |
| Void |