Class PluginUrlResponse

Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll Carrier object for PluginUrlResponse. PluginUrlResponse 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. 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(s)

public class PluginUrlResponse : Carrier

Inheritance

object ← Carrier ← PluginUrlResponse

Inherited Members

Carrier.TableRight, Carrier.FieldProperties, object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()

Constructors

PluginUrlResponse()

Default constructor - defaults any enum props to 0.

public PluginUrlResponse()

Properties

Changes

Tablename/recordid of data changed by this method, that the client may need to reload

public virtual ChangedData Changes { get; set; }

Property Value

ChangedData

ErrorCode

An error code, if available.

public virtual string ErrorCode { get; set; }

Property Value

string

IsOk

Answer to the question / An indication if the operation went well. Equivalent to Status != Error

public virtual bool IsOk { get; set; }

Property Value

bool

Status

QuoteStatus = Ok / OkWithInfo / Warn / Error. Error implies IsOk = false. NULL if unknown enum value.

[JsonIgnore]
public QuoteStatus? Status { get; set; }

Property Value

QuoteStatus?

Status_String

QuoteStatus = Ok / OkWithInfo / Warn / Error. Error implies IsOk = false. Raw string enum value.

[JsonProperty("Status")]
public string Status_String { get; set; }

Property Value

string

TechExplanation

Always in English

public virtual string TechExplanation { get; set; }

Property Value

string

Url

Url that the GUI should navigato to/open, if non-blank. The GUI cannot enforce any rules subsequent to opening the requested url.

public virtual string Url { get; set; }

Property Value

string

UserExplanation

A localized explanation to the answer.

public virtual string UserExplanation { get; set; }

Property Value

string

SuperOffice.WebApi.Data.PluginUrlResponse

Class PluginUrlResponse

Inheritance

Inherited Members

Constructors

PluginUrlResponse()

Properties

Changes

Property Value

ErrorCode

Property Value

IsOk

Property Value

Status

Property Value

See Also

Status_String

Property Value

See Also

TechExplanation

Property Value

Url

Property Value

UserExplanation

Property Value

See Also

​ Class PluginUrlResponse

​Inheritance

​Inherited Members

​Constructors

​ PluginUrlResponse()

​Properties

​ Changes

​Property Value

​ ErrorCode

​Property Value

​ IsOk

​Property Value

​ Status

​Property Value

​See Also

​ Status_String

​Property Value

​See Also

​ TechExplanation

​Property Value

​ Url

​Property Value

​ UserExplanation

​Property Value

​See Also

Class PluginUrlResponse

Inheritance

Inherited Members

Constructors

PluginUrlResponse()

Properties

Changes

Property Value

ErrorCode

Property Value

IsOk

Property Value

Status

Property Value

See Also

Status_String

Property Value

See Also

TechExplanation

Property Value

Url

Property Value

UserExplanation

Property Value

See Also