Struct rspotify::spotify::client::Spotify

pub struct Spotify {
    pub prefix: String,
    pub access_token: Option<String>,
    pub client_credentials_manager: Option<SpotifyClientCredentials>,
}

Spotify API object

Fields

prefix: String

access_token: Option<String>

client_credentials_manager: Option<SpotifyClientCredentials>

Methods

impl Spotify

If you want to check examples of all API endpoint, you could check the examples in github

pub fn default() -> Spotify

pub fn prefix(self, prefix: &str) -> Spotify

pub fn access_token(self, access_token: &str) -> Spotify

pub fn client_credentials_manager(
    self,
    client_credential_manager: SpotifyClientCredentials
) -> Spotify

pub fn build(self) -> Spotify

pub fn track(&self, track_id: &str) -> Result<FullTrack, Error>

get-track returns a single track given the track's ID, URI or URL Parameters:

• track_id - a spotify URI, URL or ID

pub fn tracks(
    &self,
    track_ids: Vec<&str>,
    market: Option<Country>
) -> Result<FullTracks, Error>

get-several-tracks returns a list of tracks given a list of track IDs, URIs, or URLs Parameters:

• track_ids - a list of spotify URIs, URLs or IDs
• market - an ISO 3166-1 alpha-2 country code.

pub fn artist(&self, artist_id: &str) -> Result<FullArtist, Error>

get-artist returns a single artist given the artist's ID, URI or URL Parameters:

• artist_id - an artist ID, URI or URL

pub fn artists(&self, artist_ids: Vec<String>) -> Result<FullArtists, Error>

get-several-artists returns a list of artists given the artist IDs, URIs, or URLs Parameters:

• artist_ids - a list of artist IDs, URIs or URLs

pub fn artist_albums(
    &self,
    artist_id: &str,
    album_type: Option<AlbumType>,
    country: Option<Country>,
    limit: Option<u32>,
    offset: Option<u32>
) -> Result<Page<SimplifiedAlbum>, Error>

get-artists-albums Get Spotify catalog information about an artist's albums

• artist_id - the artist ID, URI or URL
• album_type - 'album', 'single', 'appears_on', 'compilation'
• country - limit the response to one particular country.
• limit - the number of albums to return
• offset - the index of the first album to return

pub fn artist_top_tracks<T: Into<Option<Country>>>(
    &self,
    artist_id: &str,
    country: T
) -> Result<FullTracks, Error>

get artists to tracks Get Spotify catalog information about an artist's top 10 tracks by country. Parameters: - artist_id - the artist ID, URI or URL - country - limit the response to one particular country.

pub fn artist_related_artists(
    &self,
    artist_id: &str
) -> Result<FullArtists, Error>

get related artists Get Spotify catalog information about artists similar to an identified artist. Similarity is based on analysis of the Spotify community's listening history. Parameters:

• artist_id - the artist ID, URI or URL

pub fn album(&self, album_id: &str) -> Result<FullAlbum, Error>

get album returns a single album given the album's ID, URIs or URL Parameters:

• album_id - the album ID, URI or URL

pub fn albums(&self, album_ids: Vec<String>) -> Result<FullAlbums, Error>

get several albums returns a list of albums given the album IDs, URIs, or URLs Parameters:

• albums_ids - a list of album IDs, URIs or URLs

pub fn search_album<L: Into<Option<u32>>, O: Into<Option<u32>>>(
    &self,
    q: &str,
    limit: L,
    offset: O,
    market: Option<Country>
) -> Result<SearchAlbums, Error>

search item, type is album search for items Get Spotify catalog information about artists, albums, tracks or playlists that match a keyword string. Parameters:

• q - the search query
• limit - the number of items to return
• offset - the index of the first item to return 'track' or 'playlist'
• market - An ISO 3166-1 alpha-2 country code or the string from_token.

pub fn search_artist<L: Into<Option<u32>>, O: Into<Option<u32>>>(
    &self,
    q: &str,
    limit: L,
    offset: O,
    market: Option<Country>
) -> Result<SearchArtists, Error>

search item, type is artist search for items Get Spotify catalog information about artists, albums, tracks or playlists that match a keyword string. Parameters:

• q - the search query
• limit - the number of items to return
• offset - the index of the first item to return 'track' or 'playlist'
• market - An ISO 3166-1 alpha-2 country code or the string from_token.

pub fn search_track<L: Into<Option<u32>>, O: Into<Option<u32>>>(
    &self,
    q: &str,
    limit: L,
    offset: O,
    market: Option<Country>
) -> Result<SearchTracks, Error>

search item, type is track search for items Get Spotify catalog information about artists, albums, tracks or playlists that match a keyword string. Parameters:

• q - the search query
• limit - the number of items to return
• offset - the index of the first item to return 'track' or 'playlist'
• market - An ISO 3166-1 alpha-2 country code or the string from_token.

pub fn search_playlist<L: Into<Option<u32>>, O: Into<Option<u32>>>(
    &self,
    q: &str,
    limit: L,
    offset: O,
    market: Option<Country>
) -> Result<SearchPlaylists, Error>

search item, type is playlist search for items Get Spotify catalog information about artists, albums, tracks or playlists that match a keyword string. Parameters:

• q - the search query
• limit - the number of items to return
• offset - the index of the first item to return 'track' or 'playlist'
• market - An ISO 3166-1 alpha-2 country code or the string from_token.

pub fn album_track<L: Into<Option<u32>>, O: Into<Option<u32>>>(
    &self,
    album_id: &str,
    limit: L,
    offset: O
) -> Result<Page<SimplifiedTrack>, Error>

get albums tracks Get Spotify catalog information about an album's tracks Parameters:

• album_id - the album ID, URI or URL
• limit - the number of items to return
• offset - the index of the first item to return

pub fn user(&self, user_id: &str) -> Result<PublicUser, Error>

get users profile Gets basic profile information about a Spotify User Parameters:

• user - the id of the usr

pub fn playlist(
    &self,
    playlist_id: &str,
    fields: Option<&str>,
    market: Option<Country>
) -> Result<FullPlaylist, Error>

get playlist Get full details about Spotify playlist Parameters:

• playlist_id - the id of the playlist
• market - an ISO 3166-1 alpha-2 country code.

pub fn current_user_playlists<L: Into<Option<u32>>, O: Into<Option<u32>>>(
    &self,
    limit: L,
    offset: O
) -> Result<Page<SimplifiedPlaylist>, Error>

get users playlists Get current user playlists without required getting his profile Parameters:

• limit - the number of items to return
• offset - the index of the first item to return

pub fn user_playlists<L: Into<Option<u32>>, O: Into<Option<u32>>>(
    &self,
    user_id: &str,
    limit: L,
    offset: O
) -> Result<Page<SimplifiedPlaylist>, Error>

get list users playlists Gets playlists of a user Parameters:

• user_id - the id of the usr
• limit - the number of items to return
• offset - the index of the first item to return

pub fn user_playlist(
    &self,
    user_id: &str,
    playlist_id: Option<&mut str>,
    fields: Option<&str>,
    market: Option<Country>
) -> Result<FullPlaylist, Error>

get list users playlists Gets playlist of a user Parameters:

• user_id - the id of the user
• playlist_id - the id of the playlist
• fields - which fields to return

pub fn user_playlist_tracks<L: Into<Option<u32>>, O: Into<Option<u32>>>(
    &self,
    user_id: &str,
    playlist_id: &str,
    fields: Option<&str>,
    limit: L,
    offset: O,
    market: Option<Country>
) -> Result<Page<PlaylistTrack>, Error>

get playlists tracks Get full details of the tracks of a playlist owned by a user Parameters:

• user_id - the id of the user
• playlist_id - the id of the playlist
• fields - which fields to return
• limit - the maximum number of tracks to return
• offset - the index of the first track to return
• market - an ISO 3166-1 alpha-2 country code.

pub fn user_playlist_create<P: Into<Option<bool>>, D: Into<Option<String>>>(
    &self,
    user_id: &str,
    name: &str,
    public: P,
    description: D
) -> Result<FullPlaylist, Error>

create playlist Creates a playlist for a user Parameters:

• user_id - the id of the user
• name - the name of the playlist
• public - is the created playlist public
• description - the description of the playlist

pub fn user_playlist_change_detail(
    &self,
    user_id: &str,
    playlist_id: &str,
    name: Option<&str>,
    public: Option<bool>,
    description: Option<String>,
    collaborative: Option<bool>
) -> Result<String, Error>

change playlists details Changes a playlist's name and/or public/private state Parameters:

• user_id - the id of the user
• playlist_id - the id of the playlist
• name - optional name of the playlist
• public - optional is the playlist public
• collaborative - optional is the playlist collaborative
• description - optional description of the playlist

pub fn user_playlist_unfollow(
    &self,
    user_id: &str,
    playlist_id: &str
) -> Result<String, Error>

unfollow playlist Unfollows (deletes) a playlist for a user Parameters:

• user_id - the id of the user
• playlist_id - the id of the playlist

pub fn user_playlist_add_tracks(
    &self,
    user_id: &str,
    playlist_id: &str,
    track_ids: &[String],
    position: Option<i32>
) -> Result<CUDResult, Error>

add tracks to playlist Adds tracks to a playlist Parameters:

• user_id - the id of the user
• playlist_id - the id of the playlist
• track_ids - a list of track URIs, URLs or IDs
• position - the position to add the tracks

pub fn user_playlist_replace_tracks(
    &self,
    user_id: &str,
    playlist_id: &str,
    track_ids: &[String]
) -> Result<(), Error>

replaced playlists tracks Replace all tracks in a playlist Parameters:

• user - the id of the user
• playlist_id - the id of the playlist
• tracks - the list of track ids to add to the playlist

pub fn user_playlist_recorder_tracks<R: Into<Option<u32>>>(
    &self,
    user_id: &str,
    playlist_id: &str,
    range_start: i32,
    range_length: R,
    insert_before: i32,
    snapshot_id: Option<String>
) -> Result<CUDResult, Error>

reorder playlists tracks Reorder tracks in a playlist Parameters:

• user_id - the id of the user
• playlist_id - the id of the playlist
• range_start - the position of the first track to be reordered
• range_length - optional the number of tracks to be reordered (default: 1)
• insert_before - the position where the tracks should be inserted
• snapshot_id - optional playlist's snapshot ID

pub fn user_playlist_remove_all_occurrences_of_tracks(
    &self,
    user_id: &str,
    playlist_id: &str,
    track_ids: &[String],
    snapshot_id: Option<String>
) -> Result<CUDResult, Error>

remove tracks playlist Removes all occurrences of the given tracks from the given playlist Parameters:

• user_id - the id of the user
• playlist_id - the id of the playlist
• track_ids - the list of track ids to add to the playlist
• snapshot_id - optional id of the playlist snapshot

pub fn user_playlist_remove_specific_occurrenes_of_tracks(
    &self,
    user_id: &str,
    playlist_id: &str,
    tracks: Vec<Map<String, Value>>,
    snapshot_id: Option<String>
) -> Result<CUDResult, Error>

remove tracks playlist Removes all occurrences of the given tracks from the given playlist Parameters:

• user_id - the id of the user
• playlist_id - the id of the playlist
• tracks - an array of map containing Spotify URIs of the tracks to remove with their current positions in the playlist. For example: { "tracks": [{ "uri": "spotify:track:4iV5W9uYEdYUVa79Axb7Rh", "positions": [0,3] },{ "uri": "spotify:track:1301WleyT98MSxVHPZCA6M", "positions": [7] }] }
• snapshot_id - optional id of the playlist snapshot

pub fn user_playlist_follow_playlist<P: Into<Option<bool>>>(
    &self,
    playlist_owner_id: &str,
    playlist_id: &str,
    public: P
) -> Result<(), Error>

follow playlist Add the current authenticated user as a follower of a playlist. Parameters:

• playlist_owner_id - the user id of the playlist owner
• playlist_id - the id of the playlist

pub fn user_playlist_check_follow(
    &self,
    playlist_owner_id: &str,
    playlist_id: &str,
    user_ids: &[String]
) -> Result<Vec<bool>, Error>

check user following playlist Check to see if the given users are following the given playlist Parameters:

• playlist_owner_id - the user id of the playlist owner
• playlist_id - the id of the playlist
• user_ids - the ids of the users that you want to check to see if they follow the playlist. Maximum: 5 ids.

pub fn me(&self) -> Result<PrivateUser, Error>

get current users profile Get detailed profile information about the current user. An alias for the 'current_user' method.

pub fn current_user(&self) -> Result<PrivateUser, Error>

Get detailed profile information about the current user. An alias for the 'me' method.

pub fn current_user_playing_track(&self) -> Result<Option<Playing>, Error>

get the users currently playing track Get information about the current users currently playing track.

pub fn current_user_saved_albums<L: Into<Option<u32>>, O: Into<Option<u32>>>(
    &self,
    limit: L,
    offset: O
) -> Result<Page<SavedAlbum>, Error>

get user saved albums Gets a list of the albums saved in the current authorized user's "Your Music" library Parameters:

• limit - the number of albums to return
• offset - the index of the first album to return
• market - Provide this parameter if you want to apply Track Relinking.

pub fn current_user_saved_tracks<L: Into<Option<u32>>, O: Into<Option<u32>>>(
    &self,
    limit: L,
    offset: O
) -> Result<Page<SavedTrack>, Error>

get users saved tracks Parameters:

• limit - the number of tracks to return
• offset - the index of the first track to return
• market - Provide this parameter if you want to apply Track Relinking.

pub fn current_user_followed_artists<L: Into<Option<u32>>>(
    &self,
    limit: L,
    after: Option<String>
) -> Result<CursorPageFullArtists, Error>

get followed artists Gets a list of the artists followed by the current authorized user Parameters:

• limit - the number of tracks to return
• after - ghe last artist ID retrieved from the previous request

pub fn current_user_saved_tracks_delete(
    &self,
    track_ids: &[String]
) -> Result<(), Error>

remove tracks users Remove one or more tracks from the current user's "Your Music" library. Parameters:

• track_ids - a list of track URIs, URLs or IDs

pub fn current_user_saved_tracks_contains(
    &self,
    track_ids: &[String]
) -> Result<Vec<bool>, Error>

check users saved tracks Check if one or more tracks is already saved in the current Spotify user’s “Your Music” library. Parameters:

• track_ids - a list of track URIs, URLs or IDs

pub fn current_user_saved_tracks_add(
    &self,
    track_ids: &[String]
) -> Result<(), Error>

save tracks user Save one or more tracks to the current user's "Your Music" library. Parameters:

• track_ids - a list of track URIs, URLs or IDs

pub fn current_user_top_artists<L: Into<Option<u32>>, O: Into<Option<u32>>, T: Into<Option<TimeRange>>>(
    &self,
    limit: L,
    offset: O,
    time_range: T
) -> Result<Page<FullArtist>, Error>

get users top artists and tracks Get the current user's top artists Parameters:

• limit - the number of entities to return
• offset - the index of the first entity to return
• time_range - Over what time frame are the affinities computed

pub fn current_user_top_tracks<L: Into<Option<u32>>, O: Into<Option<u32>>, T: Into<Option<TimeRange>>>(
    &self,
    limit: L,
    offset: O,
    time_range: T
) -> Result<Page<FullTrack>, Error>

get users top artists and tracks Get the current user's top tracks Parameters:

• limit - the number of entities to return
• offset - the index of the first entity to return
• time_range - Over what time frame are the affinities computed

pub fn current_user_recently_played<L: Into<Option<u32>>>(
    &self,
    limit: L
) -> Result<CursorBasedPage<PlayHistory>, Error>

get recently played Get the current user's recently played tracks Parameters:

• limit - the number of entities to return

pub fn current_user_saved_albums_add(
    &self,
    album_ids: &[String]
) -> Result<(), Error>

save albums user Add one or more albums to the current user's "Your Music" library. Parameters:

• album_ids - a list of album URIs, URLs or IDs

pub fn current_user_saved_albums_delete(
    &self,
    album_ids: &[String]
) -> Result<(), Error>

remove albums user Remove one or more albums from the current user's "Your Music" library. Parameters:

• album_ids - a list of album URIs, URLs or IDs

pub fn current_user_saved_albums_contains(
    &self,
    album_ids: &[String]
) -> Result<Vec<bool>, Error>

check users saved albums Check if one or more albums is already saved in the current Spotify user’s “Your Music” library. Parameters:

• album_ids - a list of album URIs, URLs or IDs

pub fn user_follow_artists(&self, artist_ids: &[String]) -> Result<(), Error>

follow artists users Follow one or more artists Parameters:

• artist_ids - a list of artist IDs

pub fn user_unfollow_artists(&self, artist_ids: &[String]) -> Result<(), Error>

unfollow artists users Unfollow one or more artists Parameters:

• artist_ids - a list of artist IDs

pub fn user_artist_check_follow(
    &self,
    artsit_ids: &[String]
) -> Result<Vec<bool>, Error>

check user following artists Check to see if the given users are following the given artists Parameters:

• artist_ids - the ids of the users that you want to

pub fn user_follow_users(&self, user_ids: &[String]) -> Result<(), Error>

follow artists users Follow one or more users Parameters:

• user_ids - a list of artist IDs

pub fn user_unfollow_users(&self, user_ids: &[String]) -> Result<(), Error>

unfollow artists users Unfollow one or more users Parameters:

• user_ids - a list of artist IDs

pub fn featured_playlists<L: Into<Option<u32>>, O: Into<Option<u32>>>(
    &self,
    locale: Option<String>,
    country: Option<Country>,
    timestamp: Option<DateTime<Utc>>,
    limit: L,
    offset: O
) -> Result<FeaturedPlaylists, Error>

get list featured playlists Get a list of Spotify featured playlists Parameters:

• locale - The desired language, consisting of a lowercase ISO 639 language code and an uppercase ISO 3166-1 alpha-2 country code, joined by an underscore.
• country - An ISO 3166-1 alpha-2 country code.
• timestamp - A timestamp in ISO 8601 format: yyyy-MM-ddTHH:mm:ss. Use this parameter to specify the user's local time to get results tailored for that specific date and time in the day
• limit - The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50
• offset - The index of the first item to return. Default: 0 (the first object). Use with limit to get the next set of items.

pub fn new_releases<L: Into<Option<u32>>, O: Into<Option<u32>>>(
    &self,
    country: Option<Country>,
    limit: L,
    offset: O
) -> Result<PageSimpliedAlbums, Error>

get list new releases Get a list of new album releases featured in Spotify Parameters:

• country - An ISO 3166-1 alpha-2 country code.
• limit - The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50
• offset - The index of the first item to return. Default: 0 (the first object). Use with limit to get the next set of items.

pub fn categories<L: Into<Option<u32>>, O: Into<Option<u32>>>(
    &self,
    locale: Option<String>,
    country: Option<Country>,
    limit: L,
    offset: O
) -> Result<PageCategory, Error>

get list categories Get a list of new album releases featured in Spotify Parameters:

• country - An ISO 3166-1 alpha-2 country code.
• locale - The desired language, consisting of an ISO 639 language code and an ISO 3166-1 alpha-2 country code, joined by an underscore.
• limit - The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50
• offset - The index of the first item to return. Default: 0 (the first object). Use with limit to get the next set of items.

pub fn recommendations<L: Into<Option<u32>>>(
    &self,
    seed_artists: Option<Vec<String>>,
    seed_genres: Option<Vec<String>>,
    seed_tracks: Option<Vec<String>>,
    limit: L,
    country: Option<Country>,
    payload: &Map<String, Value>
) -> Result<Recommendations, Error>

get recommendtions Get Recommendations Based on Seeds Parameters:

• seed_artists - a list of artist IDs, URIs or URLs
• seed_tracks - a list of artist IDs, URIs or URLs
• seed_genres - a list of genre names. Available genres for
• country - An ISO 3166-1 alpha-2 country code. If provided, all results will be playable in this country.
• limit - The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 100
• min/max/target_ - For the tuneable track attributes listed in the documentation, these values provide filters and targeting on results.

pub fn audio_features(&self, track: &str) -> Result<AudioFeatures, Error>

get audio features Get audio features for a track

• track - track URI, URL or ID

pub fn audios_features(
    &self,
    tracks: &[String]
) -> Result<Option<AudioFeaturesPayload>, Error>

get several audio features Get Audio Features for Several Tracks -tracks a list of track URIs, URLs or IDs

pub fn audio_analysis(&self, track: &str) -> Result<AudioAnalysis, Error>

get audio analysis Get Audio Analysis for a Track Parameters:

• track_id - a track URI, URL or ID

pub fn device(&self) -> Result<DevicePayload, Error>

get a users available devices Get a User’s Available Devices

pub fn current_playback(
    &self,
    market: Option<Country>
) -> Result<Option<FullPlayingContext>, Error>

get informatation about the users current playback Get Information About The User’s Current Playback Parameters: - market - an ISO 3166-1 alpha-2 country code.

pub fn current_playing(
    &self,
    market: Option<Country>
) -> Result<Option<SimplifiedPlayingContext>, Error>

get the users currently playing track Get the User’s Currently Playing Track Parameters: - market - an ISO 3166-1 alpha-2 country code.

pub fn transfer_playback<T: Into<Option<bool>>>(
    &self,
    device_id: &str,
    force_play: T
) -> Result<(), Error>

transfer a users playback Transfer a User’s Playback Note: Although an array is accepted, only a single device_id is currently supported. Supplying more than one will return 400 Bad Request Parameters:

• device_id - transfer playback to this device
• force_play - true: after transfer, play. false: keep current state.

pub fn start_playback(
    &self,
    device_id: Option<String>,
    context_uri: Option<String>,
    uris: Option<Vec<String>>,
    offset: Option<Offset>,
    position_ms: Option<u32>
) -> Result<(), Error>

start a users playback Start/Resume a User’s Playback Provide a context_uri to start playback or a album, artist, or playlist.

Provide a uris list to start playback of one or more tracks.

Provide offset as {"position": } or {"uri": ""} to start playback at a particular offset.

Parameters:

• device_id - device target for playback
• context_uri - spotify context uri to play
• uris - spotify track uris
• offset - offset into context by index or track
• position_ms - Indicates from what position to start playback.

pub fn pause_playback(&self, device_id: Option<String>) -> Result<(), Error>

pause a users playback Pause a User’s Playback Parameters:

• device_id - device target for playback

pub fn next_track(&self, device_id: Option<String>) -> Result<(), Error>

skip users playback to the next track Skip User’s Playback To Next Track Parameters:

• device_id - device target for playback

pub fn previous_track(&self, device_id: Option<String>) -> Result<(), Error>

skip users playback to previous track Skip User’s Playback To Previous Track Parameters:

• device_id - device target for playback

pub fn seek_track(
    &self,
    position_ms: u32,
    device_id: Option<String>
) -> Result<(), Error>

seek-to-position-in-currently-playing-track/ Seek To Position In Currently Playing Track Parameters:

• position_ms - position in milliseconds to seek to
• device_id - device target for playback

pub fn repeat(
    &self,
    state: RepeatState,
    device_id: Option<String>
) -> Result<(), Error>

set repeat mode on users playback Set Repeat Mode On User’s Playback Parameters:

• state - track, context, or off
• device_id - device target for playback

pub fn volume(
    &self,
    volume_percent: u8,
    device_id: Option<String>
) -> Result<(), Error>

set-volume-for-users-playback Set Volume For User’s Playback Parameters:

• volume_percent - volume between 0 and 100
• device_id - device target for playback

pub fn shuffle(
    &self,
    state: bool,
    device_id: Option<String>
) -> Result<(), Error>

toggle shuffle for user playback Toggle Shuffle For User’s Playback Parameters:

• state - true or false
• device_id - device target for playback

pub fn convert_result<'a, T: Deserialize<'a>>(
    &self,
    input: &'a str
) -> Result<T, Error>

Trait Implementations

impl Clone for Spotify

fn clone(&self) -> Spotify

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Spotify

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Spotify

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for Spotify

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.