uk.co.sevendigital.android.sdk.api

Class SDIApi.Artist

java.lang.Object

uk.co.sevendigital.android.sdk.api.SDIApi.Artist

Enclosing class:

SDIApi

public class SDIApi.Artist
extends java.lang.Object

The Artist api for accessing api methods relating to an artist

Constructor Summary

Constructors

Constructor and Description
Artist()

Method Summary

Modifier and Type	Method and Description
SDIGetArtistChartsRequest.Result	getCharts(int page) Get the current charts for tracks Note: The page property is one-indexed (hence the first page is 1, not zero).
SDIGetArtistChartsRequest.Result	getCharts(int page, int pageSize) Get the current charts for tracks Note: The page property is one-indexed (hence the first page is 1, not zero).
SDIGetArtistChartsRequest.Result	getCharts(int page, int pageSize, java.lang.String period, java.lang.String toDate) Get the current charts for tracks Note: The page property is one-indexed (hence the first page is 1, not zero).
SDIGetArtistDetailsRequest.Result	getDetails(java.lang.String artistId) Get the details for an artist
SDIGetArtistReleasesRequest.Result	getReleases(java.lang.String artistId) Get the releases (albums) for an artist
SDIGetArtistReleasesRequest.Result	getReleases(java.lang.String artistId, int page) Get the releases (albums) for an artist
SDIGetArtistReleasesRequest.Result	getReleases(java.lang.String artistId, int page, int pageSize) Get the releases (albums) for an artist
SDIGetArtistReleasesRequest.Result	getReleases(java.lang.String artistId, int page, int pageSize, java.lang.String type, java.lang.String streamable, java.lang.String licensorId, java.lang.String country, java.lang.Integer imageSize) Get the releases (albums) for an artist
SDIGetArtistTopTracksRequest.Result	getTopTracks(java.lang.String artistId) Get the top tracks for an artist
SDIGetArtistTopTracksRequest.Result	getTopTracks(java.lang.String artistId, int page) Get the top tracks for an artist
SDIGetArtistTopTracksRequest.Result	getTopTracks(java.lang.String artistId, int page, int pageSize) Get the top tracks for an artist
SDIGetArtistTopTracksRequest.Result	getTopTracks(java.lang.String artistId, int page, int pageSize, java.lang.Boolean streamable, java.lang.String licensorId, java.lang.String country, java.lang.Integer imageSize) Get the top tracks for an artist
SDIArtistSearchRequest.Result	search(java.lang.String query) Search the 7Digital catalogue for artists
SDIArtistSearchRequest.Result	search(java.lang.String query, int page) Search the 7Digital catalogue for artists
SDIArtistSearchRequest.Result	search(java.lang.String query, int page, int pageSize) Search the 7Digital catalogue for artists
SDIArtistSearchRequest.Result	search(java.lang.String query, int page, int pageSize, java.lang.String sort, java.lang.String streamable, java.lang.String licensorId, java.lang.String country, java.lang.Integer imageSize) Search the 7Digital catalogue for artists

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Artist

public Artist()

Method Detail

getTopTracks

public SDIGetArtistTopTracksRequest.Result getTopTracks(java.lang.String artistId)
                                                 throws java.lang.InterruptedException,
                                                        java.util.concurrent.ExecutionException,
                                                        java.io.IOException

Get the top tracks for an artist

Parameters:

artistId - - the id of the artist for which to get the top tracks

Returns:

SDIGetArtistTopTracksRequest.Result

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.io.IOException

getTopTracks

public SDIGetArtistTopTracksRequest.Result getTopTracks(java.lang.String artistId,
                                                        int page)
                                                 throws java.lang.InterruptedException,
                                                        java.util.concurrent.ExecutionException,
                                                        java.io.IOException

Get the top tracks for an artist

Parameters:

artistId - - the id of the artist for which to get the top tracks

page - Page number of the result set. If not supplied, defaults to 1

Returns:

SDIGetArtistTopTracksRequest.Result

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.io.IOException

getTopTracks

public SDIGetArtistTopTracksRequest.Result getTopTracks(java.lang.String artistId,
                                                        int page,
                                                        int pageSize)
                                                 throws java.lang.InterruptedException,
                                                        java.util.concurrent.ExecutionException,
                                                        java.io.IOException

Get the top tracks for an artist

Parameters:

artistId - - the id of the artist for which to get the top tracks

page - Page number of the result set. If not supplied, defaults to 1

pageSize - Number of items to be returned per page. If not supplied, defaults to 10. Maximum page size is 500

Returns:

SDIGetArtistTopTracksRequest.Result

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.io.IOException

getTopTracks

public SDIGetArtistTopTracksRequest.Result getTopTracks(java.lang.String artistId,
                                                        int page,
                                                        int pageSize,
                                                        java.lang.Boolean streamable,
                                                        java.lang.String licensorId,
                                                        java.lang.String country,
                                                        java.lang.Integer imageSize)
                                                 throws java.lang.InterruptedException,
                                                        java.util.concurrent.ExecutionException,
                                                        java.io.IOException

Get the top tracks for an artist

Parameters:

artistId - - the id of the artist for which to get the top tracks

page - Page number of the result set. If not supplied, defaults to 1

pageSize - Number of items to be returned per page. If not supplied, defaults to 10. Maximum page size is 500

streamable - If provided search results will contain only artists that can/cannot be streamed

licensorId - If provided search results will contain only artists from this licensor. A minus sign prefix excludes artists from that licensor (e.g. -5)

country - 2 letter ISO country code of the country whose artists you would like to search

page - Page number of the result set. If not supplied, defaults to 1

pageSize - Number of items to be returned per page. If not supplied, defaults to 10. Maximum page size is 500

Returns:

SDIGetArtistTopTracksRequest.Result

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.io.IOException

getReleases

public SDIGetArtistReleasesRequest.Result getReleases(java.lang.String artistId)
                                               throws java.lang.InterruptedException,
                                                      java.util.concurrent.ExecutionException,
                                                      java.io.IOException

Get the releases (albums) for an artist

Parameters:

artistId - the id of the artist for which to get the releases

Returns:

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.io.IOException

getReleases

public SDIGetArtistReleasesRequest.Result getReleases(java.lang.String artistId,
                                                      int page)
                                               throws java.lang.InterruptedException,
                                                      java.util.concurrent.ExecutionException,
                                                      java.io.IOException

Get the releases (albums) for an artist

Parameters:

artistId - the id of the artist for which to get the releases * @param context The application context.

page - Page number of the result set. If not supplied, defaults to 1

Returns:

Return the result of the network retrieval.

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.io.IOException

getReleases

public SDIGetArtistReleasesRequest.Result getReleases(java.lang.String artistId,
                                                      int page,
                                                      int pageSize)
                                               throws java.lang.InterruptedException,
                                                      java.util.concurrent.ExecutionException,
                                                      java.io.IOException

Get the releases (albums) for an artist

Parameters:

artistId - the id of the artist for which to get the releases * @param context The application context.

page - Page number of the result set. If not supplied, defaults to 1

pageSize - Number of items to be returned per page. If not supplied, defaults to 10. Maximum page size is 500

Returns:

Return the result of the network retrieval.

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.io.IOException

getReleases

public SDIGetArtistReleasesRequest.Result getReleases(java.lang.String artistId,
                                                      int page,
                                                      int pageSize,
                                                      java.lang.String type,
                                                      java.lang.String streamable,
                                                      java.lang.String licensorId,
                                                      java.lang.String country,
                                                      java.lang.Integer imageSize)
                                               throws java.lang.InterruptedException,
                                                      java.util.concurrent.ExecutionException,
                                                      java.io.IOException

Get the releases (albums) for an artist

Parameters:

artistId - the id of the artist for which to get the releases * @param context The application context.

type - Releases can be of type album, single or video. If specified, results are filtered by release type.

streamable - If provided search results will contain only artists that can/cannot be streamed

licensorId - If provided search results will contain only artists from this licensor. A minus sign prefix excludes artists from that licensor (e.g. -5)

country - 2 letter ISO country code of the country whose artists you would like to search

page - Page number of the result set. If not supplied, defaults to 1

pageSize - Number of items to be returned per page. If not supplied, defaults to 10. Maximum page size is 500

imageSize - The requested width of the image in pixels

Returns:

Return the result of the network retrieval.

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.io.IOException

search

public SDIArtistSearchRequest.Result search(java.lang.String query)
                                     throws java.lang.InterruptedException,
                                            java.util.concurrent.ExecutionException,
                                            java.io.IOException

Search the 7Digital catalogue for artists

Parameters:

query - The search query string.

Returns:

SDIArtistSearchRequest.Result

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.io.IOException

search

public SDIArtistSearchRequest.Result search(java.lang.String query,
                                            int page)
                                     throws java.lang.InterruptedException,
                                            java.util.concurrent.ExecutionException,
                                            java.io.IOException

Search the 7Digital catalogue for artists

Parameters:

query - The search query string.

page - Page number of the result set. If not supplied, defaults to 1

Returns:

SDIArtistSearchRequest.Result

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.io.IOException

search

public SDIArtistSearchRequest.Result search(java.lang.String query,
                                            int page,
                                            int pageSize)
                                     throws java.lang.InterruptedException,
                                            java.util.concurrent.ExecutionException,
                                            java.io.IOException

Search the 7Digital catalogue for artists

Parameters:

query - The search query string.

page - Page number of the result set. If not supplied, defaults to 1

pageSize - Number of items to be returned per page. If not supplied, defaults to 10. Maximum page size is 500

Returns:

SDIArtistSearchRequest.Result

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.io.IOException

search

public SDIArtistSearchRequest.Result search(java.lang.String query,
                                            int page,
                                            int pageSize,
                                            java.lang.String sort,
                                            java.lang.String streamable,
                                            java.lang.String licensorId,
                                            java.lang.String country,
                                            java.lang.Integer imageSize)
                                     throws java.lang.InterruptedException,
                                            java.util.concurrent.ExecutionException,
                                            java.io.IOException

Search the 7Digital catalogue for artists

Parameters:

query - The search query string.

sort - Orders the returned results. Supplied as a string in the format: "{sortColumn} {sortOrder}", for example: "popularity desc" will show most popular artists first regardless of search match score. Currently you can sort by name, popularity and score. If no sort is supplied, the default is "score desc". If no order is supplied the default is ascending.

streamable - If provided search results will contain only artists that can/cannot be streamed

licensorId - If provided search results will contain only artists from this licensor. A minus sign prefix excludes artists from that licensor (e.g. -5)

country - 2 letter ISO country code of the country whose artists you would like to search

page - Page number of the result set. If not supplied, defaults to 1

pageSize - Number of items to be returned per page. If not supplied, defaults to 10. Maximum page size is 500

imageSize - The requested width of the image in pixels

Returns:

SDIArtistSearchRequest.Result

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.io.IOException

getDetails

public SDIGetArtistDetailsRequest.Result getDetails(java.lang.String artistId)
                                             throws java.lang.Exception

Get the details for an artist

Parameters:

artistId - The id of the mArtist to retrieve details for

Returns:

Return the result of the network retrieval.

Throws:

java.lang.Exception

getCharts

public SDIGetArtistChartsRequest.Result getCharts(int page)
                                           throws java.lang.InterruptedException,
                                                  java.util.concurrent.ExecutionException,
                                                  java.security.SignatureException,
                                                  java.io.IOException

Get the current charts for tracks Note: The page property is one-indexed (hence the first page is 1, not zero).

Parameters:

page - The page to retrieve (note: one-indexed).

Returns:

Return the result of the network retrieval.

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.security.SignatureException

java.io.IOException

getCharts

public SDIGetArtistChartsRequest.Result getCharts(int page,
                                                  int pageSize)
                                           throws java.lang.InterruptedException,
                                                  java.util.concurrent.ExecutionException,
                                                  java.security.SignatureException,
                                                  java.io.IOException

Get the current charts for tracks Note: The page property is one-indexed (hence the first page is 1, not zero).

Parameters:

page - The page to retrieve (note: one-indexed).

pageSize - The size of the page to retrieve.

Returns:

Return the result of the network retrieval.

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.security.SignatureException

java.io.IOException

getCharts

public SDIGetArtistChartsRequest.Result getCharts(int page,
                                                  int pageSize,
                                                  java.lang.String period,
                                                  java.lang.String toDate)
                                           throws java.lang.InterruptedException,
                                                  java.util.concurrent.ExecutionException,
                                                  java.security.SignatureException,
                                                  java.io.IOException

Get the current charts for tracks Note: The page property is one-indexed (hence the first page is 1, not zero).

Parameters:

page - The page to retrieve (note: one-indexed).

pageSize - The size of the page to retrieve.

period - optional The time period for which the chart is generated. Default value is a week.

toDate - format is YYYYMMDD optional The last day the chart should include data for. If not provided, by default the most recent chart for requested period will be returned.

Returns:

Return the result of the network retrieval.

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.security.SignatureException

java.io.IOException