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.
Constructors
NSPluginUrlResponse()
Initializes a new instance of the NSPluginUrlResponse class.
Declaration
NSPluginUrlResponseMethods
GetChanges()
Declaration
NSChangedData GetChanges()Examples
NSPluginUrlResponse thing;
NSChangedData changes = thing.GetChanges();Returns
| Type | Description |
| NSChangedData | Table name/record ID of data changed by this method, that the client may need to reload. |
GetErrorCode()
Declaration
String GetErrorCode()Examples
NSPluginUrlResponse thing;
String errorCode = thing.GetErrorCode();Returns
| Type | Description |
| String | An error code, if available. |
GetIsOk()
Declaration
Bool GetIsOk()Examples
NSPluginUrlResponse thing;
Bool isOk = thing.GetIsOk();Returns
| Type | Description |
| Bool | Answer to the question / An indication if the operation went well. |
GetTechExplanation()
Declaration
String GetTechExplanation()Examples
NSPluginUrlResponse thing;
String techExplanation = thing.GetTechExplanation();Returns
| Type | Description |
| String | Always in English. |
GetUrl()
Declaration
String GetUrl()Examples
NSPluginUrlResponse thing;
String url = thing.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. |
GetUserExplanation()
Declaration
String GetUserExplanation()Examples
NSPluginUrlResponse thing;
String userExplanation = thing.GetUserExplanation();Returns
| Type | Description |
| String | A localized explanation to the answer. |
SetChanges(NSChangedData)
Declaration
Void SetChanges(NSChangedData changes)Examples
NSPluginUrlResponse thing;
NSChangedData changes;
thing.SetChanges(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 |
SetErrorCode(String)
Declaration
Void SetErrorCode(String errorCode)Examples
NSPluginUrlResponse thing;
String errorCode;
thing.SetErrorCode(errorCode);Parameters
| Type | Name | Description |
| String | errorCode | An error code, if available. |
Returns
| Type | Description |
| Void |
SetIsOk(Bool)
Declaration
Void SetIsOk(Bool isOk)Examples
NSPluginUrlResponse thing;
Bool isOk;
thing.SetIsOk(isOk);Parameters
| Type | Name | Description |
| Bool | isOk | Answer to the question / An indication if the operation went well. |
Returns
| Type | Description |
| Void |
SetTechExplanation(String)
Declaration
Void SetTechExplanation(String techExplanation)Examples
NSPluginUrlResponse thing;
String techExplanation;
thing.SetTechExplanation(techExplanation);Parameters
| Type | Name | Description |
| String | techExplanation | Always in English. |
Returns
| Type | Description |
| Void |
SetUrl(String)
Declaration
Void SetUrl(String url)Examples
NSPluginUrlResponse thing;
String url;
thing.SetUrl(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 |
SetUserExplanation(String)
Declaration
Void SetUserExplanation(String userExplanation)Examples
NSPluginUrlResponse thing;
String userExplanation;
thing.SetUserExplanation(userExplanation);Parameters
| Type | Name | Description |
| String | userExplanation | A localized explanation to the answer. |
Returns
| Type | Description |
| Void |