Class BaseLiveIntegrationAddIn

Namespace

Dynamicweb.Ecommerce.Integration

Assembly

Dynamicweb.Ecommerce.dll

The class BaseLiveIntegrationAddIn represents base class for Live Integration Add-ins.

[AddInName("Base Class for Live Integration Add-in")]
public abstract class BaseLiveIntegrationAddIn : ConfigurableAddIn

Inheritance

object

ConfigurableAddIn

BaseLiveIntegrationAddIn

Inherited Members

ConfigurableAddIn.UpdateFromPost(NameValueCollection)

ConfigurableAddIn.GetIdSuitableString(string)

ConfigurableAddIn.LoadParametersFromXml(string)

ConfigurableAddIn.GetParametersToXml()

ConfigurableAddIn.GetParametersToXml(bool)

ConfigurableAddIn.SetValue(string, object)

ConfigurableAddIn.GetInstanceFromParameterXml<T>(string)

ConfigurableAddIn.RenderAdditionalContent(TextWriter)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Inherit from this class for managing settings in DW backend

Properties

SecurityKey

The security key.

[AddInParameter("Security key")]
[AddInParameterEditor(typeof(TextParameterEditor), "inputClass=NewUIinput;")]
public virtual string? SecurityKey { get; set; }

Property Value

string

WebServiceURI

The web service Uri

[AddInParameter("Web service URL")]
[AddInParameterEditor(typeof(TextParameterEditor), "inputClass=NewUIinput;")]
public virtual string? WebServiceURI { get; set; }

Property Value

string

Methods

CreateParameterNode(Type, string, string)

Create the add-in parameter node with the name and value.

protected static XElement? CreateParameterNode(Type parameterType, string name, string value)

Parameters

parameterType Type

Type

name string

Parameter Name

value string

Parameter Value

Returns

XElement

Xml Node suitable for use in Dynamicweb.Extensibility.AddInSelector

GetSupportedCustomerCenterIntegrationCalls()

Returns a list of strings that the integration supports for the Integration Customer Center module

public virtual List<string> GetSupportedCustomerCenterIntegrationCalls()

Returns

List<string>

IsWebServiceConnectionAvailable()

Check if the web service is available for the live integration

public abstract bool IsWebServiceConnectionAvailable()

Returns

bool

LoadSettings()

Load add-in configuration settings

public abstract string LoadSettings()

Returns

string

Add-in settings in the Xml format

Remarks

The Xml format must be suitable for use in Dynamicweb.Extensibility.AddInSelector

LoadSettings(string)

public virtual string LoadSettings(string instanceId)

Parameters

instanceId string

Returns

string

RetrieveItemDetailsFromRemoteSystem(Template, string, User?, string)

Adds the relevant details data for the specified item id to the template, after it has been retrieved from the remote system

public virtual Template RetrieveItemDetailsFromRemoteSystem(Template template, string callType, User? user, string itemId)

Parameters

template Template

callType string

user User

itemId string

Returns

Template

RetrieveItemsListFromRemoteSystem(Template, string, User?, int, int, ref int)

Adds the relevant list of data to the template, after it has been retrieved from the remote system

public virtual Template RetrieveItemsListFromRemoteSystem(Template template, string callType, User? user, int pageSize, int pageIndex, ref int totalItemsCount)

Parameters

template Template

callType string

user User

pageSize int

pageIndex int

totalItemsCount int

Returns

Template

RetrievePDF(IRequest?)

public virtual string? RetrievePDF(IRequest? httpRequest)

Parameters

httpRequest IRequest

Returns

string

SaveSettings()

Save Add-in configuration settings

public abstract void SaveSettings()