GetUserStorageInfo

Description

Retrieves storage status from the external platform, as an UserStorageInfo object. If the external platform provides a Network PVR service, this method will return total, used and available time measured in minutes or hours. In the case of Remote PVR service availability, this method will provide the total, used and available storage measured in bytes from the connected STB hard disk.

Parameters

• token (String, required)

A valid token for identifying the API session context and logged user.

• targetDeviceId (int, optional)

Allows identifying the user's device (STB) on which the application will be applied, in the case that several DVR devices may exist in the household (does not apply to MiView and Mediaroom)

Returns

Returns a JSON object with a list of UserStorageInfo.

Example:

{

"Offset": 0,

"Limit": 10,

"Count": 48,

[ Array of UserStorageInfo objects ]

}

Exceptions

• None.

Caching

This method is not cached.

Known issues

None

Version history

API Version Number	Change description	Changes author
2.4	Initial method design
2.4 drop 1	Added support for Mirada and Mediaroom. Introduced new parameter targetDeviceId

See also

• UserStorageInfo object
• RecordingScheduleState enum
• RecordingSchedule object type
• Network_Pvr_Service methods