ChannelDescription Property

This property contains a textual description of the current RSS feed (Required - 500 char max).

Syntax

 rss.getChannelDescription([callback])
 rss.setChannelDescription( channelDescription, [callback])

Default Value

""

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 getChannelDescription([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 setChannelDescription([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 a textual description of the current RSS feed (Required - 500 char max).

This property is filled in automatically after calling GetFeed.

Required properties for building RSS feeds include the Channel's ChannelLink, ChannelTitle, and ChannelDescription properties.

Data Type

String