Members
-
spotify :Spotify
-
Description
The spotify client.
Details
Methods
-
get( id ) → {Promise.<(Episode|HTTPError|ApiError)>}
-
Description
Get Spotify catalog information for a single episode identified by its unique Spotify ID.
Parameters
Name Type Description id
string The Spotify ID for the episode.
Returns
Details
-
users( options ) → {Promise.<(Array.<Episode>|HTTPError|ApiError)>}
-
Description
Get a list of the episodes saved in the current Spotify user's library.
Parameters
Name Type Description options
LimitOptions Returns
Details
-
save( ids ) → {Promise.<(Status|HTTPError|ApiError)>}
-
Description
Save one or more episodes to the current user's library.
Parameters
Name Type Description ids
string | Array.<string> A list of the Spotify IDs.
Returns
Details
-
remove( ids ) → {Promise.<(Status|HTTPError|ApiError)>}
-
Description
Remove one or more episodes from the current user's library.
Parameters
Name Type Description ids
string | Array.<string> A list of the Spotify IDs.
Returns
Details
-
starred( ids ) → {Promise.<(Array.<boolean>|HTTPError|ApiError)>}
-
Description
Check if one or more episodes is already saved in the current Spotify user's 'Your Episodes' library.
Parameters
Name Type Description ids
string | Array.<string> A list of the Spotify IDs for the episodes.
Returns
Details
-
search( query, options ) → {Promise.<(Array.<Episode>|HTTPError|ApiError)>}
-
Description
Get Spotify catalog information about episodes.
Parameters
Name Type Description query
string Your search query.
options
SearchOptions Returns
Details