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

ChannelSkipHours Property

This property contains a list of hours in which aggregators may skip reading the channel.

Syntax

 rss.getChannelSkipHours([callback])
 rss.setChannelSkipHours( channelSkipHours, [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 getChannelSkipHours([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 setChannelSkipHours([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 list of hours in which aggregators may skip reading the channel. When using this property, its value must contain "<hour>" XML sub-elements. Each sub-element's value must be a valid hour between 0 and 23, representing a time in GMT. There may be up to 24 sub-elements specified for this property.

NOTE: Hour zero is the hour starting at midnight.

Data Type

String

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