Difference between revisions of "GetUserStorageInfo"

From Gvp-public
Jump to navigation Jump to search
Line 25: Line 25:
  
 
|Exceptions=
 
|Exceptions=
* [[StatusCode#AuthenticationRequiredException|AuthenticationRequiredException]]: if authentication parameters are incorrect/missing.
+
* None.
* [[StatusCode#UnexpectedRecordingResponseException|UnexpectedRecordingResponseException]]: General recording service exception.
 
  
 
|Cache=
 
|Cache=

Revision as of 06:54, 19 September 2014

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.


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


See also