Rdioh

Documentation

runRdio :: String -> String -> Rdio a -> IO a

Takes: a key, a secret, a function to run.

runRdioWithAuth :: String -> String -> Rdio a -> IO a

Same as runRdio, but with 3-legged authentication i.e. the user will | have to authorize your app.

type Rdio a = ReaderT Token IO a

The Rdio monad...just a wrapper around a ReaderT monad.

mkExtras :: Show e => [e] -> (String, String)

used internally

runRequest :: (Show v, FromJSON v) => [(String, String)] -> Rdio (Either String v)

Send a arbitrary request to rdio's api. Return type should | be an instance of FromJSON, and you need to specify the type. Example:

 result <- (runRequest [("method", "getTopCharts"), ("type", "Artist")] :: Rdio (Either String [Artist]))

get :: (Show a, FromJSON a) => [String] -> [String] -> Rdio (Either String a)

Takes: [keys], [extras] (optional)

getObjectFromShortCode :: (Show a, FromJSON a) => String -> [String] -> Rdio (Either String a)

Takes: short code (everything after the http:rd.iox), [extras] (optional)

getObjectFromUrl :: (Show a, FromJSON a) => String -> [String] -> Rdio (Either String a)

Takes: url (everything after http:rdio.com/), [extras] (optional)

getAlbumsByUPC :: Int -> [AlbumExtra] -> Rdio (Either String [Album])

Takes: a UPC code, [extras] (optional)

getAlbumsForArtist :: String -> Rdio (Either String [Album])

Takes: A key of an artist

getAlbumsForArtist' :: String -> Maybe Bool -> [AlbumExtra] -> Maybe Int -> Maybe Int -> Rdio (Either String [Album])

getAlbumsForLabel :: String -> Rdio (Either String [Album])

Takes: a key of a label

getAlbumsForLabel' :: String -> [AlbumExtra] -> Maybe Int -> Maybe Int -> Rdio (Either String [Album])

getArtistsForLabel :: String -> Rdio (Either String [Artist])

Takes: a key of a label

getArtistsForLabel' :: String -> [ArtistExtra] -> Maybe Int -> Maybe Int -> Rdio (Either String [Artist])

getTracksByISRC :: String -> [TrackExtra] -> Rdio (Either String [Track])

Takes: an ISRC code, [extras] (optional)

getTracksForArtist :: String -> Rdio (Either String [Track])

Takes: an artist key

getTracksForArtist' :: String -> Maybe Bool -> [TrackExtra] -> Maybe Int -> Maybe Int -> Rdio (Either String [Track])

search :: (Show a, FromJSON a) => String -> String -> Rdio (Either String [a])

Takes: a query, a type ("Artist", "Album", "Track", "Playlist", or "User") This method can return any of those types, so you need to specify what you want returned. Example:

 search "Radiohead" "Artist" :: Rdio (Either String [Artist])

search' :: (Show a, FromJSON a) => String -> String -> Maybe Bool -> Maybe Int -> Maybe Int -> Rdio (Either String [a])

addToCollection :: [String] -> Rdio (Either String Object)

Takes: a list of keys of tracks or playlists. *Requires authentication*.

getAlbumsForArtistInCollection :: String -> Rdio (Either String [Album])

Takes: an artist key. Requires authentication OR use getAlbumsForArtistInCollection' and pass in a user key.

getAlbumsForArtistInCollection' :: String -> Maybe String -> [AlbumExtra] -> Maybe String -> Rdio (Either String [Album])

getAlbumsInCollection :: Rdio (Either String [Album])

Requires authentication OR use getAlbumsInCollection' and pass in a user key.

getAlbumsInCollection' :: Maybe String -> Maybe Int -> Maybe Int -> Maybe String -> Maybe String -> [AlbumExtra] -> Rdio (Either String [Album])

getArtistsInCollection :: Rdio (Either String [Artist])

Requires authentication OR use getArtistsInCollection' and pass in a user key.

getArtistsInCollection' :: Maybe String -> Maybe Int -> Maybe Int -> Maybe String -> Maybe String -> [ArtistExtra] -> Rdio (Either String [Artist])

getOfflineTracks :: Rdio (Either String [Track])

Requires authentication.

getOfflineTracks' :: Maybe Int -> Maybe Int -> [TrackExtra] -> Rdio (Either String [Track])

getTracksForAlbumInCollection :: String -> Rdio (Either String [Track])

Takes: an album key. Requires authentication OR use getTracksForAlbumInCollection' and pass in a user key.

getTracksForAlbumInCollection' :: String -> Maybe String -> [TrackExtra] -> Rdio (Either String [Track])

getTracksForArtistInCollection :: String -> Rdio (Either String [Track])

Takes: an artist key. Requires authentication OR use getTracksForArtistInCollection' and pass in a user key.

getTracksForArtistInCollection' :: String -> Maybe String -> [TrackExtra] -> Rdio (Either String [Track])

getTracksInCollection :: Rdio (Either String [Track])

Requires authentication OR use getTracksInCollection' and pass in a user key.

getTracksInCollection' :: Maybe String -> Maybe Int -> Maybe Int -> Maybe String -> Maybe String -> [TrackExtra] -> Rdio (Either String [Track])

removeFromCollection :: [String] -> Rdio (Either String Bool)

Takes: a list of track or playlist keys. Requires authentication.

setAvailableOffline :: [String] -> Bool -> Rdio (Either String Object)

Takes: a list of track or playlist keys. Requires authentication.

addToPlaylist :: String -> [String] -> [PlaylistExtra] -> Rdio (Either String Playlist)

Takes: a playlist key, a list of track keys to add to the playlist, [extras] (optional). Requires authentication.

createPlaylist :: String -> String -> [String] -> [PlaylistExtra] -> Rdio (Either String Playlist)

Takes: a name, a description, a list of track keys to start the playlist with, [extras] (optional). Requires authentication.

deletePlaylist :: String -> Rdio (Either String Bool)

Takes: a playlist key. Requires authentication.

getPlaylists :: Rdio (Either String UserPlaylists)

Requires authentication OR use getPlaylists' and pass in a user key.

getPlaylists' :: Maybe String -> [PlaylistExtra] -> Maybe Bool -> Rdio (Either String UserPlaylists)

getUserPlaylists :: String -> Rdio (Either String [Playlist])

Requires authentication OR use getUserPlaylists' and pass in a user key.

getUserPlaylists' :: String -> Maybe PlaylistType -> Maybe String -> Maybe Int -> Maybe Int -> [PlaylistExtra] -> Rdio (Either String [Playlist])

removeFromPlaylist :: String -> Int -> Int -> Int -> [PlaylistExtra] -> Rdio (Either String Playlist)

Takes: - a playlist key

• the index of the first item to remove
• number of tracks to remove
• the keys of the tracks to remove (redundancy to prevent accidental deletion)
• [extras] (optional)

Requires authentication.

setPlaylistCollaborating :: String -> Bool -> Rdio (Either String Bool)

Takes: a playlist key, a boolean (true == collaborating, false == not collaborating). Requires authentication.

setPlaylistCollaborationMode :: String -> CollaborationMode -> Rdio (Either String Bool)

Takes: a playlist key, a collaboration mode. Requires authentication.

setPlaylistFields :: String -> String -> String -> Rdio (Either String Bool)

Takes: a playlist key, a name, a description. Requires authentication.

setPlaylistOrder :: String -> [String] -> [PlaylistExtra] -> Rdio (Either String Playlist)

Takes: a playlist key, a list of track keys, [extras] (optional). Requires authentication.

addFriend :: String -> Rdio (Either String Bool)

Takes: a user key. Requires authentication.

currentUser :: [UserExtra] -> Rdio (Either String User)

Requires authentication.

findUserByEmail :: String -> [UserExtra] -> Rdio (Either String User)

Takes: an email address, [extras] (optional).

findUserByName :: String -> [UserExtra] -> Rdio (Either String User)

Takes: user name, [extras] (optional).

removeFriend :: String -> Rdio (Either String Bool)

Takes: a user key. Requires authentication.

userFollowers :: String -> Rdio (Either String [User])

Takes: a user key.

userFollowers' :: String -> Maybe Int -> Maybe Int -> [UserExtra] -> Maybe String -> Rdio (Either String [User])

userFollowing :: String -> Rdio (Either String [User])

Takes: a user key.

userFollowing' :: String -> Maybe Int -> Maybe Int -> [UserExtra] -> Maybe String -> Rdio (Either String [User])

getActivityStream :: String -> Scope -> Rdio (Either String Activity)

Takes: a user key, a scope.

getActivityStream' :: String -> Scope -> Maybe Int -> Maybe Int -> Rdio (Either String Activity)

getHeavyRotationArtists :: Rdio (Either String [Artist])

getHeavyRotationArtists' :: Maybe String -> Maybe Bool -> Maybe Int -> Maybe Int -> Maybe Int -> [ArtistExtra] -> Rdio (Either String [Artist])

getHeavyRotationAlbums :: Rdio (Either String [Album])

getHeavyRotationAlbums' :: Maybe String -> Maybe Bool -> Maybe Int -> Maybe Int -> Maybe Int -> [AlbumExtra] -> Rdio (Either String [Album])

getNewReleases :: Rdio (Either String [Album])

getNewReleases' :: Maybe Timeframe -> Maybe Int -> Maybe Int -> [AlbumExtra] -> Rdio (Either String [Album])

getTopChartArtists :: Rdio (Either String [Artist])

getTopChartArtists' :: Maybe Int -> Maybe Int -> [ArtistExtra] -> Rdio (Either String [Artist])

getTopChartAlbums :: Rdio (Either String [Album])

getTopChartAlbums' :: Maybe Int -> Maybe Int -> [AlbumExtra] -> Rdio (Either String [Album])

getTopChartTracks :: Rdio (Either String [Track])

getTopChartTracks' :: Maybe Int -> Maybe Int -> [TrackExtra] -> Rdio (Either String [Track])

getTopChartPlaylists :: Rdio (Either String [Playlist])

getTopChartPlaylists' :: Maybe Int -> Maybe Int -> [PlaylistExtra] -> Rdio (Either String [Playlist])

getPlaybackToken :: Maybe String -> Rdio (Either String String)

Takes: the domain that the playback SWF will be embedded in (optional).