ChannelDocs Property

This should contain a URL for the documentation describing what format was used to create the current RSS channel.

Syntax

 rss.getChannelDocs([callback])
 rss.setChannelDocs( channelDocs, [callback])

Default Value

"http://backend.userland.com/rss2"

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 getChannelDocs([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 setChannelDocs([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 should contain a URL for the documentation describing what format was used to create the current RSS channel. The default value points to the standard RSS 2.0 documentation found at "http://backend.userland.com/rss2".

Data Type

String