Class PluginResponse
PluginResponse exists 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.
Carrier object for PluginResponse. Services for the PluginResponse Carrier is available from the IQuoteAgent.Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
public class PluginResponse : Carrier
Constructors
PluginResponse()
Default constructor
Declaration
public PluginResponse()
See Also
Properties
Changes
Tablename/recordid of data changed by this method, that the client may need to reload
Declaration
public virtual ChangedData Changes { get; set; }
Property Value
Type | Description |
---|---|
ChangedData |
See Also
ErrorCode
An error code, if available.
Declaration
public virtual string ErrorCode { get; set; }
Property Value
Type | Description |
---|---|
String |
See Also
IsOk
Answer to the question / An indication if the operation went well. Equivalent to Status != Error
Declaration
public virtual bool IsOk { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
See Also
Status
QuoteStatus = Ok / OkWithInfo / Warn / Error. Error implies IsOk = false.
Declaration
public virtual QuoteStatus Status { get; set; }
Property Value
Type | Description |
---|---|
QuoteStatus |
See Also
TechExplanation
Always in English
Declaration
public virtual string TechExplanation { get; set; }
Property Value
Type | Description |
---|---|
String |
See Also
UserExplanation
A localized explanation to the answer. Text here is displayed to the user.
Declaration
public virtual string UserExplanation { get; set; }
Property Value
Type | Description |
---|---|
String |
See Also
Methods
ToString()
Returns the carrier contents as a formatted string.
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
String | The carrier contents. |
See Also
ToString(String)
Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.
Declaration
public string ToString(string prefix)
Parameters
Type | Name | Description |
---|---|---|
String | prefix | The line prefix (typically used for indenting) |
Returns
Type | Description |
---|---|
String | The carrier contents. |