Methods
-
getContentsManager() → {module:caplin/watchlist/WatchlistContentsManager}
-
Returns a
module:caplin/watchlist/WatchlistContentsManager
for this watchlist. This can then be used to modify the contents of the watchlist.- Implementations:
Returns:
may be used to modify the watchlist contents. -
getId() → {string}
-
A unique identifier for this watchlist.
- Implementations:
- See:
Returns:
This watchlist's id.- Type
- string
-
getName() → {string}
-
The user-friendly name chosen for this watchlist. This will typically have been chosen by the user when the watchlist was created.
- Implementations:
Returns:
This watchlist's user-friendly name.- Type
- string
-
getSubject() → {string}
-
The subject of this watchlist's container record. This can be used to create a subscription to the watchlist's contents.
- Implementations:
Returns:
This watchlist's subject.- Type
- string
-
setName(name, erroropt, successopt)
-
Sets the user-friendly name for this watchlist.
Parameters:
Name Type Attributes Description name
string The new user-friendly name for this watchlist. error
function <optional>
function to be called if the operation fails. success
function <optional>
function to be called when the operation completes successfully. -
setPosition(position, erroropt, successopt)
-
Sets the watchlist's position.
Parameters:
Name Type Attributes Description position
integer the watchlist position index (0 based) error
function <optional>
function to be called if operation fails success
function <optional>
function to be called if operation succeeds - Implementations:
- module:caplin/sljsadapter/watchlist/StreamLinkWatchlist#setPosition
- module:caplin/watchlist/NullWatchlist#setPosition
Throws:
-
If position argument is not an integer.