ClientShowApi

class ClientShowApi(api: GenericSpotifyApi) : ShowApi

Endpoints for retrieving information about one or more shows and their episodes from the Spotify catalog.

Api Reference

Constructors

ClientShowApi

common

fun ClientShowApi(api: GenericSpotifyApi)

Functions

equals

common

open operator fun equals(other: Any?): Boolean

getShow

common

suspend fun getShow(id: String): Show?

Get Spotify catalog information for a single show identified by its unique Spotify ID.

suspend fun getShow(id: String, market: Market): Show?

Get Spotify catalog information for a single show identified by its unique Spotify ID.

getShowEpisodes

common

suspend fun getShowEpisodes(id: String, limit: Int? = null, offset: Int? = null): PagingObject<SimpleEpisode>

Get Spotify catalog information about an show’s episodes.

suspend fun getShowEpisodes(id: String, limit: Int? = null, offset: Int? = null, market: Market): PagingObject<SimpleEpisode>

Get Spotify catalog information about an show’s episodes.

getShowEpisodesRestAction

common

fun getShowEpisodesRestAction(id: String, limit: Int? = null, offset: Int? = null): SpotifyRestAction<PagingObject<SimpleEpisode>>

Get Spotify catalog information about an show’s episodes.

fun getShowEpisodesRestAction(id: String, limit: Int? = null, offset: Int? = null, market: Market): SpotifyRestAction<PagingObject<SimpleEpisode>>

Get Spotify catalog information about an show’s episodes.

getShowRestAction

common

fun getShowRestAction(id: String): SpotifyRestAction<Show?>

Get Spotify catalog information for a single show identified by its unique Spotify ID.

fun getShowRestAction(id: String, market: Market): SpotifyRestAction<Show?>

Get Spotify catalog information for a single show identified by its unique Spotify ID.

getShows

common

suspend fun getShows(vararg ids: String): List<SimpleShow?>

Get Spotify catalog information for multiple shows based on their Spotify IDs.

suspend fun getShows(vararg ids: String, market: Market): List<SimpleShow?>

Get Spotify catalog information for multiple shows based on their Spotify IDs.

getShowsRestAction

common

fun getShowsRestAction(vararg ids: String): SpotifyRestAction<List<SimpleShow?>>

Get Spotify catalog information for multiple shows based on their Spotify IDs.

fun getShowsRestAction(vararg ids: String, market: Market): SpotifyRestAction<List<SimpleShow?>>

Get Spotify catalog information for multiple shows based on their Spotify IDs.

hashCode

common

open fun hashCode(): Int

toString

common

open fun toString(): String

Properties

api

common

val api: GenericSpotifyApi

cache

common

val cache: SpotifyCache

Sources

(source)