IP*Works! V9 - Online Help
IP*Works! V9
Questions / Feedback?

RSSVersion Property

The RSS protocol version of the current RSS feed.

Syntax

 rss.getRSSVersion([callback])
 rss.setRSSVersion( RSSVersion, [callback])

Possible Values

  0 (rssVersionUndefined), 
  1 (rssVersion091), 
  2 (rssVersion092), 
  3 (rssVersion200)

Default Value

3


Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getRSSVersion([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setRSSVersion([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property contains the protocol version to which the current RSS feed conforms. Each version has slightly different requirements and a different set of defined standard properties. When generating an RSS feed, the class will check this value and throw an error for missing required properties.

The following are the values currently recognized by the class:

0rssVersionUndefined
1rssVersion091
2rssVersion092
3rssVersion200

In order to set properties not defined in the given version, use the Namespaces properties to list and define namespaces and the GetProperty and SetProperty methods to list and define each non-standard property.

Data Type

Integer

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
Build 9.0.6635.0