Represents a video feed.
More...
List of all members.
Public Member Functions |
def | __init__ |
| Creates a Feed object.
|
def | getVideos |
| Gets the video entries from the feed.
|
def | getTotalResults |
| Gets the total number of video entries contained in the feed.
|
Public Attributes |
| feedId |
| title |
| thumbnail |
| filter |
| startIndex |
| itemsPerPage |
Properties |
| videos = property(getVideos) |
| totalResults = property(getTotalResults) |
Private Member Functions |
def | _updateFeed |
| Downloads the feed, allowing it to be parsed.
|
def | _parseFeed |
| Parses a feed.
|
Private Attributes |
| _totalResults |
| _videos |
Detailed Description
Constructor & Destructor Documentation
def SbsOnDemand::Feed::Feed::__init__ |
( |
|
self, |
|
|
|
feed |
|
) |
| |
Creates a Feed object.
- Parameters:
-
feed | the feed to be parsed |
Member Function Documentation
def SbsOnDemand::Feed::Feed::_parseFeed |
( |
|
self, |
|
|
|
feed |
|
) |
| [private] |
Parses a feed.
- Parameters:
-
feed | the feed to be parsed, in dict form |
def SbsOnDemand::Feed::Feed::_updateFeed |
( |
|
self, |
|
|
|
count = False , |
|
|
|
startIndex = 0 , |
|
|
|
itemsPerPage = 10 |
|
) |
| [private] |
Downloads the feed, allowing it to be parsed.
- Parameters:
-
count | whether to ask for the total number of results or not |
startIndex | the start index (offset) of entries within the feed to obtain |
itemsPerPage | the maximum number of entries to contain within the feed |
def SbsOnDemand::Feed::Feed::getTotalResults |
( |
|
self | ) |
|
Gets the total number of video entries contained in the feed.
- Returns:
- the total number of video entries contained in the feed
def SbsOnDemand::Feed::Feed::getVideos |
( |
|
self, |
|
|
|
count = False , |
|
|
|
startIndex = 0 , |
|
|
|
itemsPerPage = 10 |
|
) |
| |
Gets the video entries from the feed.
- Parameters:
-
count | whether to ask for the total number of results or not |
startIndex | the start index (offset) of entries within the feed to obtain |
itemsPerPage | the maximum number of entries to contain within the feed |
- Returns:
- an array of Video objects
Property Documentation
SbsOnDemand::Feed::Feed::totalResults = property(getTotalResults) [static] |
SbsOnDemand::Feed::Feed::videos = property(getVideos) [static] |
The documentation for this class was generated from the following file: