Constructor
new ListSection(apiKey, language)
Initializes this object.
- Source:
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
apiKey |
string
|
The TMDb API key. | |
language |
string
|
en-US | The language of queries, the default is "en-US". |
Methods
(async) createListAsync(name, description, language, sessionId) → {Promise.<exports.List>}
Creates a new list with the passed properties.
- Source:
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
name |
string
|
The name of the list. | |
description |
string
|
The description of the list. | |
language |
string
|
en-US | The language of the list. |
sessionId |
string
|
The session ID. |
Returns:
- Type:
-
Promise.<exports.List>
A Promise of a List instance representing the created list
(null if the creation was not successful).
getList(id) → {exports.List}
Gets a List instance, based on the passed ID.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string
|
The ID of the list. |
Returns:
- Type:
-
exports.List
A List object with the passed ID.