NSPluginUrlResponse - SuperOffice

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()

NSPluginUrlResponse

Initializes a new instance of the NSPluginUrlResponse class.

Methods

GetChanges()

NSChangedData GetChanges()

Returns: CRMScript.NetServer.NSChangedData - Table name/record ID of data changed by this method, that the client may need to reload. Example:

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

GetErrorCode()

String GetErrorCode()

Returns: CRMScript.Global.String - An error code, if available. Example:

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

GetIsOk()

Bool GetIsOk()

Returns: CRMScript.Global.Bool - Answer to the question / An indication if the operation went well. Example:

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

GetTechExplanation()

String GetTechExplanation()

Returns: CRMScript.Global.String - Always in English. Example:

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

GetUrl()

String GetUrl()

Returns: CRMScript.Global.String - URL that the GUI should navigate to/open, if non-blank. The GUI cannot enforce any rules subsequent to opening the requested URL. Example:

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

GetUserExplanation()

String GetUserExplanation()

Returns: CRMScript.Global.String - A localized explanation to the answer. Example:

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

SetChanges(NSChangedData)

Void SetChanges(NSChangedData changes)

Returns: CRMScript.Global.Void Example:

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

SetErrorCode(String)

Void SetErrorCode(String errorCode)

Returns: CRMScript.Global.Void Example:

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

SetIsOk(Bool)

Void SetIsOk(Bool isOk)

Returns: CRMScript.Global.Void Example:

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

SetTechExplanation(String)

Void SetTechExplanation(String techExplanation)

Returns: CRMScript.Global.Void Example:

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

SetUrl(String)

Void SetUrl(String url)

Returns: CRMScript.Global.Void Example:

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

SetUserExplanation(String)

Void SetUserExplanation(String userExplanation)

Returns: CRMScript.Global.Void Example:

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

​Constructors

​NSPluginUrlResponse()

​Methods

​GetChanges()

​GetErrorCode()

​GetIsOk()

​GetTechExplanation()

​GetUrl()

​GetUserExplanation()

​SetChanges(NSChangedData)

​SetErrorCode(String)

​SetIsOk(Bool)

​SetTechExplanation(String)

​SetUrl(String)

​SetUserExplanation(String)

Constructors

NSPluginUrlResponse()

Methods

GetChanges()

GetErrorCode()

GetIsOk()

GetTechExplanation()

GetUrl()

GetUserExplanation()

SetChanges(NSChangedData)

SetErrorCode(String)

SetIsOk(Bool)

SetTechExplanation(String)

SetUrl(String)

SetUserExplanation(String)