StrandsSettings Class

Methods for accessing Strands Recommender settings.

Inheritance Hierarchy

System.Object
  CMS.StrandsRecommender.StrandsSettings

Namespace: CMS.StrandsRecommender
Assembly: CMS.StrandsRecommender (in CMS.StrandsRecommender.dll) Version: 10.0.0

Syntax

public static class StrandsSettings

The StrandsSettings type exposes the following members.

Methods

	Name	Description
Public method Static member	GetApiID	Gets Strands API ID from settings or null if not specified.
Public method Static member	GetAutomaticCatalogUploadFrequency	Gets frequency of automatic download performed by Strands Recommender of catalog. Usable only when IsAutomaticCatalogUploadEnabled(String) is true, specifies frequency with which is catalog automatically updated.
Public method Static member	GetCatalogFeedPassword	Gets password required to access Strands catalog feed page.
Public method Static member	GetCatalogFeedUsername	Gets username required to access Strands catalog feed page.
Public method Static member	GetDocumentTypes	Gets document types that will be rendered into Strands XML feed.
Public method Static member	GetPath	Gets path to restrict documents selection.
Public method Static member	GetTransformationInfo	Gets transformation used to render XML feed.
Public method Static member	GetValidationToken	Gets Strands Validation token from settings or null if not specified.
Public method Static member	GetWhereCondition	Gets WHERE condition that restricts selection of products.
Public method Static member	IsAutomaticCatalogUploadEnabled	Gets whether automatic download of catalog performed by Strands Recommender is enabled or not. If true, after setup call, Strands will automatically download XML feed. Downloading of feed is performed with frequency specified in GetAutomaticCatalogUploadFrequency(String).
Public method Static member	IsCatalogFeedAuthenticationEnabled	Checks whether catalog feed protection is enabled in settings. Protection is enabled when either username or password are set.
Public method Static member	IsStrandsEnabled	Gets boolean indicating if Strands module is enabled. Module is enabled if both API ID and Validation token are set in settings.