ChannelTtl Property

This property contains a number of minutes that represents how long the channel may be cached before it needs to be refreshed from the source.

Syntax

 rss.getChannelTtl([callback])
 rss.setChannelTtl( channelTtl, [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 getChannelTtl([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 setChannelTtl([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 number of minutes that represents how long the channel may be cached before it needs to be refreshed from the source.

Data Type

String