AbstractVodService

AbstractVodService ⇐ Abstract#

Kind: global abstract class
Extends: Abstract
Mixes: MServiceCache
Service:

• AbstractVodService ⇐ Abstract
  • new AbstractVodService()
  • .getCatalogsId([options]) ⇒ Promise.<string, Error>
  • .getCatalogs([options]) ⇒ Promise.<CatalogList, Error>
  • .getCatalog(catalogId, [options]) ⇒ Promise.<Catalog, Error>
  • .getCategory(catalogId, categoryId, [options]) ⇒ Promise.<Category, Error>
  • .getContents(id, options) ⇒ Promise.<ContentList, Error>
  • .getContentDetails(contentId, [options]) ⇒ Promise.<Content, Error>
  • .getContentMedia(contentId, [options]) ⇒ Promise.<AbstractMedia, Error>
  • .getPeopleDetails(peopleId, [options]) ⇒ Promise.<People, Error>
  • .search(params) ⇒ Promise.<Array.<AbstractMedia>, Error>
  • ._getCatalogsId([options]) ⇒ Promise
  • ._getCatalogs([options]) ⇒ Promise
  • ._getCatalog(catalogId, [options]) ⇒ Promise
  • ._getCategory(catalogId, categoryId, [options]) ⇒ Promise
  • ._getContents(id, options) ⇒ Promise.<Content, Error>
  • ._getContentDetails(contentId, [options]) ⇒ Promise
  • ._getContentMedia(contentId, [options]) ⇒ Promise
  • ._getPeopleDetails(peopleId, [options]) ⇒ Promise

AbstractVodService()#

The VodService exposes the VOD API.

Example

vodService
         .getCatalogsId()
         .then(catalogs => catalogs[0])
         .then(catalogId => vodService.getCatalog(catalogId))
         .then(catalog => vodService.getContents(catalog.children[0].id))
         .then(contents => {
             console.log(contents);
         })

getCatalogsId([options]) ⇒ Promise.<string, Error>#

Get all catalogs id

Kind: instance method of AbstractVodService
Returns: Promise.<string, Error> - list of catalog’s id

getCatalogs([options]) ⇒ Promise.<CatalogList, Error>#

Get all catalogs

Kind: instance method of AbstractVodService
Returns: Promise.<CatalogList, Error> - list of catalog’s id

getCatalog(catalogId, [options]) ⇒ Promise.<Catalog, Error>#

Retrieve available catalog by it’s id.

Kind: instance method of AbstractVodService
Returns: Promise.<Catalog, Error> - a catalog

getCategory(catalogId, categoryId, [options]) ⇒ Promise.<Category, Error>#

Retrieve a category information by it’s id.

Kind: instance method of AbstractVodService
Returns: Promise.<Category, Error> - a category

getContents(id, options) ⇒ Promise.<ContentList, Error>#

Retrieves contents of the given filter

Kind: instance method of AbstractVodService
Returns: Promise.<ContentList, Error> - list of content

getContentDetails(contentId, [options]) ⇒ Promise.<Content, Error>#

Retrieve content details by it’s id and type (MOVIE|SERIES|SEASON|EPISODE)

Kind: instance method of AbstractVodService
Returns: Promise.<Content, Error> - Content details

getContentMedia(contentId, [options]) ⇒ Promise.<AbstractMedia, Error>#

Retrieve content medias by it’s id

Kind: instance method of AbstractVodService
Returns: Promise.<AbstractMedia, Error> - A Promise resolved with a list of AbstractMedia

getPeopleDetails(peopleId, [options]) ⇒ Promise.<People, Error>#

Retrieve people and it’s content by id.

Kind: instance method of AbstractVodService
Returns: Promise.<People, Error> - People details

search(params) ⇒ Promise.<Array.<AbstractMedia>, Error>#

Search medias.

Kind: instance method of AbstractVodService
Returns: Promise.<Array.<AbstractMedia>, Error> - A Promise resolved with an array of AbstractMedia

_getCatalogsId([options]) ⇒ Promise#

Vendor implementation to get available catalogs id.

Kind: instance abstract method of AbstractVodService
Access: protected

_getCatalogs([options]) ⇒ Promise#

Vendor implementation to get available catalogs

Kind: instance abstract method of AbstractVodService
Access: protected

_getCatalog(catalogId, [options]) ⇒ Promise#

Vendor implementation to get available catalogs.

Kind: instance abstract method of AbstractVodService
Access: protected

_getCategory(catalogId, categoryId, [options]) ⇒ Promise#

Vendor implementation to get a category.

Kind: instance abstract method of AbstractVodService
Access: protected

_getContents(id, options) ⇒ Promise.<Content, Error>#

Vendor implementation to get contents of the given category

Kind: instance abstract method of AbstractVodService
Returns: Promise.<Content, Error> - list of content
Access: protected

_getContentDetails(contentId, [options]) ⇒ Promise#

Vendor implementation to get content details

Kind: instance abstract method of AbstractVodService
Access: protected

_getContentMedia(contentId, [options]) ⇒ Promise#

Vendor implementation to get content media

Kind: instance abstract method of AbstractVodService
Access: protected

_getPeopleDetails(peopleId, [options]) ⇒ Promise#

Vendor implementation to get people details

Kind: instance abstract method of AbstractVodService
Access: protected