Constructor
new List(id, listSection)
Initializes this object.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string
|
The id of the list. |
listSection |
exports.ListSection
|
The parent ListSection. |
Methods
(async) addMovieAsync(movieId, sessionId) → {Promise.<boolean>}
Adds a movie to this list.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
movieId |
string
|
The movie id. |
sessionId |
string
|
The session id. |
Returns:
- Type:
-
Promise.<boolean>
A Promise of a boolean value indicating whether the addition was successful or not.
(async) clearAsync(sessionId) → {Promise.<boolean>}
Clears this list.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
sessionId |
string
|
The session id. |
Returns:
- Type:
-
Promise.<boolean>
A Promise of a boolean value indicating whether the clearing was successful or not.
(async) deleteAsync(sessionId) → {Promise.<boolean>}
Deletes this list.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
sessionId |
string
|
The session id. |
Returns:
- Type:
-
Promise.<boolean>
A Promise of a boolean value indicating whether the deletion was successful or not.
(async) getDetailsAsync() → {Promise.<*>}
Gets all details about this list.
- Source:
Returns:
- Type:
-
Promise.<*>
A Promise of list details.
(async) getItemStatusAsync(movieId) → {Promise.<*>}
Gets the item status of a movie in relation to this list.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
movieId |
string
|
The ID of the movie to get the status about. |
Returns:
- Type:
-
Promise.<*>
A Promise of item status data.
(async) removeMovieAsync(movieId, sessionId) → {Promise.<boolean>}
Removes a movie from this list.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
movieId |
string
|
The movie id. |
sessionId |
string
|
The session id. |
Returns:
- Type:
-
Promise.<boolean>
A Promise of a boolean value indicating whether the removal was successful or not.