ItemCount Property

The total number of items in the response.

Syntax

 paapi.getItemCount([callback])

Default Value

0

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 getItemCount([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 setItemCount([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

The class parses the XML received from the server. If the class is able to find a list of items in the response, the count of items will be stored here. The type of items the component found will be populated in the ItemType property. If the class is unable to find a list of items, ItemCount will be 0.

This property is read-only.

Data Type

Integer