Show / Hide Table of Contents

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

Carrier object for PluginUrlResponse. Services for the PluginUrlResponse Carrier is available from the Quote Agent.
Inheritance
object
PluginUrlResponse
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.1.0.0")]
public class PluginUrlResponse : Carrier

Constructors

PluginUrlResponse()

Default constructor

Declaration
public PluginUrlResponse()
See Also
IQuoteAgent

Properties

Changes

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

Declaration
[DataMember]
public virtual ChangedData Changes { get; set; }
Property Value
Type Description
ChangedData
See Also
IQuoteAgent

ErrorCode

An error code, if available.

Declaration
[DataMember]
public virtual string ErrorCode { get; set; }
Property Value
Type Description
string
See Also
IQuoteAgent

IsOk

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

Declaration
[DataMember]
public virtual bool IsOk { get; set; }
Property Value
Type Description
bool
See Also
IQuoteAgent

Status

QuoteStatus = Ok / OkWithInfo / Warn / Error. Error implies IsOk = false.

Declaration
[DataMember]
public virtual QuoteStatus Status { get; set; }
Property Value
Type Description
QuoteStatus
See Also
IQuoteAgent

TechExplanation

Always in English

Declaration
[DataMember]
public virtual string TechExplanation { get; set; }
Property Value
Type Description
string
See Also
IQuoteAgent

Url

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

Declaration
[DataMember]
public virtual string Url { get; set; }
Property Value
Type Description
string
See Also
IQuoteAgent

UserExplanation

A localized explanation to the answer.

Declaration
[DataMember]
public virtual string UserExplanation { get; set; }
Property Value
Type Description
string
See Also
IQuoteAgent

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
string

The carrier contents.

See Also
IQuoteAgent

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.

See Also
IQuoteAgent

See Also

IQuoteAgent
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top