editor
278
edits
Changes
Jump to navigation
Jump to search
Created page with "{{Api_Method_Spec| Description= Retrieves storage status from the external platform, as an UserStorageInfo object. If the external platform provides a Network..."
{{Api_Method_Spec|
Description= Retrieves storage status from the external platform, as an [[UserStorageInfo|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=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context and logged user.
}}
|Returns=
Returns a JSON object with a list of [[UserStorageInfo|UserStorageInfo]].
'''Example:'''
{
: "Offset": 0,
: "Limit": 10,
: "Count": 48,
: [ Array of [[UserStorageInfo|UserStorageInfo]] objects ]
}
|Exceptions=
* None.
|Cache=
This method is not cached.
|KnownIssues=
None
|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 2.4
{{!}} Initial method design
{{!}}
{{!}}}
|SeeAlso=
* [[UserStorageInfo|UserStorageInfo]] object
* [[RecordingScheduleState|RecordingScheduleState]] enum
* [[RecordingSchedule|RecordingSchedule]] object type
* [[UNIAPI_Specification#Network_Pvr_Service|Network_Pvr_Service]] methods
}}
Description= Retrieves storage status from the external platform, as an [[UserStorageInfo|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=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context and logged user.
}}
|Returns=
Returns a JSON object with a list of [[UserStorageInfo|UserStorageInfo]].
'''Example:'''
{
: "Offset": 0,
: "Limit": 10,
: "Count": 48,
: [ Array of [[UserStorageInfo|UserStorageInfo]] objects ]
}
|Exceptions=
* None.
|Cache=
This method is not cached.
|KnownIssues=
None
|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 2.4
{{!}} Initial method design
{{!}}
{{!}}}
|SeeAlso=
* [[UserStorageInfo|UserStorageInfo]] object
* [[RecordingScheduleState|RecordingScheduleState]] enum
* [[RecordingSchedule|RecordingSchedule]] object type
* [[UNIAPI_Specification#Network_Pvr_Service|Network_Pvr_Service]] methods
}}
