uk.co.sevendigital.android.sdk.api.request.artist

Class SDIArtistSearchRequest

java.lang.Object

uk.co.sevendigital.android.sdk.api.request.abs.SDIAbsRequest<T>

uk.co.sevendigital.android.sdk.api.request.abs.SDIAbsJsonRequest<SDIArtistSearchRequest.Result>

uk.co.sevendigital.android.sdk.api.request.artist.SDIArtistSearchRequest

public final class SDIArtistSearchRequest
extends SDIAbsJsonRequest<SDIArtistSearchRequest.Result>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SDIArtistSearchRequest.Result
static class	SDIArtistSearchRequest.ResultCode

Nested classes/interfaces inherited from class uk.co.sevendigital.android.sdk.api.request.abs.SDIAbsJsonRequest

SDIAbsJsonRequest.JsonArtist, SDIAbsJsonRequest.JsonChart<T>, SDIAbsJsonRequest.JsonPrice, SDIAbsJsonRequest.JsonRelease, SDIAbsJsonRequest.JsonTrack

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PAGE_SIZE
static java.lang.String	DEFAULT_PERIOD
static int	MAX_PAGE_SIZE

Constructor Summary

Constructors

Constructor and Description
SDIArtistSearchRequest()

Method Summary

Modifier and Type	Method and Description
static SDIArtistSearchRequest.Result	execute(android.content.Context context, SDIServerUtil.OauthConsumer consumer, com.android.volley.RequestQueue queue, java.lang.String query) Get the current charts for tracks Note: The page property is one-indexed (hence the first page is 1, not zero).
static SDIArtistSearchRequest.Result	execute(android.content.Context context, SDIServerUtil.OauthConsumer consumer, com.android.volley.RequestQueue queue, java.lang.String query, int page) Get the current charts for tracks Note: The page property is one-indexed (hence the first page is 1, not zero).
static SDIArtistSearchRequest.Result	execute(android.content.Context context, SDIServerUtil.OauthConsumer consumer, com.android.volley.RequestQueue queue, java.lang.String query, 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).
static SDIArtistSearchRequest.Result	execute(android.content.Context context, SDIServerUtil.OauthConsumer consumer, com.android.volley.RequestQueue queue, 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) Get the current charts for tracks Note: The page property is one-indexed (hence the first page is 1, not zero).

Methods inherited from class uk.co.sevendigital.android.sdk.api.request.abs.SDIAbsRequest

addUserAgent

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PERIOD

public static final java.lang.String DEFAULT_PERIOD

See Also:

Constant Field Values

DEFAULT_PAGE_SIZE

public static final int DEFAULT_PAGE_SIZE

See Also:

Constant Field Values

MAX_PAGE_SIZE

public static final int MAX_PAGE_SIZE

See Also:

Constant Field Values

Constructor Detail

SDIArtistSearchRequest

public SDIArtistSearchRequest()

Method Detail

execute

public static SDIArtistSearchRequest.Result execute(android.content.Context context,
                                                    SDIServerUtil.OauthConsumer consumer,
                                                    com.android.volley.RequestQueue queue,
                                                    java.lang.String query)
                                             throws java.io.UnsupportedEncodingException,
                                                    java.util.concurrent.ExecutionException,
                                                    java.lang.InterruptedException,
                                                    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:

context - The application context.

queue - (Optional) The Volley request queue used to execute the network request.

query - The search query string.

Returns:

Return the result of the network retrieval.

Throws:

java.util.concurrent.ExecutionException

java.lang.InterruptedException

java.io.IOException

com.fasterxml.jackson.databind.JsonMappingException

com.fasterxml.jackson.core.JsonParseException

java.security.SignatureException

java.io.UnsupportedEncodingException

execute

public static SDIArtistSearchRequest.Result execute(android.content.Context context,
                                                    SDIServerUtil.OauthConsumer consumer,
                                                    com.android.volley.RequestQueue queue,
                                                    java.lang.String query,
                                                    int page)
                                             throws java.io.UnsupportedEncodingException,
                                                    java.util.concurrent.ExecutionException,
                                                    java.lang.InterruptedException,
                                                    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:

context - The application context.

queue - (Optional) The Volley request queue used to execute the network request.

query - The search query string.

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

Returns:

Return the result of the network retrieval.

Throws:

java.util.concurrent.ExecutionException

java.lang.InterruptedException

java.io.IOException

com.fasterxml.jackson.databind.JsonMappingException

com.fasterxml.jackson.core.JsonParseException

java.security.SignatureException

java.io.UnsupportedEncodingException

execute

public static SDIArtistSearchRequest.Result execute(android.content.Context context,
                                                    SDIServerUtil.OauthConsumer consumer,
                                                    com.android.volley.RequestQueue queue,
                                                    java.lang.String query,
                                                    int page,
                                                    int pageSize)
                                             throws java.io.IOException,
                                                    java.util.concurrent.ExecutionException,
                                                    java.lang.InterruptedException

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

Parameters:

context - The application context.

queue - (Optional) The Volley request queue used to execute the network request.

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:

Return the result of the network retrieval.

Throws:

java.util.concurrent.ExecutionException

java.lang.InterruptedException

java.io.IOException

com.fasterxml.jackson.databind.JsonMappingException

com.fasterxml.jackson.core.JsonParseException

java.security.SignatureException

execute

public static SDIArtistSearchRequest.Result execute(android.content.Context context,
                                                    SDIServerUtil.OauthConsumer consumer,
                                                    com.android.volley.RequestQueue queue,
                                                    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.io.UnsupportedEncodingException,
                                                    java.util.concurrent.ExecutionException,
                                                    java.lang.InterruptedException,
                                                    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:

context - The application context.

queue - (Optional) The Volley request queue used to execute the network request.

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:

Return the result of the network retrieval.

Throws:

java.util.concurrent.ExecutionException

java.lang.InterruptedException

java.io.IOException

com.fasterxml.jackson.databind.JsonMappingException

com.fasterxml.jackson.core.JsonParseException

java.security.SignatureException

java.io.UnsupportedEncodingException