Bureaucrats, editor, Administrators
470
edits
Changes
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..."
{{Api_DataType_Spec
|Description=Represents a Schedule object, associated with the managing of recordings in the Network PVR service.
|Members=
{{{!}} border="2" style="width:800px" cellspacing="0" cellpadding="10"
{{!}}- style="background:#88ccff;font-size:110%"
! Field
! Data Type
! Description
{{!}}- valign="top"
! Available
{{!}} long int
{{!}} Available user storage capacity
{{!}}- valign="top"
! 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”.
{{!}}- valign="top"
! Total
{{!}} long int
{{!}} Total user storage
{{!}}- valign="top"
! Type
{{!}} [[UserStorageType|UserStorageType]] enum
{{!}} Storage type
{{!}}- valign="top"
! Unit
{{!}} [[UserStorageUnit|UserStorageUnit]] enum
{{!}} Storage units
{{!}}- valign="top"
! Used
{{!}} long int
{{!}} Used storage
{{!}}- valign="top"
! 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”.
{{!}}- valign="top"
{{!}}}
|Example=
{
: "Available": 3600,
: "SecurityLimit": 3000,
: "Total": 6000,
: "Type": 1,
: "Unit": 3,
: "Used": 2400,
: "WarningLimit": 3000
}
|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 data type implementation
{{!}}
{{!}}- valign="top"
{{!}}}
|SeeAlso=
* [[EpgLiveSchedule|EpgLiveSchedule]] object
* [[ReducedLiveSchedule|ReducedLiveSchedule]] object
* [[LiveSchedule|LiveSchedule]] object
* [[LiveProgram|LiveProgram]] object
* [[EpgLiveProgram|EpgLiveProgram]] object
* [[RecordingScheduleState|RecordingScheduleState]] enum
* [[UserStorageType|UserStorageType]] enum
* [[UserStorageUnit|UserStorageUnit]] enum
* [[UNIAPI_Specification#Network_Pvr_Service|Network_Pvr_Service]] for Network PVR Service
}}
|Description=Represents a Schedule object, associated with the managing of recordings in the Network PVR service.
|Members=
{{{!}} border="2" style="width:800px" cellspacing="0" cellpadding="10"
{{!}}- style="background:#88ccff;font-size:110%"
! Field
! Data Type
! Description
{{!}}- valign="top"
! Available
{{!}} long int
{{!}} Available user storage capacity
{{!}}- valign="top"
! 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”.
{{!}}- valign="top"
! Total
{{!}} long int
{{!}} Total user storage
{{!}}- valign="top"
! Type
{{!}} [[UserStorageType|UserStorageType]] enum
{{!}} Storage type
{{!}}- valign="top"
! Unit
{{!}} [[UserStorageUnit|UserStorageUnit]] enum
{{!}} Storage units
{{!}}- valign="top"
! Used
{{!}} long int
{{!}} Used storage
{{!}}- valign="top"
! 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”.
{{!}}- valign="top"
{{!}}}
|Example=
{
: "Available": 3600,
: "SecurityLimit": 3000,
: "Total": 6000,
: "Type": 1,
: "Unit": 3,
: "Used": 2400,
: "WarningLimit": 3000
}
|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 data type implementation
{{!}}
{{!}}- valign="top"
{{!}}}
|SeeAlso=
* [[EpgLiveSchedule|EpgLiveSchedule]] object
* [[ReducedLiveSchedule|ReducedLiveSchedule]] object
* [[LiveSchedule|LiveSchedule]] object
* [[LiveProgram|LiveProgram]] object
* [[EpgLiveProgram|EpgLiveProgram]] object
* [[RecordingScheduleState|RecordingScheduleState]] enum
* [[UserStorageType|UserStorageType]] enum
* [[UserStorageUnit|UserStorageUnit]] enum
* [[UNIAPI_Specification#Network_Pvr_Service|Network_Pvr_Service]] for Network PVR Service
}}
