- Source:
Curated API calls to the tmdb api end points for Movies.
These calls all reference their raw counterparts, but only return selected data points. Also, things like dates are converted to javascript date formats and image data are converted to URL strings.
Methods
(static) movieGetImages(showId, imageTypeopt) → {imagesReturn_typedef}
- Source:
Returns an array of image URLs. Filters and gives only 'en' English images
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
showId |
string | showId from TMDb API Show Search. |
||
imageType |
string |
<optional> |
posters
|
*'posters', 'backdrops' |
Returns:
Array of URLs to the images
- Type
- imagesReturn_typedef
(static) movieGetWatchProviders(movieId, countryCodes) → {movieWatchProviders_typedef}
- Source:
Returns an object with an array of movies returned based on passed title.
Parameters:
| Name | Type | Description |
|---|---|---|
movieId |
string | Movie Id |
countryCodes |
array.<string> | Array of country codes to return |
Returns:
Object data return
(static) movieSearchByTitle(searchValue, pageopt) → {movieSearchByTitle_typedef}
- Source:
Returns an object with an array of movies returned based on passed title.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
searchValue |
string | Value to search for |
||
page |
number |
<optional> |
1
|
page to return. Only works if multiple pages |
Returns:
Object data return
(static) movieGetDetails(movieId, withVideosopt) → {movieDetails_typedef}
- Source:
Returns an object with movie details from passed movieId
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
movieId |
number | movieId to get details for |
||
withVideos |
bool |
<optional> |
false
|
movieId to get details for |
Returns:
Object data return
- Type
- movieDetails_typedef
(static) movieGetVideos(movieId) → {movieVideos_typedef}
- Source:
Returns an object with videos for passed movieId
Parameters:
| Name | Type | Description |
|---|---|---|
movieId |
number | movieId to get details for |
Returns:
Object data return
- Type
- movieVideos_typedef
(static) movieGetRecommendations(movieId) → {moviesRecommendations_typedef}
- Source:
Returns an object with movies that are "similar" to the passed movieId's movie
Parameters:
| Name | Type | Description |
|---|---|---|
movieId |
number | movieId to get details for |
Returns:
Object data return
(static) movieGetPopular(movieId) → {moviesSimilar_typedef}
- Source:
Returns an object with movies that are "similar" to the passed movieId's movie
Parameters:
| Name | Type | Description |
|---|---|---|
movieId |
number | movieId to get details for |
Returns:
Object data return
- Type
- moviesSimilar_typedef
(static) movieGetCredits(movieId) → {movieCredits_typedef}
- Source:
Returns an object with cast and crew for passed movieId
Parameters:
| Name | Type | Description |
|---|---|---|
movieId |
number | movieId to get details for |
Returns:
Object data return { cast: [{}], crew: [{}], apiCall }
- Type
- movieCredits_typedef
(static) movieGetPersonCredits(personId) → {moviePersonCredits_typedef}
- Source:
Returns an object with movies where person was part of cast or crew for passed personId
Parameters:
| Name | Type | Description |
|---|---|---|
personId |
number | personId to get details for |
Returns:
Object data return { cast: [{}], crew: [{}], apiCall }
(static) movieDiscover(criteriaObj, pageopt) → {movieDiscover_typedef}
- Source:
Returns an object with data matching passed criteriaObj criteria
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
criteriaObj |
movieDiscoverCriteria_typedef | object with criteria to search for |
||
page |
number |
<optional> |
1
|
page to return. Only works if multiple pages |
Returns:
Object data return