Documentation ¶
Index ¶
- type Client
- type Gotify
- type OAuth
- type Tokens
- func (t *Tokens) CheckFollowPlaylist(ownerID string, playlistID string, userIDs []string) (*models.FollowPlaylist, error)
- func (t *Tokens) CheckUsersSavedAlbums(albumIDs []string) (*models.FollowAlbums, error)
- func (t *Tokens) CheckUsersSavedTracks(trackIDs []string) (*models.FollowTracks, error)
- func (t *Tokens) CurrentFollowsArtistsOrUsers(followType string, IDs []string) (*models.CurrentFollowsArtistsOrUsers, error)
- func (t *Tokens) FollowArtistsOrUsers(followType string, IDs []string) error
- func (t *Tokens) FollowPlaylist(ownerID string, playlistID string) error
- func (t *Tokens) GetAlbums(albumIDs []string) (*models.Albums, error)
- func (t *Tokens) GetAlbumsTracks(albumID string) (*models.AlbumsTracks, error)
- func (t *Tokens) GetArtists(artistIDs []string) (*models.Artists, error)
- func (t *Tokens) GetArtistsAlbums(artistID string) (*models.ArtistsAlbums, error)
- func (t *Tokens) GetArtistsRelatedArtists(artistID string) (*models.ArtistsRelatedArtists, error)
- func (t *Tokens) GetArtistsTopTracks(artistID string, country string) (*models.ArtistsTopTracks, error)
- func (t *Tokens) GetAudioAnalysis(trackID string) (*models.AudioAnalysis, error)
- func (t *Tokens) GetBrowseCategories() (*models.BrowseCategories, error)
- func (t *Tokens) GetBrowseCategory(categoryID string) (*models.BrowseCategory, error)
- func (t *Tokens) GetBrowseCategorysPlaylists(categoryID string) (*models.BrowseCategorysPlaylists, error)
- func (t *Tokens) GetBrowseFeaturedPlaylists() (*models.BrowseFeaturedPlaylists, error)
- func (t *Tokens) GetBrowseNewReleases() (*models.BrowseNewReleases, error)
- func (t *Tokens) GetCurrentUsersPlaylists() (*models.CurrentUsersProfile, error)
- func (t *Tokens) GetCurrentUsersProfile() (*models.CurrentUsersProfile, error)
- func (t *Tokens) GetFollowingArtists() (*models.FollowingArtists, error)
- func (t *Tokens) GetInformationAboutUsersCurrentPlayback() (*models.InformationAboutUsersCurrentPlayback, error)
- func (t *Tokens) GetRecentlyPlayedTracks() (*models.RecentlyPlayedTracks, error)
- func (t *Tokens) GetRecommendations() (*models.Recommendations, error)
- func (t *Tokens) GetTracks(trackIDs []string) (*models.Tracks, error)
- func (t *Tokens) GetUserStatus() (string, error)
- func (t *Tokens) GetUsersAvailableDevices() (*models.UsersAvailableDevices, error)
- func (t *Tokens) GetUsersCurrentlyPlayingTrack() (*models.UsersCurrentlyPlayingTrack, error)
- func (t *Tokens) GetUsersPlaylists(userID string) (*models.UsersPlaylists, error)
- func (t *Tokens) GetUsersProfile(userID string) (*models.UsersProfile, error)
- func (t *Tokens) GetUsersSavedAlbums() (*models.UsersSavedAlbums, error)
- func (t *Tokens) GetUsersSavedTracks() (*models.UsersSavedTracks, error)
- func (t *Tokens) PauseUsersPlayback() error
- func (t *Tokens) Refresh() error
- func (t *Tokens) RemoveAlbumsForCurrentUser(albumIDs []string) error
- func (t *Tokens) RemoveUsersSavedTracks(trackIDs []string) error
- func (t *Tokens) SaveAlbums(albumIDs []string) error
- func (t *Tokens) SaveTracks(trackIDs []string) error
- func (t *Tokens) SearchAlbums(keywords string) (*models.SearchAlbums, error)
- func (t *Tokens) SearchArtists(keywords string) (*models.SearchArtists, error)
- func (t *Tokens) SearchPlaylists(keywords string) (*models.SearchPlaylists, error)
- func (t *Tokens) SearchTracks(keywords string) (*models.SearchTracks, error)
- func (t *Tokens) SeekToPositionInCurrentlyPlayingTrack(position int) error
- func (t *Tokens) SetRepeatModeUsersPlayback(state string) error
- func (t *Tokens) SetVolumeUsersPlayback(volumePercent int) error
- func (t *Tokens) SkipUsersPlaybackToNext() error
- func (t *Tokens) SkipUsersPlaybackToPrevious() error
- func (t *Tokens) StartResumeUsersPlayback() error
- func (t *Tokens) StartUsersTrackPlay(trackinfo []string, seekms int) error
- func (t *Tokens) ToggleShuffleUsersPlayback(state bool) error
- func (t *Tokens) TransferUsersPlayback(deviceIDs []string) error
- func (t *Tokens) UnfollowArtistsOrUsers(unfollowType string, IDs []string) error
- func (t *Tokens) UnfollowPlaylist(ownerID string, playlistID string) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
Client : basic client data
type Gotify ¶
type Gotify interface { // method for token Refresh() error // albums GetAlbums(albumIDs []string) (*models.Albums, error) GetAlbumsTracks(albumID string) (*models.AlbumsTracks, error) GetArtists(artistIDs []string) (*models.Artists, error) GetArtistsAlbums(artistID string) (*models.ArtistsAlbums, error) GetArtistsTopTracks(artistID string, country string) (*models.ArtistsTopTracks, error) GetArtistsRelatedArtists(artistID string) (*models.ArtistsRelatedArtists, error) // browse GetBrowseFeaturedPlaylists() (*models.BrowseFeaturedPlaylists, error) GetBrowseNewReleases() (*models.BrowseNewReleases, error) GetBrowseCategories() (*models.BrowseCategories, error) GetBrowseCategory(categoryID string) (*models.BrowseCategory, error) GetBrowseCategorysPlaylists(categoryID string) (*models.BrowseCategorysPlaylists, error) // recommendations GetRecommendations() (*models.Recommendations, error) // following GetFollowingArtists() (*models.FollowingArtists, error) FollowArtistsOrUsers(followType string, IDs []string) error UnfollowArtistsOrUsers(unfollowType string, IDs []string) error CurrentFollowsArtistsOrUsers(followType string, IDs []string) (*models.CurrentFollowsArtistsOrUsers, error) FollowPlaylist(userID string, playlistID string) error UnfollowPlaylist(userID string, playlistID string) error CheckFollowPlaylist(ownerID string, playlistID string, userIDs []string) (*models.FollowPlaylist, error) // library SaveTracks(trackIDs []string) error GetUsersSavedTracks() (*models.UsersSavedTracks, error) RemoveUsersSavedTracks(trackIDs []string) error CheckUsersSavedTracks(tracksIDs []string) (*models.FollowTracks, error) SaveAlbums(albumIDs []string) error GetUsersSavedAlbums() (*models.UsersSavedAlbums, error) RemoveAlbumsForCurrentUser(albumIDs []string) error CheckUsersSavedAlbums(albumIDs []string) (*models.FollowAlbums, error) // personalization GetRecentlyPlayedTracks() (*models.RecentlyPlayedTracks, error) // player GetUsersAvailableDevices() (*models.UsersAvailableDevices, error) // FIXME // GetInformationAboutUsersCurrentPlayback() (*models.InformationAboutUsersCurrentPlayback, error) // FIXME //GetUsersCurrentlyPlayingTrack() (*models.UsersCurrentlyPlayingTrack, error) TransferUsersPlayback(deviceIDs []string) error StartResumeUsersPlayback() error StartUsersTrackPlay(trackinfo []string, seekms int) error PauseUsersPlayback() error SkipUsersPlaybackToNext() error SkipUsersPlaybackToPrevious() error SeekToPositionInCurrentlyPlayingTrack(position int) error SetRepeatModeUsersPlayback(state string) error SetVolumeUsersPlayback(volumePercent int) error ToggleShuffleUsersPlayback(state bool) error // search SearchArtists(keywords string) (*models.SearchArtists, error) SearchAlbums(keywords string) (*models.SearchAlbums, error) SearchPlaylists(keywords string) (*models.SearchPlaylists, error) SearchTracks(keywords string) (*models.SearchTracks, error) // tracks GetTracks(trackIDs []string) (*models.Tracks, error) GetAudioAnalysis(trackID string) (*models.AudioAnalysis, error) // profile GetCurrentUsersProfile() (*models.CurrentUsersProfile, error) GetUsersProfile(userID string) (*models.UsersProfile, error) // playlists GetUsersPlaylists(userID string) (*models.UsersPlaylists, error) GetCurrentUsersPlaylists() (*models.CurrentUsersProfile, error) }
Gotify : interface for each endpoint of Spotify API
type Tokens ¶
type Tokens struct { AccessToken string `json:"access_token"` TokenType string `json:"token_type"` Scope string `json:"scope"` ExpiresIn int `json:"expire_in"` RefreshToken string `json:"refresh_token"` // contains filtered or unexported fields }
Tokens : tokens for using API
func (*Tokens) CheckFollowPlaylist ¶
func (t *Tokens) CheckFollowPlaylist(ownerID string, playlistID string, userIDs []string) (*models.FollowPlaylist, error)
CheckFollowPlaylist : the method for GET https://api.spotify.com/v1/users/{owner_id}/playlists/{playlist_id}/followers/contains
func (*Tokens) CheckUsersSavedAlbums ¶
func (t *Tokens) CheckUsersSavedAlbums(albumIDs []string) (*models.FollowAlbums, error)
CheckUsersSavedAlbums : the method for GET https://api.spotify.com/v1/me/albums/contains
func (*Tokens) CheckUsersSavedTracks ¶
func (t *Tokens) CheckUsersSavedTracks(trackIDs []string) (*models.FollowTracks, error)
CheckUsersSavedTracks : the method for GET https://api.spotify.com/v1/me/tracks/contains
func (*Tokens) CurrentFollowsArtistsOrUsers ¶
func (t *Tokens) CurrentFollowsArtistsOrUsers(followType string, IDs []string) (*models.CurrentFollowsArtistsOrUsers, error)
CurrentFollowsArtistsOrUsers : the method for GET https://api.spotify.com/v1/me/following/contains
func (*Tokens) FollowArtistsOrUsers ¶
FollowArtistsOrUsers : the method for PUT https://api.spotify.com/v1/me/following
func (*Tokens) FollowPlaylist ¶
FollowPlaylist : the method for PUT https://api.spotify.com/v1/users/{owner_id}/playlists/{playlist_id}/followers
func (*Tokens) GetAlbums ¶
GetAlbums : method for GET https://api.spotify.com/v1/albums
func (*Tokens) GetAlbumsTracks ¶
func (t *Tokens) GetAlbumsTracks(albumID string) (*models.AlbumsTracks, error)
GetAlbumsTracks : the method for GET https://api.spotify.com/v1/albums/{id}/tracks
func (*Tokens) GetArtists ¶
GetArtists : the method for GET https://api.spotify.com/v1/artists
func (*Tokens) GetArtistsAlbums ¶
func (t *Tokens) GetArtistsAlbums(artistID string) (*models.ArtistsAlbums, error)
GetArtistsAlbums : the method for GET https://api.spotify.com/v1/artists/{id}/albums
func (*Tokens) GetArtistsRelatedArtists ¶
func (t *Tokens) GetArtistsRelatedArtists(artistID string) (*models.ArtistsRelatedArtists, error)
GetArtistsRelatedArtists : the method for GET https://api.spotify.com/v1/artists/{id}/related-artists
func (*Tokens) GetArtistsTopTracks ¶
func (t *Tokens) GetArtistsTopTracks(artistID string, country string) (*models.ArtistsTopTracks, error)
GetArtistsTopTracks : the method for GET https://api.spotify.com/v1/artists/{id}/top-tracks
func (*Tokens) GetAudioAnalysis ¶
func (t *Tokens) GetAudioAnalysis(trackID string) (*models.AudioAnalysis, error)
GetAudioAnalysis : the method for GET https://api.spotify.com/v1/audio-analysis/{id}
func (*Tokens) GetBrowseCategories ¶
func (t *Tokens) GetBrowseCategories() (*models.BrowseCategories, error)
GetBrowseCategories : the method for GET https://api.spotify.com/v1/browse/categories
func (*Tokens) GetBrowseCategory ¶
func (t *Tokens) GetBrowseCategory(categoryID string) (*models.BrowseCategory, error)
GetBrowseCategory : the method for GET https://api.spotify.com/v1/browse/categories/{category_id}
func (*Tokens) GetBrowseCategorysPlaylists ¶
func (t *Tokens) GetBrowseCategorysPlaylists(categoryID string) (*models.BrowseCategorysPlaylists, error)
GetBrowseCategorysPlaylists : the method for GET https://api.spotify.com/v1/browse/categories/{category_id}/playlists
func (*Tokens) GetBrowseFeaturedPlaylists ¶
func (t *Tokens) GetBrowseFeaturedPlaylists() (*models.BrowseFeaturedPlaylists, error)
GetBrowseFeaturedPlaylists : the method for GET https://api.spotify.com/v1/browse/featured-playlists
func (*Tokens) GetBrowseNewReleases ¶
func (t *Tokens) GetBrowseNewReleases() (*models.BrowseNewReleases, error)
GetBrowseNewReleases : the method for GET https://api.spotify.com/v1/browse/new-releases
func (*Tokens) GetCurrentUsersPlaylists ¶
func (t *Tokens) GetCurrentUsersPlaylists() (*models.CurrentUsersProfile, error)
GetUsersPlaylists : the method for GET https://api.spotify.com/v1/me/playlists
func (*Tokens) GetCurrentUsersProfile ¶
func (t *Tokens) GetCurrentUsersProfile() (*models.CurrentUsersProfile, error)
GetCurrentUsersProfile : the method for GET https://api.spotify.com/v1/me
func (*Tokens) GetFollowingArtists ¶
func (t *Tokens) GetFollowingArtists() (*models.FollowingArtists, error)
GetFollowingArtists : the method for GET https://api.spotify.com/v1/me/following?type=artist
func (*Tokens) GetInformationAboutUsersCurrentPlayback ¶
func (t *Tokens) GetInformationAboutUsersCurrentPlayback() (*models.InformationAboutUsersCurrentPlayback, error)
FIXME parse json failing GetInformationAboutUsersCurrentPlayback : the method for GET https://api.spotify.com/v1/me/player
func (*Tokens) GetRecentlyPlayedTracks ¶
func (t *Tokens) GetRecentlyPlayedTracks() (*models.RecentlyPlayedTracks, error)
GetRecentlyPlayedTracks : the method for GET https://api.spotify.com/v1/me/player/recently-played
func (*Tokens) GetRecommendations ¶
func (t *Tokens) GetRecommendations() (*models.Recommendations, error)
GetRecommendations : the method for GET https://api.spotify.com/v1/recommendations
func (*Tokens) GetTracks ¶
GetTracks : the method for GET https://api.spotify.com/v1/tracks
func (*Tokens) GetUserStatus ¶
GetUserStatus : return string
func (*Tokens) GetUsersAvailableDevices ¶
func (t *Tokens) GetUsersAvailableDevices() (*models.UsersAvailableDevices, error)
GetUsersAvailableDevices : the method for GET https://api.spotify.com/v1/me/player/devices
func (*Tokens) GetUsersCurrentlyPlayingTrack ¶
func (t *Tokens) GetUsersCurrentlyPlayingTrack() (*models.UsersCurrentlyPlayingTrack, error)
FIXME parse json failing GetUsersCurrentyPlayingTrack : the method for GET https://api.spotify.com/v1/me/player/currently-playing
func (*Tokens) GetUsersPlaylists ¶
func (t *Tokens) GetUsersPlaylists(userID string) (*models.UsersPlaylists, error)
GetUsersPlaylists : the method for GET https://api.spotify.com/v1/users/{user_id}/playlists
func (*Tokens) GetUsersProfile ¶
func (t *Tokens) GetUsersProfile(userID string) (*models.UsersProfile, error)
GetUsersProfile : the method for GET https://api.spotify.com/v1/me
func (*Tokens) GetUsersSavedAlbums ¶
func (t *Tokens) GetUsersSavedAlbums() (*models.UsersSavedAlbums, error)
GetUsersSavedAlbums : the method for GET https://api.spotify.com/v1/me/albums
func (*Tokens) GetUsersSavedTracks ¶
func (t *Tokens) GetUsersSavedTracks() (*models.UsersSavedTracks, error)
GetUsersSavedTracks : the method for GET https://api.spotify.com/v1/me/tracks
func (*Tokens) PauseUsersPlayback ¶
PauseUsersPlayback : the method for PUT https://api.spotify.com/v1/me/player/pause
func (*Tokens) RemoveAlbumsForCurrentUser ¶
RemoveAlbumsForCurrentUser : the method for DELETE https://api.spotify.com/v1/me/albums?ids={ids}
func (*Tokens) RemoveUsersSavedTracks ¶
RemoveUsersSavedTracks : the method for DELETE https://api.spotify.com/v1/me/tracks
func (*Tokens) SaveAlbums ¶
SaveAlbums : the method for GET https://api.spotify.com/v1/me/albums
func (*Tokens) SaveTracks ¶
SaveTracks : the method for PUT https://api.spotify.com/v1/me/tracks
func (*Tokens) SearchAlbums ¶
func (t *Tokens) SearchAlbums(keywords string) (*models.SearchAlbums, error)
SearchAlbums : the method for GET https://api.spotify.com/v1/search
func (*Tokens) SearchArtists ¶
func (t *Tokens) SearchArtists(keywords string) (*models.SearchArtists, error)
SearchArtists : the method for GET https://api.spotify.com/v1/search
func (*Tokens) SearchPlaylists ¶
func (t *Tokens) SearchPlaylists(keywords string) (*models.SearchPlaylists, error)
SearchPlaylists : the method for GET https://api.spotify.com/v1/search
func (*Tokens) SearchTracks ¶
func (t *Tokens) SearchTracks(keywords string) (*models.SearchTracks, error)
SearchTracks : the method for GET https://api.spotify.com/v1/search
func (*Tokens) SeekToPositionInCurrentlyPlayingTrack ¶
SeekToPositionInCurrentlyPlayingTrack : the method for PUT https://api.spotify.com/v1/me/player/seek
func (*Tokens) SetRepeatModeUsersPlayback ¶
SetRepeatModeUsersPlayback : the method for PUT https://api.spotify.com/v1/me/player/repeat
func (*Tokens) SetVolumeUsersPlayback ¶
SetVolumeUsersPlayback : the method for PUT https://api.spotify.com/v1/me/player/volume
func (*Tokens) SkipUsersPlaybackToNext ¶
SkipUsersPlaybackToNext : the method for POST https://api.spotify.com/v1/me/player/next
func (*Tokens) SkipUsersPlaybackToPrevious ¶
SkipUsersPlaybackToPrevious : the method for POST https://api.spotify.com/v1/me/player/previous
func (*Tokens) StartResumeUsersPlayback ¶
StartResumeUsersPlayback : the method for PUT https://api.spotify.com/v1/me/player/play
func (*Tokens) StartUsersTrackPlay ¶
StartUsersTrackPlay : the method for PUT https://api.spotify.com/v1/me/player/play
func (*Tokens) ToggleShuffleUsersPlayback ¶
ToggleShuffleUsersPlayback : the method for PUT https://api.spotify.com/v1/me/player/shuffle
func (*Tokens) TransferUsersPlayback ¶
TransferUsersPlayback : the method for PUT https://api.spotify.com/v1/me/player
func (*Tokens) UnfollowArtistsOrUsers ¶
UnfollowArtistsOrUsers : the method for DELETE https://api.spotify.com/v1/me/following
func (*Tokens) UnfollowPlaylist ¶
UnfollowPlaylist : the method for DELETE https://api.spotify.com/v1/users/{owner_id}/playlists/{playlist_id}/followers