RSSFeeder Class Content Studio 5.7 SDK
Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

Writes an RSS Feed to the supplied stream or the default response stream. Before using this class you must ensure that CS_CreatedBy and CS_PublishDate EPT fields as well as the title field and are indexed. The RSSFeeder class acts as the underlying engine for the RSS 2.0 Feeder AS component.
Inheritance Hierarchy
SystemObject
  ContentStudio.SiteCodeBase
    ContentStudio.Site.ActiveScriptingActiveScriptingBase
      ContentStudio.Site.ActiveScriptingPageableComponent
        ContentStudio.Site.ActiveScriptingEPTBase
          ContentStudio.Site.ActiveScripting.MiscRSSFeeder

Namespace: ContentStudio.Site.ActiveScripting.Misc
Assembly: CS_SiteLib (in CS_SiteLib.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
Copy
public sealed class RSSFeeder : EPTBase

The RSSFeeder type exposes the following members.

Constructors
  NameDescription
Public methodRSSFeeder(Int32)
Constructs a new instance of the RSSFeeder class that writes to the default response stream.
Public methodRSSFeeder(Stream, Int32)
Constructs a new instance of the RSSFeeder class that writes to the supplied stream.
Top
Properties
  NameDescription
Public propertyApplicationTimeout
Sets or gets a value that indicates the time (in minutes) how long the application cache should cache its result. If the value is zero, there is no timeout limit. The cache can be recycled depending on the size of the total application cache. The default value is zero. This parameter has no meaning if the UseApplicationCache property is false.
Public propertyBackwardsComponentCompatibilityMode
Sets or gets a value that indicates whether the code runs in backwards compatibility component mode. The default value is false.
(Inherited from ActiveScriptingBase.)
Public propertyCategoryID
Sets or gets a value that indicates a document category to use. This category must be a valid EPT document category. The default value is zero.
Public propertyComponentName
Gets the name of the component.
(Overrides ActiveScriptingBaseComponentName.)
Public propertyConformance
Gets a value which specifies which type of code a component can generate. Since RSSFeeder returns pure XML this property not applicable.
(Overrides ActiveScriptingBaseConformance.)
Public propertyDataFields
Sets or gets an array of EPT field that contains the data to write to the RSS feed. The default value is an array with XmlIndexQuery.PARAMETER_COUNT-2 members that are initialized with empty strings. The first field name must specify the name of the EPT field containing the item title. The second field name must specify the name the EPT field containing the item description. The rest of the members specifies the name the EPT field that you would like to filter on.
Public propertyDataTypes
Sets or gets the data type for the DataFields field. The default value is an array with PARAMETER_COUNT members filled with the XmlIndexQuery.QueryDataTypes.String value.
Public propertyDescription
Sets or gets the description of the feed. The default value is an Empty string.
Public propertyElementType
Gets a value which specifies the type of outer element the component generates. Since RSSFeeder returns pure XML this property not applicable.
(Overrides ActiveScriptingBaseElementType.)
Public propertyEncoding
Sets or gets the encoding the component uses. The default encoding is the UTF8 encoding without byte order mark.
(Inherited from ActiveScriptingBase.)
Public propertyCode exampleFilterCriteria
Sets or gets an expression to filter on. The default value is an empty string. The expression should be the WHERE clause of an T-SQL statement using the field you specified in one or more of the DataFields parameter members. The field name must be enclosed in brackets and must have correct casing. Do not include the WHERE keyword.
Public propertyItemsToReturn
Sets or gets a value that indicates the maximum number of returned items in the feed. Use zero to return all available items. The default value is 10.
Public propertyLanguageCode
Sets or gets the language code of the feed. The default value is "en-gb".
Public propertyLink
Sets or gets the main link of the feed. The default value is an Empty string.
Public propertyPresentationTemplate
Sets or gets a value that indicates a presentation template to use. Use zero if no presentation template is used. The default value is zero.
Public propertyRSSConformanceLevel
A value that specifies at what specification level the RSS should be generated. The default value is ConformanceLevel.RSS2Spec.
Public propertyTitle
Sets or gets the title of the whole RSS feed. The default value is an Empty string.
Public propertyUseApplicationCache
Sets or gets a value that indicates if the application cache should be used. The default value is false.
Top
Methods
  NameDescription
Public methodEquals (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodInvoke
Invokes the component and writes its content into the specified stream.
Public methodToString (Inherited from Object.)
Top
Remarks
To use this class, create an instance of this object, and call the Invoke method with an appropriate set of parameters and properties. This class can throw exceptions, thus your code should be wrapped within try/catch statements in order to avoid the entire page to crash.
See Also

Reference

ContentStudio.Site.ActiveScripting.Misc Namespace