Provider OVP implementation for Accedo OVP
Methods
# async inner getCachedTvListings(params) → {Promise.<any>}
Get TVListing from a channel, doing a general tvlisting request and caching the value for all the channels and then returning only the channel provided by param. Challenge: define time windows to use the cached values and when to refresh the data
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
params |
Object
|
Params object |
|
channel |
number
|
Channel identifier |
|
startTime |
number
|
timestamp value for the initial time to fetch the data for the listings |
|
segmentationValue |
string
|
<optional> |
optional segment to get a different value based on config |
tvlistings
Promise.<any>
# inner getChannelData(segmentationValueopt) → {Promise.<any>}
Returns all the data associated with the channels from the OVP
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
segmentationValue |
string
|
<optional> |
optional segment to get a different config |
the channels info
Promise.<any>
# async inner getChannelTvListings(params) → {Promise.<any>}
Returns the program data associated with a channel for a certain time
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
params |
Object
|
params object |
|
channel |
string
|
channel identifier |
|
startTime |
number
|
The start time to fetch information (unix timestamp in ms) |
|
segmentationValue |
string
|
<optional> |
optional segment to get a different value based on config |
program data
Promise.<any>
# async inner getCollection(collectionId, segmentationValueopt) → {any}
Returns a collection data based on a collection id
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
collectionId |
string
|
id of the collection |
|
segmentationValue |
string
|
<optional> |
optional segment to get a different config |
raw collection
any
# inner getEpisodeById(id, segmentationValueopt) → {Object}
Get an episode
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
id |
String
|
Episode ID |
|
segmentationValue |
string
|
<optional> |
optional segment to get a different config |
Episode
Object
# async inner getItemsByQuery(params) → {Array.<any>}
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
params |
object
|
parameters object |
|
query |
string
|
query to parse against the OVP API |
|
itemsPerPage |
number
|
number of items to request |
|
pageNumber |
number
|
page to request |
|
sortBy |
string
|
sort para string value |
|
segmentationValue |
string
|
<optional> |
optional segment to get a different config |
data to display
Array.<any>
# inner getMovieById(id, segmentationValueopt) → {any}
gets Movie from a provider identifier
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
id |
string
|
movie identifier |
|
segmentationValue |
string
|
<optional> |
optional segment to get a different config |
movie
any
# async inner getMovieCategories(segmentationValueopt) → {any}
Get Movie categories, all the categories associated with movies
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
segmentationValue |
string
|
<optional> |
optional segment to get a different config |
categories
any
# async inner getMovieData(paramssegmentationValueopt) → {any}
gets Movie from a category
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
params.category |
string
|
<optional> |
category string |
params.sortBy |
string
|
<optional> |
sort para, string |
params.pageSize |
number
|
<optional> |
number of items to return |
paramssegmentationValue |
string
|
<optional> |
optional segment to get a different config |
movie
any
# async inner getMovies(options) → {Promise.<any>}
Gets all the movies
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
options |
*
|
parameter object |
|
segmentationValue |
*
|
<optional> |
segmentationValue to filter |
Movies
Promise.<any>
# async inner getMoviesByCategory(params) → {Promise.<Array.<Movies>>}
It returns a list of Movies associated with the provider category
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
params |
object
|
param object |
|
category |
string
|
param object |
|
sortBy |
string
|
<optional> |
param object |
segmentationValue |
string
|
<optional> |
optional segment to get a different value based on config |
the list of movies
Promise.<Array.<Movies>>
# async inner getTvListings(params) → {Promise.<any>}
Returns a set of listings for the specified time and combination of count+offset
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
params |
Object
|
Params object |
|
startTime |
number
|
timestamp value for the initial time to fetch the data for the listings |
|
endTime |
number
|
timestamp value for the final time to fetch the data for the listings |
|
count |
number
|
the number of channels to return the data from |
|
offset |
number
|
the initial position of the channel to start returning data from |
|
segmentationValue |
string
|
<optional> |
optional segment to get a different value based on config |
the listings for the specified params
Promise.<any>
# inner getTvSeasonEpisodesById(id, segmentationValueopt) → {Array.<Object>}
Get episodes from a season
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
id |
String
|
Season ID |
|
segmentationValue |
string
|
<optional> |
optional segment to get a different config |
Episodes
Array.<Object>
# async inner getTvShowById(id, segmentationValueopt) → {Object}
Get a TV Show
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
id |
string
|
TV Show ID |
|
segmentationValue |
string
|
<optional> |
the value for the segmentation to filter/use for any possible filtering |
- To Do:
-
- Review the TV Show API since it doesn't return all the information provided by APIs. https://github.com/Accedo-Global-Solutions/vdkweb-ovp-client-accedo/tree/296088a7709a953c1a7aea345c38b316332e339c/docs/TVShowApi.md#getTvShowById
TV Show
Object
# async inner getTvShowData(options) → {Promise.<any>}
Gets the TV Shows for a category or general
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
options |
any
|
parameter object |
|
category |
string
|
<optional> |
category |
pageSize |
number
|
<optional> |
category |
segmentationValue |
string
|
<optional> |
segmentationValue to filter |
TV Shows
Promise.<any>
# inner getTvShowEpisodesById(id) → {Array.<Object>}
Get episodes from a tv show
Parameters:
| Name | Type | Description |
|---|---|---|
id |
String
|
TV Show ID |
Episodes
Array.<Object>
# async inner getTvShows(options) → {Promise.<any>}
Gets all the TV Shows
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
options |
*
|
parameter object |
|
segmentationValue |
*
|
<optional> |
segmentationValue to filter |
TV Shows
Promise.<any>
# async inner getTvShowsByCategory(params) → {Promise.<Array.<any>>}
Get all the TV Shows from a category
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
params |
object
|
object parameter |
|
category |
string
|
category string |
|
segmentationValue |
string
|
<optional> |
segmentationValue |
TVShows
Promise.<Array.<any>>
# inner getTvShowSeasonsById(id, segmentationValueopt) → {Array.<Object>}
Get seasons from a tv show
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
id |
String
|
TV Show ID |
|
segmentationValue |
string
|
<optional> |
optional segment to get a different config |
Seasons
Array.<Object>
# async inner searchMovies(params) → {Array.<Object>}
Search for Movies
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
params |
Object
|
parameter object |
|
keyword |
String
|
Keyword to search for Movies |
|
amount |
Number
|
<optional> |
Amount of items to return |
segmentationValue |
string
|
<optional> |
optional segment to get a different config |
Results
Array.<Object>
# async inner searchShows(params) → {Array.<Object>}
Search for Shows
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
params |
object
|
params |
|
keyword |
String
|
Keyword to search for Shows |
|
amount |
Number
|
Amount of items to return |
|
segmentationValue |
string
|
<optional> |
optional segment to get a different config |
Results
Array.<Object>