ItemEnclosureLength Property

This property indicates how large the enclosure is in bytes.

Syntax

 rss.getItemEnclosureLength(index, [callback])
 rss.setItemEnclosureLength(index,  itemEnclosureLength, [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 getItemEnclosureLength([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 setItemEnclosureLength([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 indicates how large the enclosure is in bytes.

An enclosure specifies a media object which is attached to the item. The fields ItemEnclosureLength, ItemEnclosureType, and ItemEnclosureUrl all are required when specifying an enclosure.

The index parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks 2020 Node.js Edition - Version 20.0 [Build 8307]