Class NSPluginResponse

To be able to respond with more than just a true/false, but also an explanation. Such an explanation can be displayed on for instance a disabled Place Order button.

Syntax

Constructors

NSPluginResponse()

Initializes a new instance of the NSPluginResponse class.

Declaration

NSPluginResponse

Methods

GetChanges()

To be able to respond with more than just a true/false, but also an explanation. Such an explanation can be displayed on for instance a disabled Place Order button.

Declaration

NSChangedData GetChanges()

Returns

Type	Description
NSChangedData	Table name/record ID of data changed by this method, that the client may need to reload.

Examples

NSPluginResponse thing;
NSChangedData changes = thing.GetChanges();

GetErrorCode()

To be able to respond with more than just a true/false, but also an explanation. Such an explanation can be displayed on for instance a disabled Place Order button.

Declaration

String GetErrorCode()

Returns

Type	Description
String	An error code, if available.

Examples

NSPluginResponse thing;
String errorCode = thing.GetErrorCode();

GetIsOk()

To be able to respond with more than just a true/false, but also an explanation. Such an explanation can be displayed on for instance a disabled Place Order button.

Declaration

Bool GetIsOk()

Returns

Type	Description
Bool	Answer to the question / An indication if the operation went well.

Examples

NSPluginResponse thing;
Bool isOk = thing.GetIsOk();

GetTechExplanation()

To be able to respond with more than just a true/false, but also an explanation. Such an explanation can be displayed on for instance a disabled Place Order button.

Declaration

String GetTechExplanation()

Returns

Type	Description
String	Always in English.

Examples

NSPluginResponse thing;
String techExplanation = thing.GetTechExplanation();

GetUserExplanation()

To be able to respond with more than just a true/false, but also an explanation. Such an explanation can be displayed on for instance a disabled Place Order button.

Declaration

String GetUserExplanation()

Returns

Type	Description
String	A localized explanation to the answer.

Examples

NSPluginResponse thing;
String userExplanation = thing.GetUserExplanation();

SetChanges(NSChangedData)

To be able to respond with more than just a true/false, but also an explanation. Such an explanation can be displayed on for instance a disabled Place Order button.

Declaration

Void SetChanges(NSChangedData changes)

Parameters

Type	Name	Description
NSChangedData	changes	Tablename/recordid of data changed by this method, that the client may need to reload.

Returns

Type	Description
Void

Examples

NSPluginResponse thing;
NSChangedData changes;
thing.SetChanges(changes);

SetErrorCode(String)

To be able to respond with more than just a true/false, but also an explanation. Such an explanation can be displayed on for instance a disabled Place Order button.

Declaration

Void SetErrorCode(String errorCode)

Parameters

Type	Name	Description
String	errorCode	An error code, if available.

Returns

Type	Description
Void

Examples

NSPluginResponse thing;
String errorCode;
thing.SetErrorCode(errorCode);

SetIsOk(Bool)

To be able to respond with more than just a true/false, but also an explanation. Such an explanation can be displayed on for instance a disabled Place Order button.

Declaration

Void SetIsOk(Bool isOk)

Parameters

Type	Name	Description
Bool	isOk	Answer to the question / An indication if the operation went well.

Returns

Type	Description
Void

Examples

NSPluginResponse thing;
Bool isOk;
thing.SetIsOk(isOk);

SetTechExplanation(String)

To be able to respond with more than just a true/false, but also an explanation. Such an explanation can be displayed on for instance a disabled Place Order button.

Declaration

Void SetTechExplanation(String techExplanation)

Parameters

Type	Name	Description
String	techExplanation	Always in English.

Returns

Type	Description
Void

Examples

NSPluginResponse thing;
String techExplanation;
thing.SetTechExplanation(techExplanation);

SetUserExplanation(String)

To be able to respond with more than just a true/false, but also an explanation. Such an explanation can be displayed on for instance a disabled Place Order button.

Declaration

Void SetUserExplanation(String userExplanation)

Parameters

Type	Name	Description
String	userExplanation	A localized explanation to the answer.

Returns

Type	Description
Void

Examples

NSPluginResponse thing;
String userExplanation;
thing.SetUserExplanation(userExplanation);