Table of Contents

Class FeedProvider

Namespace
Dynamicweb.Ecommerce.Feeds
Assembly
Dynamicweb.Ecommerce.dll
[AddInUseParameterGrouping(true)]
public abstract class FeedProvider : ConfigurableAddIn, IDropDownOptions
Inheritance
FeedProvider
Implements
Inherited Members

Properties

ApplyDomain

[AddInParameter("ApplyDomain")]
[AddInLabel("Apply domain on Image/Asset path")]
[AddInParameterGroup("Options")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "")]
public bool ApplyDomain { get; set; }

Property Value

bool

AssetCategories

[AddInParameter("AssetCategories")]
[AddInLabel("Asset Categories")]
[AddInParameterGroup(" ")]
[AddInParameterEditor(typeof(SelectionBoxParameterEditor), "leftheader=Excluded properties;rightheader=Included properties;translateheaders=true;showsearchbox=true")]
public string AssetCategories { get; set; }

Property Value

string

Assets

[AddInParameter("Assets")]
[AddInLabel("Assets")]
[AddInParameterGroup(" ")]
[AddInParameterEditor(typeof(SelectionBoxParameterEditor), "leftheader=Excluded properties;rightheader=Included properties;translateheaders=true;showsearchbox=true")]
public string Assets { get; set; }

Property Value

string

ExcludeVariantInfoOnVariants

[AddInParameter("ExcludeVariantInfoOnVariants")]
[AddInLabel("Selected \"Variant Info\" will only be included on MASTER products")]
[AddInParameterGroup("Options")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "")]
public bool ExcludeVariantInfoOnVariants { get; set; }

Property Value

bool

FieldDisplayGroups

[AddInParameter("FieldDisplayGroups")]
[AddInLabel("Field Display Groups")]
[AddInParameterGroup(" ")]
[AddInParameterEditor(typeof(SelectionBoxParameterEditor), "leftheader=Excluded properties;rightheader=Included properties;translateheaders=true;showsearchbox=true")]
public string FieldDisplayGroups { get; set; }

Property Value

string

Price

[AddInParameter("Price")]
[AddInLabel("Price")]
[AddInParameterGroup(" ")]
[AddInParameterEditor(typeof(SelectionBoxParameterEditor), "leftheader=Excluded properties;rightheader=Included properties;translateheaders=true;showsearchbox=true")]
public string Price { get; set; }

Property Value

string

Product

[AddInParameter("Product")]
[AddInLabel("Product System Fields")]
[AddInParameterGroup(" ")]
[AddInParameterEditor(typeof(SelectionBoxParameterEditor), "leftheader=Excluded properties;rightheader=Included properties;translateheaders=true;showsearchbox=true")]
public string Product { get; set; }

Property Value

string

ProductCategoryFields

[AddInParameter("Product Category Fields")]
[AddInLabel("Product Category Fields")]
[AddInParameterGroup(" ")]
[AddInParameterEditor(typeof(SelectionBoxParameterEditor), "leftheader=Excluded properties;rightheader=Included properties;translateheaders=true;showsearchbox=true")]
public string ProductCategoryFields { get; set; }

Property Value

string

ProductFields

[AddInParameter("Product Custom Fields")]
[AddInLabel("Product Custom Fields")]
[AddInParameterGroup(" ")]
[AddInParameterEditor(typeof(SelectionBoxParameterEditor), "leftheader=Excluded properties;rightheader=Included properties;translateheaders=true;showsearchbox=true")]
public string ProductFields { get; set; }

Property Value

string

ProductsList

[AddInParameter("Products List")]
[AddInLabel("Products List")]
[AddInParameterGroup(" ")]
[AddInParameterEditor(typeof(SelectionBoxParameterEditor), "leftheader=Excluded properties;rightheader=Included properties;translateheaders=true;showsearchbox=true")]
public string ProductsList { get; set; }

Property Value

string

ShowPricesWithVat

[AddInParameter("ShowPricesWithVat")]
[AddInLabel("Show prices with VAT")]
[AddInParameterGroup("Options")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "")]
public bool ShowPricesWithVat { get; set; }

Property Value

bool

StockUnits

[AddInParameter("StockUnits")]
[AddInLabel("Stock units")]
[AddInParameterGroup(" ")]
[AddInParameterEditor(typeof(SelectionBoxParameterEditor), "leftheader=Excluded properties;rightheader=Included properties;translateheaders=true;showsearchbox=true")]
public string StockUnits { get; set; }

Property Value

string

VariantInfo

[AddInParameter("VariantInfo")]
[AddInLabel("Variant Info")]
[AddInParameterGroup(" ")]
[AddInParameterEditor(typeof(SelectionBoxParameterEditor), "leftheader=Excluded properties;rightheader=Included properties;translateheaders=true;showsearchbox=true")]
public string VariantInfo { get; set; }

Property Value

string

Methods

CreateProductListSettings(ProductCatalogSettings, FeedContextConfiguration)

Creates the setting for the Product List
protected ProductListViewModelSettings CreateProductListSettings(ProductCatalogSettings settings, FeedContextConfiguration feedContextConfiguration)

Parameters

settings ProductCatalogSettings
The settings used to generate the Product List Settings
feedContextConfiguration FeedContextConfiguration
The feed used to generate the Product List Settings

Returns

ProductListViewModelSettings

CreateProductViewModelSettings(ProductCatalogSettings, FeedContextConfiguration)

Creates the setting for the ProductViewModel
protected ProductViewModelSettings CreateProductViewModelSettings(ProductCatalogSettings settings, FeedContextConfiguration feedContextConfiguration)

Parameters

settings ProductCatalogSettings
The settings used to generate the settings for the ProductViewModel
feedContextConfiguration FeedContextConfiguration
The feed used to generate the settings for the ProductViewModel

Returns

ProductViewModelSettings

GenerateFeedSettings(Feed)

Generates the settings used by the ViewEngine
protected ProductCatalogSettings GenerateFeedSettings(Feed feed)

Parameters

feed Feed
The feed used as the source for the settings

Returns

ProductCatalogSettings

GetApiUrls(Feed, Uri, List<string>, List<string>)

public static List<string> GetApiUrls(Feed feed, Uri url, List<string> languages, List<string> currencies)

Parameters

feed Feed
url Uri
languages List<string>
currencies List<string>

Returns

List<string>

GetApiUrls(Feed, Uri, List<string>, List<string>, List<string>)

public static List<string> GetApiUrls(Feed feed, Uri url, List<string> languages, List<string> currencies, List<string> shops)

Parameters

feed Feed
url Uri
languages List<string>
currencies List<string>
shops List<string>

Returns

List<string>

GetApiUrls(Feed, Uri, List<string>, List<string>, List<string>, List<string>)

public static List<string> GetApiUrls(Feed feed, Uri url, List<string> languages, List<string> currencies, List<string> shops, List<string> countries)

Parameters

feed Feed
url Uri
languages List<string>
currencies List<string>
shops List<string>
countries List<string>

Returns

List<string>

GetContentType()

Gets the content type for the output
public abstract string GetContentType()

Returns

string

GetDomain()

protected string GetDomain()

Returns

string

GetFeedModel(Feed, FeedContextConfiguration)

protected ProductListViewModel GetFeedModel(Feed Feed, FeedContextConfiguration feedContextConfiguration)

Parameters

Feed Feed
feedContextConfiguration FeedContextConfiguration

Returns

ProductListViewModel

GetOptions(string)

Get options for editors with multiple values
public virtual Hashtable GetOptions(string dropdownName)

Parameters

dropdownName string

Returns

Hashtable

GetOutput(Feed, FeedContextConfiguration)

This method is used to get the output of the feed
public abstract string GetOutput(Feed feed, FeedContextConfiguration feedContextConfiguration)

Parameters

feed Feed
The feed which should be used as the source for the output
feedContextConfiguration FeedContextConfiguration

Returns

string
To top