Class NSPluginUrlResponse

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. In addition, an URL can be returned, which the GUI should navigate to/display if it is non-blank. The URL can be an SoProtocol or HTTP or HTTPS.

Syntax

Constructors

NSPluginUrlResponse()

Initializes a new instance of the NSPluginUrlResponse class.

Declaration

NSPluginUrlResponse

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. In addition, an URL can be returned, which the GUI should navigate to/display if it is non-blank. The URL can be an SoProtocol or HTTP or HTTPS.

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

NSPluginUrlResponse 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. In addition, an URL can be returned, which the GUI should navigate to/display if it is non-blank. The URL can be an SoProtocol or HTTP or HTTPS.

Declaration

String GetErrorCode()

Returns

Type	Description
String	An error code, if available.

Examples

NSPluginUrlResponse 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. In addition, an URL can be returned, which the GUI should navigate to/display if it is non-blank. The URL can be an SoProtocol or HTTP or HTTPS.

Declaration

Bool GetIsOk()

Returns

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

Examples

NSPluginUrlResponse 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. In addition, an URL can be returned, which the GUI should navigate to/display if it is non-blank. The URL can be an SoProtocol or HTTP or HTTPS.

Declaration

String GetTechExplanation()

Returns

Type	Description
String	Always in English.

Examples

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

GetUrl()

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. In addition, an URL can be returned, which the GUI should navigate to/display if it is non-blank. The URL can be an SoProtocol or HTTP or HTTPS.

Declaration

String GetUrl()

Returns

Type	Description
String	URL that the GUI should navigate to/open, if non-blank. The GUI cannot enforce any rules subsequent to opening the requested URL.

Examples

NSPluginUrlResponse thing;
String url = thing.GetUrl();

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. In addition, an URL can be returned, which the GUI should navigate to/display if it is non-blank. The URL can be an SoProtocol or HTTP or HTTPS.

Declaration

String GetUserExplanation()

Returns

Type	Description
String	A localized explanation to the answer.

Examples

NSPluginUrlResponse 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. In addition, an URL can be returned, which the GUI should navigate to/display if it is non-blank. The URL can be an SoProtocol or HTTP or HTTPS.

Declaration

Void SetChanges(NSChangedData changes)

Parameters

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

Returns

Type	Description
Void

Examples

NSPluginUrlResponse 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. In addition, an URL can be returned, which the GUI should navigate to/display if it is non-blank. The URL can be an SoProtocol or HTTP or HTTPS.

Declaration

Void SetErrorCode(String errorCode)

Parameters

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

Returns

Type	Description
Void

Examples

NSPluginUrlResponse 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. In addition, an URL can be returned, which the GUI should navigate to/display if it is non-blank. The URL can be an SoProtocol or HTTP or HTTPS.

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

NSPluginUrlResponse 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. In addition, an URL can be returned, which the GUI should navigate to/display if it is non-blank. The URL can be an SoProtocol or HTTP or HTTPS.

Declaration

Void SetTechExplanation(String techExplanation)

Parameters

Type	Name	Description
String	techExplanation	Always in English.

Returns

Type	Description
Void

Examples

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

SetUrl(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. In addition, an URL can be returned, which the GUI should navigate to/display if it is non-blank. The URL can be an SoProtocol or HTTP or HTTPS.

Declaration

Void SetUrl(String url)

Parameters

Type	Name	Description
String	url	URL that the GUI should navigate to/open, if non-blank. The GUI cannot enforce any rules subsequent to opening the requested URL.

Returns

Type	Description
Void

Examples

NSPluginUrlResponse thing;
String url;
thing.SetUrl(url);

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. In addition, an URL can be returned, which the GUI should navigate to/display if it is non-blank. The URL can be an SoProtocol or HTTP or HTTPS.

Declaration

Void SetUserExplanation(String userExplanation)

Parameters

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

Returns

Type	Description
Void

Examples

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