Methods
getAllParameters() → {*}
Gets all of the parameters in this settings object.
See the TMDb API documentation for a comprehensive list of parameters.
Returns:
- Type:
-
*
All parameters in these settings.
setPage(page)
Sets the value of the page parameter.
Parameters:
| Name | Type | Description |
|---|---|---|
page |
Number
|
The parameter value. |
setSortBy(sortBy)
Sets the value of the sort_by parameter.
Parameters:
| Name | Type | Description |
|---|---|---|
sortBy |
string
|
The parameter value (see tmdb_utils.sortingTypes for valid values). |
setVoteAverageGte(limit)
Sets the value of the vote_average.gte ("gte" stands for "greater than or equal to") parameter.
Parameters:
| Name | Type | Description |
|---|---|---|
limit |
Number
|
The parameter value. |
setVoteCountGte(limit)
Sets the value of the vote_count.gte ("gte" stands for "greater than or equal to") parameter.
Parameters:
| Name | Type | Description |
|---|---|---|
limit |
Number
|
The parameter value. |
setWatchRegion(watchRegion)
Sets the value of the watch_region parameter.
Parameters:
| Name | Type | Description |
|---|---|---|
watchRegion |
string
|
The parameter value. |
setWithCompanies(…companyIds)
Sets the value of the with_companies based on the passed company IDs.
This will determine which companies to include in the discover results.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
companyIds |
string
|
<repeatable> |
The company IDs. |
setWithGenres(…genreIds)
Sets the value of the with_genres parameter based on the passed genre IDs.
This will determine which genres to include in the discover results.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
genreIds |
string
|
<repeatable> |
The genre IDs. |
setWithKeywords(…keywords)
Sets the value of the with_keywords based on the passed keywords.
This will determine which keywords to include in the discover results.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
keywords |
string
|
<repeatable> |
The keywords. |
setWithOriginalLanguage(withOriginalLanguage)
Sets the value of the with_original_language parameter.
Parameters:
| Name | Type | Description |
|---|---|---|
withOriginalLanguage |
string
|
setWithoutGenres(…genreIds)
Sets the value of the without_genres parameter based on the passed genre IDs.
This will determine which genres not to include in the discover results.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
genreIds |
string
|
<repeatable> |
The genre IDs. |
setWithoutKeywords(…keywords)
Sets the value of the without_keywords based on the passed keywords.
This will determine which keywords not to include in the discover results.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
keywords |
string
|
<repeatable> |
The keywords. |
setWithRuntimeGte(limit)
Sets the value of the with_runtime.gte parameter ("gte" stands for "greater than or equal to").
Parameters:
| Name | Type | Description |
|---|---|---|
limit |
Number
|
The parameter value. |
setWithRuntimeLte(limit)
Sets the value of the with_runtime.lte parameter ("lte" stands for "less than or equal to").
Parameters:
| Name | Type | Description |
|---|---|---|
limit |
Number
|
The parameter value. |
setWithWatchMonetizationTypes(watchMonetizationTypes)
Sets the value of the with_watch_monetization_types parameter.
Parameters:
| Name | Type | Description |
|---|---|---|
watchMonetizationTypes |
string
|
The parameter value. |
setWithWatchProviders(…providerIds)
Sets the value of the with_watch_providers based on the passed provider IDs.
This will determine which watch providers to include in the discover results.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
providerIds |
string
|
<repeatable> |
The watch provider IDs. |