ChannelImageLink Property

This property contains the URL associated with the channel's associated image.

Syntax

 rss.getChannelImageLink([callback])
 rss.setChannelImageLink( channelImageLink, [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 getChannelImageLink([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 setChannelImageLink([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 URL associated with the channel's associated image.

Images are required for RSS channels that conform to version 0.91 and 0.92 of the RSS protocol. The following properties are required for an image:


ChannelImageLink	The link associated with the image. For graphical representations, this is the webpage that will be displayed if the image is clicked.
ChannelImageTitle	The title of the image.
ChannelImageUrl	URL where the image can be found.

Data Type

String