Class PluginResponseInfo

Response object used by plugin/connector actions, to tell the caller how well the call went.

Inheritance
System.Object
PluginResponseInfo
ActorArrayPluginResponse
ActorPluginResponse
FieldMetadataInfoArrayPluginResponse
ListItemArrayPluginResponse
OrderResponseInfo
QuoteAlternativeResponseInfo
QuoteVersionValidatedInfo
PluginResponseInfoWithChanges
StringArrayPluginResponse
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: SuperOffice.CRM
Assembly: SuperOffice.Plugins.dll
Syntax
public class PluginResponseInfo

Constructors

PluginResponseInfo()

Default constructor, creates an Ok response

Declaration
public PluginResponseInfo()

Properties

ErrorCode

An error code, if available.

Declaration
public string ErrorCode { get; set; }
Property Value
Type Description
System.String

IsOk

A bool simplification of the response state: Return true if the State is not ResponseState.Error.

Declaration
public bool IsOk { get; set; }
Property Value
Type Description
Boolean

State

Full response state: Ok, OkWithInfo, Warning or Error. Summarized in the IsOk property: true as long as State is not Error.

Declaration
public ResponseState State { get; set; }
Property Value
Type Description
ResponseState

TechExplanation

Always in English

Declaration
public string TechExplanation { get; set; }
Property Value
Type Description
System.String

UserExplanation

A localized explanation to the answer.

Declaration
public string UserExplanation { get; set; }
Property Value
Type Description
System.String

Methods

Merge(PluginResponseInfo)

Concatenates two response object into one. If one is ok and the other not, then the 'not' wins. The text is concatenated with lineends.

Declaration
public virtual PluginResponseInfo Merge(PluginResponseInfo rhs)
Parameters
Type Name Description
PluginResponseInfo rhs

The object to merge into this.
Returns
Type Description
PluginResponseInfo

SetErrorAndUserExplanation(String, String)

Sets the IsOk to false and the user exp to the expl argument

Declaration
public void SetErrorAndUserExplanation(string expl, string tech = "")
Parameters
Type Name Description
System.String expl
System.String tech

ToString()

ToString override. Returns a readable PluginResponseInfo representation

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.Object.ToString()

Extension Methods

EnumUtil.MapEnums<From, To>(From)