SearchApi

open class SearchApi(api: GenericSpotifyApi) : SpotifyEndpoint

Get Spotify catalog information about artists, albums, tracks or playlists that match a keyword string. It is possible to have 0 results and no exception thrown with these methods. Check the size of items returned.

Api Reference

Constructors

SearchApi

common

fun SearchApi(api: GenericSpotifyApi)

Types

SearchType

common

enum SearchType : Enum<SearchApi.SearchType>

Describes which object to search forApi Reference

Functions

equals

common

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

hashCode

common

open fun hashCode(): Int

common

suspend fun search(query: String, vararg searchTypes: SearchApi.SearchType, limit: Int? = api.spotifyApiOptions.defaultLimit, offset: Int? = null, market: Market? = null, includeExternal: Boolean? = null): SpotifySearchResult

Get Spotify Catalog information about artists, albums, tracks and/or playlists that match a keyword string.

searchAlbum

common

suspend fun searchAlbum(query: String, limit: Int? = api.spotifyApiOptions.defaultLimit, offset: Int? = null, market: Market? = null): PagingObject<SimpleAlbum>

Get Spotify Catalog information about albums that match the keyword string.

searchAlbumRestAction

common

fun searchAlbumRestAction(query: String, limit: Int? = api.spotifyApiOptions.defaultLimit, offset: Int? = null, market: Market? = null): SpotifyRestAction<PagingObject<SimpleAlbum>>

Get Spotify Catalog information about albums that match the keyword string.

searchAllTypes

common

suspend fun searchAllTypes(query: String, limit: Int? = api.spotifyApiOptions.defaultLimit, offset: Int? = null, market: Market? = null): SpotifySearchResult

Get Spotify Catalog information about any searchable type that match the keyword string.

searchAllTypesRestAction

common

fun searchAllTypesRestAction(query: String, limit: Int? = api.spotifyApiOptions.defaultLimit, offset: Int? = null, market: Market? = null): SpotifyRestAction<SpotifySearchResult>

Get Spotify Catalog information about any searchable type that match the keyword string.

searchArtist

common

suspend fun searchArtist(query: String, limit: Int? = api.spotifyApiOptions.defaultLimit, offset: Int? = null, market: Market? = null): PagingObject<Artist>

Get Spotify Catalog information about artists that match the keyword string.

searchArtistRestAction

common

fun searchArtistRestAction(query: String, limit: Int? = api.spotifyApiOptions.defaultLimit, offset: Int? = null, market: Market? = null): SpotifyRestAction<PagingObject<Artist>>

Get Spotify Catalog information about artists that match the keyword string.

searchPlaylist

common

suspend fun searchPlaylist(query: String, limit: Int? = api.spotifyApiOptions.defaultLimit, offset: Int? = null, market: Market? = null): PagingObject<SimplePlaylist>

Get Spotify Catalog information about playlists that match the keyword string.

searchPlaylistRestAction

common

fun searchPlaylistRestAction(query: String, limit: Int? = api.spotifyApiOptions.defaultLimit, offset: Int? = null, market: Market? = null): SpotifyRestAction<PagingObject<SimplePlaylist>>

Get Spotify Catalog information about playlists that match the keyword string.

searchRestAction

common

fun searchRestAction(query: String, vararg searchTypes: SearchApi.SearchType, limit: Int? = api.spotifyApiOptions.defaultLimit, offset: Int? = null, market: Market? = null, includeExternal: Boolean? = null): SpotifyRestAction<SpotifySearchResult>

Get Spotify Catalog information about artists, albums, tracks and/or playlists that match a keyword string.

searchTrack

common

suspend fun searchTrack(query: String, limit: Int? = api.spotifyApiOptions.defaultLimit, offset: Int? = null, market: Market? = null): PagingObject<Track>

Get Spotify Catalog information about tracks that match the keyword string.

searchTrackRestAction

common

fun searchTrackRestAction(query: String, limit: Int? = api.spotifyApiOptions.defaultLimit, offset: Int? = null, market: Market? = null): SpotifyRestAction<PagingObject<Track>>

Get Spotify Catalog information about tracks that match the keyword string.

toString

common

open fun toString(): String

Properties

api

common

val api: GenericSpotifyApi

cache

common

val cache: SpotifyCache

Inheritors

ClientSearchApi

Sources

(source)