Class ConnectorResultBaseWS
Response object used by plugin/connector actions, to tell the caller how well the call went.
Inheritance
ConnectorResultBaseWS
Inherited Members
Namespace: SuperOffice.ErpSync
Assembly: SuperOffice.Plugins.dll
Syntax
public class ConnectorResultBaseWS
Constructors
ConnectorResultBaseWS()
Default constructor, creates an Ok response
Declaration
public ConnectorResultBaseWS()
Properties
ErrorCode
An error code, if available.
Declaration
public string ErrorCode { get; set; }
Property Value
Type | Description |
---|---|
string |
IsOk
A bool simplification of the response state
Declaration
public bool IsOk { get; set; }
Property Value
Type | Description |
---|---|
bool |
State
Full response state
Declaration
public ResponseStateWS State { get; set; }
Property Value
Type | Description |
---|---|
ResponseStateWS |
TechExplanation
Always in English
Declaration
public string TechExplanation { get; set; }
Property Value
Type | Description |
---|---|
string |
UserExplanation
A localized explanation to the answer.
Declaration
public string UserExplanation { get; set; }
Property Value
Type | Description |
---|---|
string |
Methods
Merge(ConnectorResultBaseWS)
Concatenates two response object into one. If one is ok and the other not, then the 'not' wins. The text is conactenated with lineends.
Declaration
public ConnectorResultBaseWS Merge(ConnectorResultBaseWS rhs)
Parameters
Type | Name | Description |
---|---|---|
ConnectorResultBaseWS | rhs | The object to merge into this. |
Returns
Type | Description |
---|---|
ConnectorResultBaseWS |