Class NSEventData

Data related to event handlers.

Syntax

Constructors

NSEventData()

Initializes a new instance of the NSEventData class.

Declaration

NSEventData

Methods

GetBlockExecution()

Data related to event handlers.

Declaration

Bool GetBlockExecution()

Returns

Type	Description
Bool	Whether the context should stop what it is doing (for example, stop saving a sale).

Examples

NSEventData thing;
Bool blockExecution = thing.GetBlockExecution();

GetException()

Data related to event handlers.

Declaration

String GetException()

Returns

Type	Description
String	String containing error message from handler system if it failed.

Examples

NSEventData thing;
String exception = thing.GetException();

GetInputValues()

Data related to event handlers.

Declaration

Map GetInputValues()

Returns

Type	Description
Map	Environment values sent to the event handler.

Examples

NSEventData thing;
Map inputValues = thing.GetInputValues();

GetMessage()

Data related to event handlers.

Declaration

String GetMessage()

Returns

Type	Description
String	A message to be presented to the user.

Examples

NSEventData thing;
String message = thing.GetMessage();

GetNavigateTo()

Data related to event handlers.

Declaration

String GetNavigateTo()

Returns

Type	Description
String	Where the context should navigate afterwards.

Examples

NSEventData thing;
String navigateTo = thing.GetNavigateTo();

GetOutputValues()

Data related to event handlers.

Declaration

Map GetOutputValues()

Returns

Type	Description
Map	Values sent back to the environment from the event handler.

Examples

NSEventData thing;
Map outputValues = thing.GetOutputValues();

GetStateValues()

Data related to event handlers.

Declaration

Map GetStateValues()

Returns

Type	Description
Map	Values kept between event handlers.

Examples

NSEventData thing;
Map stateValues = thing.GetStateValues();

GetType()

Data related to event handlers.

Declaration

Integer GetType()

Returns

Type	Description
Integer	The type of event we are triggered by. See EventHandlerType

Examples

NSEventData thing;
Integer type = thing.GetType();

SetBlockExecution(Bool)

Data related to event handlers.

Declaration

Void SetBlockExecution(Bool 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

Examples

NSEventData thing;
Bool blockExecution;
thing.SetBlockExecution(blockExecution);

SetException(String)

Data related to event handlers.

Declaration

Void SetException(String exception)

Parameters

Type	Name	Description
String	exception	String containing error message from handler system if it failed.

Returns

Type	Description
Void

Examples

NSEventData thing;
String exception;
thing.SetException(exception);

SetInputValues(Map)

Data related to event handlers.

Declaration

Void SetInputValues(Map inputValues)

Parameters

Type	Name	Description
Map	inputValues	Environment values sent to the event handler.

Returns

Type	Description
Void

Examples

NSEventData thing;
Map inputValues;
thing.SetInputValues(inputValues);

SetMessage(String)

Data related to event handlers.

Declaration

Void SetMessage(String message)

Parameters

Type	Name	Description
String	message	A message to be presented to the user.

Returns

Type	Description
Void

Examples

NSEventData thing;
String message;
thing.SetMessage(message);

SetNavigateTo(String)

Data related to event handlers.

Declaration

Void SetNavigateTo(String navigateTo)

Parameters

Type	Name	Description
String	navigateTo	Where the context should navigate afterwards.

Returns

Type	Description
Void

Examples

NSEventData thing;
String navigateTo;
thing.SetNavigateTo(navigateTo);

SetOutputValues(Map)

Data related to event handlers.

Declaration

Void SetOutputValues(Map outputValues)

Parameters

Type	Name	Description
Map	outputValues	Values sent back to the environment from the event handler.

Returns

Type	Description
Void

Examples

NSEventData thing;
Map outputValues;
thing.SetOutputValues(outputValues);

SetStateValues(Map)

Data related to event handlers.

Declaration

Void SetStateValues(Map stateValues)

Parameters

Type	Name	Description
Map	stateValues	Values kept between event handlers.

Returns

Type	Description
Void

Examples

NSEventData thing;
Map stateValues;
thing.SetStateValues(stateValues);

SetType(Integer)

Data related to event handlers.

Declaration

Void SetType(Integer type)

Parameters

Type	Name	Description
Integer	type	The type of event we are triggered by. See EventHandlerType.

Returns

Type	Description
Void

Examples

NSEventData thing;
Integer type;
thing.SetType(type);