Difference between revisions of "UserStorageInfo"
Jump to navigation
Jump to search
(Created page with "{{Api_DataType_Spec |Description=Represents a Schedule object, associated with the managing of recordings in the Network PVR service. |Members= {{{!}} border="2" style="width:8...") |
|||
| (2 intermediate revisions by the same user not shown) | |||
| Line 43: | Line 43: | ||
{{!}} long int | {{!}} long int | ||
{{!}} Configured warning limit. Introduced to have fully compatibility with ALU MTV RS API service logic. It is a warning value. When the threshold is reached, then errorCode “Succesfull with a warning: the quota limit for the client is closed to be reached” is returned by the API. This error code is one of the possible error codes returned returned by “AddRecordingSchedule method”. | {{!}} Configured warning limit. Introduced to have fully compatibility with ALU MTV RS API service logic. It is a warning value. When the threshold is reached, then errorCode “Succesfull with a warning: the quota limit for the client is closed to be reached” is returned by the API. This error code is one of the possible error codes returned returned by “AddRecordingSchedule method”. | ||
| + | {{!}}- valign="top" | ||
| + | ! QuotaManagement | ||
| + | {{!}} [[QuotaManagementType|QuotaManagementType]] enum | ||
| + | {{!}} bgcolor="green" {{!}} New 7.1: Type of Quota Management (Unknown, Automatic or Manual) | ||
{{!}}- valign="top" | {{!}}- valign="top" | ||
| Line 58: | Line 62: | ||
: "Used": 2400, | : "Used": 2400, | ||
: "WarningLimit": 3000 | : "WarningLimit": 3000 | ||
| + | : "QuotaManagement": 1 | ||
} | } | ||
| Line 72: | Line 77: | ||
{{!}} Initial data type implementation | {{!}} Initial data type implementation | ||
{{!}} | {{!}} | ||
| + | {{!}}- valign="top" | ||
| + | ! 7.1 | ||
| + | {{!}} Changes for Open Platform CPVR | ||
| + | {{!}} José Manuel Escartín | ||
{{!}}- valign="top" | {{!}}- valign="top" | ||
Latest revision as of 09:29, 5 April 2019
Represents a Schedule object, associated with the managing of recordings in the Network PVR service.
Members
| Field | Data Type | Description |
|---|---|---|
| Available | long int | Available user storage capacity |
| SecurityLimit | long int | Configured security limit. Introduced to have fully compatibility with MTV RS API service logic. It is the real value. When the threshold is reached, then an errorCode “Customer quota is exceed” is returned by the API. This error code is one of the possible error codes returned returned by “AddRecordingSchedule method”. |
| Total | long int | Total user storage |
| Type | UserStorageType enum | Storage type |
| Unit | UserStorageUnit enum | Storage units |
| Used | long int | Used storage |
| WarningLimit | long int | Configured warning limit. Introduced to have fully compatibility with ALU MTV RS API service logic. It is a warning value. When the threshold is reached, then errorCode “Succesfull with a warning: the quota limit for the client is closed to be reached” is returned by the API. This error code is one of the possible error codes returned returned by “AddRecordingSchedule method”. |
| QuotaManagement | QuotaManagementType enum | New 7.1: Type of Quota Management (Unknown, Automatic or Manual) |
Example
{
- "Available": 3600,
- "SecurityLimit": 3000,
- "Total": 6000,
- "Type": 1,
- "Unit": 3,
- "Used": 2400,
- "WarningLimit": 3000
- "QuotaManagement": 1
}
Known issues
None
Version history
| API Version Number | Change description | Changes author |
|---|---|---|
| 2.4 | Initial data type implementation | |
| 7.1 | Changes for Open Platform CPVR | José Manuel Escartín |
See also
- EpgLiveSchedule object
- ReducedLiveSchedule object
- LiveSchedule object
- LiveProgram object
- EpgLiveProgram object
- RecordingScheduleState enum
- UserStorageType enum
- UserStorageUnit enum
- Network_Pvr_Service for Network PVR Service
