net.rithms.riot.api

Class RiotApiAsync

java.lang.Object

net.rithms.riot.api.RiotApiAsync

public class RiotApiAsync
extends java.lang.Object

This class is used to fire asynchronous requests. You can get an instance of this object by calling RiotApi.getAsyncApi() on your RiotApi object.

Due to the nature of asynchronous calls, methods in this class always return an AsyncRequest instead of the actual return type. To get the actual return value, call AsyncRequest.getDto(). For further information on handling asynchronous requests, see AsyncRequest.

See Also:

ApiConfig, AsyncRequest, RiotApi

Method Summary

Modifier and Type	Method and Description
void	addListeners(RequestListener... listeners) Adds one or more RequestListener to get informed when asynchronous requests finish.
void	awaitAll() Waits indefinitely until all currently running and queued requests complete.
AsyncRequest	callCustomApiMethod(ApiMethod method) Call a custom ApiMethod
AsyncRequest	createTournament(int providerId) Creates a tournament and returns its ID.
AsyncRequest	createTournament(java.lang.String tournamentName, int providerId) Creates a tournament and returns its ID.
AsyncRequest	createTournamentCodes(int tournamentId, int count, int teamSize, TournamentMap mapType, PickType pickType, SpectatorType spectatorType, long... allowedSummonerIds) Create tournament codes for the given tournament.
AsyncRequest	createTournamentCodes(int tournamentId, int count, int teamSize, TournamentMap mapType, PickType pickType, SpectatorType spectatorType, java.lang.String metaData, long... allowedSummonerIds) Create tournament codes for the given tournament.
AsyncRequest	createTournamentProvider(java.lang.String region, java.lang.String callbackUrl) Creates a tournament provider and returns its ID.
AsyncRequest	getActiveGameBySummoner(Platform platform, long summonerId) Get current game information for the given summoner ID.
AsyncRequest	getChallengerLeagueByQueue(Platform platform, LeagueQueue queue) Get the challenger league for a given queue.
AsyncRequest	getChallengerLeagueByQueue(Platform platform, java.lang.String queue) Get the challenger league for a given queue.
AsyncRequest	getChampion(Platform platform, int id) Retrieve champion by id.
AsyncRequest	getChampionMasteriesBySummoner(Platform platform, long summonerId) Get all champion mastery entries sorted by number of champion points descending
AsyncRequest	getChampionMasteriesBySummonerByChampion(Platform platform, long summonerId, int championId) Get a champion mastery by summonerId and championId.
AsyncRequest	getChampionMasteryScoresBySummoner(Platform platform, long summonerId) Get a player's total champion mastery score, which is sum of individual champion mastery levels
AsyncRequest	getChampions(Platform platform) Retrieve all champions.
AsyncRequest	getChampions(Platform platform, boolean freeToPlay) Retrieve all champions.
AsyncRequest	getDataChampion(Platform platform, int id) Retrieves a champion by id.
AsyncRequest	getDataChampion(Platform platform, int id, Locale locale, java.lang.String version, ChampionTags... tags) Retrieves a champion by id.
AsyncRequest	getDataChampionList(Platform platform) Retrieves champion list.
AsyncRequest	getDataChampionList(Platform platform, Locale locale, java.lang.String version, boolean dataById, ChampionListTags... tags) Retrieves champion list.
AsyncRequest	getDataItem(Platform platform, int id) Retrieves item by id.
AsyncRequest	getDataItem(Platform platform, int id, Locale locale, java.lang.String version, ItemTags... tags) Retrieves item by id.
AsyncRequest	getDataItemList(Platform platform) Retrieves item list.
AsyncRequest	getDataItemList(Platform platform, Locale locale, java.lang.String version, ItemListTags... tags) Retrieves item list.
AsyncRequest	getDataLanguages(Platform platform) Retrieve supported languages data.
AsyncRequest	getDataLanguageStrings(Platform platform) Retrieve language strings data.
AsyncRequest	getDataLanguageStrings(Platform platform, Locale locale, java.lang.String version) Retrieve language strings data.
AsyncRequest	getDataMaps(Platform platform) Retrieves map data.
AsyncRequest	getDataMaps(Platform platform, Locale locale, java.lang.String version) Retrieves map data.
AsyncRequest	getDataMastery(Platform platform, int id) Retrieves mastery item by id.
AsyncRequest	getDataMastery(Platform platform, int id, Locale locale, java.lang.String version, MasteryTags... tags) Retrieves mastery item by id.
AsyncRequest	getDataMasteryList(Platform platform) Retrieves mastery list.
AsyncRequest	getDataMasteryList(Platform platform, Locale locale, java.lang.String version, MasteryListTags... tags) Retrieves mastery list.
AsyncRequest	getDataProfileIcons(Platform platform) Retrieve profile icons.
AsyncRequest	getDataProfileIcons(Platform platform, Locale locale, java.lang.String version) Retrieve profile icons.
AsyncRequest	getDataRealm(Platform platform) Retrieve realm data.
AsyncRequest	getDataRune(Platform platform, int id) Retrieves rune by id.
AsyncRequest	getDataRune(Platform platform, int id, Locale locale, java.lang.String version, RuneTags... tags) Retrieves rune by id.
AsyncRequest	getDataRuneList(Platform platform) Retrieves rune list.
AsyncRequest	getDataRuneList(Platform platform, Locale locale, java.lang.String version, RuneListTags... tags) Retrieves rune list.
AsyncRequest	getDataSummonerSpell(Platform platform, int id) Retrieves summoner spell by id.
AsyncRequest	getDataSummonerSpell(Platform platform, int id, Locale locale, java.lang.String version, SpellTags... tags) Retrieves summoner spell by id.
AsyncRequest	getDataSummonerSpellList(Platform platform) Retrieves summoner spell list.
AsyncRequest	getDataSummonerSpellList(Platform platform, Locale locale, java.lang.String version, boolean dataById, SpellListTags... tags) Retrieves summoner spell list.
AsyncRequest	getDataVersions(Platform platform) Retrieve version data.
AsyncRequest	getFeaturedGames(Platform platform) Get list of featured games.
AsyncRequest	getLeaguePositionsBySummonerId(Platform platform, long summonerId) Get league positions in all queues for a given summonerId.
AsyncRequest	getLeaguesBySummonerId(Platform platform, long summonerId) Get leagues in all queues for a given summonerId.
AsyncRequest	getLobbyEventsByTournament(java.lang.String tournamentCode) Gets a list of lobby events by tournamentCode
AsyncRequest	getMasteriesBySummoner(Platform platform, long summonerId) Get mastery pages for a given summonerId.
AsyncRequest	getMasterLeagueByQueue(Platform platform, LeagueQueue queue) Get the master league for a given queue.
AsyncRequest	getMasterLeagueByQueue(Platform platform, java.lang.String queue) Get the master league for a given queue.
AsyncRequest	getMatch(Platform platform, long matchId) Get match by matchId.
AsyncRequest	getMatch(Platform platform, long matchId, long forAccountId) Get match by matchId.
AsyncRequest	getMatchByMatchIdAndTournamentCode(Platform platform, long matchId, java.lang.String tournamentCode) Retrieve match by matchId and tournamentCode.
AsyncRequest	getMatchIdsByTournamentCode(Platform platform, java.lang.String tournamentCode) Retrieve match IDs by tournamentCode.
AsyncRequest	getMatchListByAccountId(Platform platform, long accountId) Get matchlist for given account ID and platform ID.
AsyncRequest	getMatchListByAccountId(Platform platform, long accountId, java.util.Set<java.lang.Integer> champion, java.util.Set<java.lang.Integer> queue, java.util.Set<java.lang.Integer> season) Get matchlist for given account ID and platform ID.
AsyncRequest	getMatchListByAccountId(Platform platform, long accountId, java.util.Set<java.lang.Integer> champion, java.util.Set<java.lang.Integer> queue, java.util.Set<java.lang.Integer> season, long beginTime, long endTime, int beginIndex, int endIndex) Get matchlist for given account ID and platform ID.
int	getPoolSize() Returns the number of elements in the asynchronous request pool.
int	getQueueSize() Returns the number of elements in the asynchronous request queue.
AsyncRequest	getRecentMatchListByAccountId(Platform platform, long accountId) Deprecated.
AsyncRequest	getRunesBySummoner(Platform platform, long summonerId) Get rune pages for a given summonerId.
AsyncRequest	getShardData(Platform platform) Get shard status.
AsyncRequest	getSummoner(Platform platform, long summonerId) Get a summoner object for a given summonerId.
AsyncRequest	getSummonerByAccount(Platform platform, long accountId) Get a summoner object for a given accountId.
AsyncRequest	getSummonerByName(Platform platform, java.lang.String summonerName) Get a single summoner object for a given summonerName.
AsyncRequest	getTimelineByMatchId(Platform platform, long matchId) Get match timeline by matchId.
AsyncRequest	getTournamentCode(java.lang.String tournamentCode) Returns the tournament code DTO associated with a tournamentCode.
void	removeListeners(RequestListener... listeners) Removes one or more RequestListener from getting informed when asynchronous requests finish.
void	updateTournamentCode(java.lang.String tournamentCode, TournamentMap mapType, PickType pickType, SpectatorType spectatorType, long... allowedSummonerIds) Update the pick type, map, spectator type, or allowed summoners for a code.

Methods inherited from class java.lang.Object

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

Method Detail

addListeners

public void addListeners(RequestListener... listeners)

Adds one or more RequestListener to get informed when asynchronous requests finish.

Please note, that by adding listeners here, you will listen to ALL asynchronous requests made with this RiotApiAsync object. To only listen to a specific asynchronous request, you can set listeners directly in the AsyncRequest using AsyncRequest.addListeners(RequestListener...).

Parameters:

listeners - One or more objects that implement RequestListener

See Also:

RequestListener

awaitAll

public void awaitAll()
              throws java.lang.InterruptedException

Waits indefinitely until all currently running and queued requests complete.

If the thread is interrupted while waiting for the requests to complete, this method will throw an InterruptedException and the thread's interrupt flag will be cleared.

Please note that this method is blocking and thus negates the advantage of the asynchronous nature of this class. Consider using a RequestListener instead.

Throws:

java.lang.InterruptedException - If the method is interrupted by calling Thread.interrupt(). The interrupt flag will be cleared

callCustomApiMethod

public AsyncRequest callCustomApiMethod(ApiMethod method)
                                 throws RiotApiException

Call a custom ApiMethod

Parameters:

method - Custom ApiMethod object

Returns:

Result Dto (if any)

Throws:

java.lang.NullPointerException - If method is null

RiotApiException - If the API returns an error or unparsable result

createTournament

public AsyncRequest createTournament(java.lang.String tournamentName,
                                     int providerId)

Creates a tournament and returns its ID.

Parameters:

tournamentName - The optional name of the tournament.

providerId - The provider ID to specify the regional registered provider data to associate this tournament.

Returns:

A tournament ID

createTournament

public AsyncRequest createTournament(int providerId)

Creates a tournament and returns its ID.

Parameters:

providerId - The provider ID to specify the regional registered provider data to associate this tournament.

Returns:

A tournament Id

createTournamentCodes

public AsyncRequest createTournamentCodes(int tournamentId,
                                          int count,
                                          int teamSize,
                                          TournamentMap mapType,
                                          PickType pickType,
                                          SpectatorType spectatorType,
                                          java.lang.String metaData,
                                          long... allowedSummonerIds)

Create tournament codes for the given tournament.

Parameters:

tournamentId - The tournament ID

count - The number of codes to create (max 1000)

teamSize - The team size of the game. Valid values are 1-5.

mapType - The map type of the game.

pickType - The pick type of the game.

spectatorType - The spectator type of the game.

metaData - Optional string that may contain any data in any format, if specified at all. Used to denote any custom information about the game.

allowedSummonerIds - Optional list of participants in order to validate the players eligible to join the lobby.

Returns:

A list of tournament codes

Throws:

java.lang.NullPointerException - If mapType or pickType or spectatorType is null

createTournamentCodes

public AsyncRequest createTournamentCodes(int tournamentId,
                                          int count,
                                          int teamSize,
                                          TournamentMap mapType,
                                          PickType pickType,
                                          SpectatorType spectatorType,
                                          long... allowedSummonerIds)

Create tournament codes for the given tournament.

Parameters:

tournamentId - The tournament ID

count - The number of codes to create (max 1000)

teamSize - The team size of the game. Valid values are 1-5.

mapType - The map type of the game.

pickType - The pick type of the game.

spectatorType - The spectator type of the game.

allowedSummonerIds - Optional list of participants in order to validate the players eligible to join the lobby.

Returns:

A list of tournament codes

createTournamentProvider

public AsyncRequest createTournamentProvider(java.lang.String region,
                                             java.lang.String callbackUrl)

Creates a tournament provider and returns its ID.

Parameters:

region - The region in which the provider will be running tournaments.

callbackUrl - The provider's callback URL to which tournament game results in this region should be posted. (http URLs must use port 80, https URLs must use port 443).

Returns:

A provider ID

Throws:

java.lang.NullPointerException - If region or callbackUrl is null

getActiveGameBySummoner

public AsyncRequest getActiveGameBySummoner(Platform platform,
                                            long summonerId)

Get current game information for the given summoner ID.

Parameters:

platform - Platform to execute the method call against.

summonerId - The ID of the summoner.

Returns:

Current game info

Throws:

java.lang.NullPointerException - If platform or summonerId is null

See Also:

CurrentGameInfo

getChallengerLeagueByQueue

public AsyncRequest getChallengerLeagueByQueue(Platform platform,
                                               java.lang.String queue)

Get the challenger league for a given queue.

Parameters:

platform - Platform to execute the method call against.

queue - Game queue type.

Returns:

A league list

Throws:

java.lang.NullPointerException - If platform or queue is null

See Also:

LeagueList

getChallengerLeagueByQueue

public AsyncRequest getChallengerLeagueByQueue(Platform platform,
                                               LeagueQueue queue)

Get the challenger league for a given queue.

Parameters:

platform - Platform to execute the method call against.

queue - Game queue type.

Returns:

A league list

Throws:

java.lang.NullPointerException - If queue is null

See Also:

LeagueList

getChampion

public AsyncRequest getChampion(Platform platform,
                                int id)

Retrieve champion by id.

Parameters:

platform - Platform to execute the method call against.

id - The ID of the desired champion

Returns:

The champion of the given ID

Throws:

java.lang.NullPointerException - If platform is null

See Also:

Champion

getChampionMasteriesBySummoner

public AsyncRequest getChampionMasteriesBySummoner(Platform platform,
                                                   long summonerId)

Get all champion mastery entries sorted by number of champion points descending

Parameters:

platform - Platform to execute the method call against.

summonerId - Summoner ID associated with the player

Returns:

A list of champion masteries for a given summoner.

Throws:

java.lang.NullPointerException - If platform is null

See Also:

ChampionMastery

getChampionMasteriesBySummonerByChampion

public AsyncRequest getChampionMasteriesBySummonerByChampion(Platform platform,
                                                             long summonerId,
                                                             int championId)

Get a champion mastery by summonerId and championId.

Parameters:

platform - Platform to execute the method call against.

summonerId - Summoner ID associated with the player

championId - Champion ID to retrieve Champion Mastery for

Returns:

Champion mastery for a given summoner and championId, or null if given player has no mastery for given champion.

Throws:

java.lang.NullPointerException - If platform is null

See Also:

ChampionMastery

getChampionMasteryScoresBySummoner

public AsyncRequest getChampionMasteryScoresBySummoner(Platform platform,
                                                       long summonerId)

Get a player's total champion mastery score, which is sum of individual champion mastery levels

Parameters:

platform - Platform to execute the method call against.

summonerId - Summoner ID associated with the player

Returns:

The total champion mastery score of a given summoner.

Throws:

java.lang.NullPointerException - If platform is null

getChampions

public AsyncRequest getChampions(Platform platform,
                                 boolean freeToPlay)

Retrieve all champions.

Parameters:

platform - Platform to execute the method call against.

freeToPlay - Optional filter param to retrieve only free to play champions.

Returns:

This object contains a collection of champion information.

Throws:

java.lang.NullPointerException - If platform is null

See Also:

ChampionList

getChampions

public AsyncRequest getChampions(Platform platform)

Retrieve all champions.

Parameters:

platform - Platform to execute the method call against.

Returns:

This object contains a collection of champion information.

See Also:

ChampionList

getDataChampion

public AsyncRequest getDataChampion(Platform platform,
                                    int id,
                                    Locale locale,
                                    java.lang.String version,
                                    ChampionTags... tags)

Retrieves a champion by id.

Not all data is returned by default. See the tags parameter for more information.

Parameters:

platform - Platform to execute the method call against.

id - Champion ID

locale - Locale code for returned data (e.g., en_US, es_ES). If not specified, the default locale for the region is used.

version - Data dragon version for returned data. If not specified, the latest version for the region is used. List of valid versions can be obtained from the #getDataVersions() method.

tags - Tags to return additional data. Only id, key, name, and title are returned by default if this parameter isn't specified. To return all additional data, use ChampionTags.ALL.

Returns:

A single champion

Throws:

java.lang.NullPointerException - If platform is null

See Also:

Champion

getDataChampion

public AsyncRequest getDataChampion(Platform platform,
                                    int id)

Retrieves a champion by id.

Not all data is returned by default. See the tags parameter for more information.

Parameters:

platform - Platform to execute the method call against.

id - Champion ID

Returns:

A single champion

See Also:

Champion

getDataChampionList

public AsyncRequest getDataChampionList(Platform platform,
                                        Locale locale,
                                        java.lang.String version,
                                        boolean dataById,
                                        ChampionListTags... tags)

Retrieves champion list.

Not all data is returned by default. See the tags parameter for more information.

Parameters:

platform - Platform to execute the method call against.

locale - Locale code for returned data (e.g., en_US, es_ES). If not specified, the default locale for the region is used.

version - Data dragon version for returned data. If not specified, the latest version for the region is used. List of valid versions can be obtained from the #getDataVersions() method.

dataById - If specified as true, the returned data map will use the champions' IDs as the keys. If specified as false, the returned data map will use the champions' keys instead.

tags - Tags to return additional data. Only id, key, name, and title are returned by default if this parameter isn't specified. To return all additional data, use ChampionListTags.ALL.

Returns:

A list with champions

Throws:

java.lang.NullPointerException - If platform is null

See Also:

ChampionList

getDataChampionList

public AsyncRequest getDataChampionList(Platform platform)

Retrieves champion list.

Not all data is returned by default. See the tags parameter for more information.

Parameters:

platform - Platform to execute the method call against.

Returns:

A list with champions

See Also:

ChampionList

getDataItem

public AsyncRequest getDataItem(Platform platform,
                                int id,
                                Locale locale,
                                java.lang.String version,
                                ItemTags... tags)

Retrieves item by id.

Not all data is returned by default. See the tags parameter for more information.

Parameters:

platform - Platform to execute the method call against.

id - Item ID

locale - Locale code for returned data (e.g., en_US, es_ES). If not specified, the default locale for the region is used.

version - Data dragon version for returned data. If not specified, the latest version for the region is used. List of valid versions can be obtained from the #getDataVersions() method.

tags - Tags to return additional data. Only type, version, basic, data, id, name, plaintext, group, and description are returned by default if this parameter isn't specified. To return all additional data, use ItemTags.ALL.

Returns:

A single item

Throws:

java.lang.NullPointerException - If platform is null

See Also:

Item

getDataItem

public AsyncRequest getDataItem(Platform platform,
                                int id)

Retrieves item by id.

Not all data is returned by default. See the tags parameter for more information.

Parameters:

platform - Platform to execute the method call against.

id - Item ID

Returns:

A single item

See Also:

Item

getDataItemList

public AsyncRequest getDataItemList(Platform platform,
                                    Locale locale,
                                    java.lang.String version,
                                    ItemListTags... tags)

Retrieves item list.

Not all data is returned by default. See the tags parameter for more information.

Parameters:

platform - Platform to execute the method call against.

locale - Locale code for returned data (e.g., en_US, es_ES). If not specified, the default locale for the region is used.

version - Data dragon version for returned data. If not specified, the latest version for the region is used. List of valid versions can be obtained from the #getDataVersions() method.

tags - Tags to return additional data. Only type, version, basic, data, id, name, plaintext, group, and description are returned by default if this parameter isn't specified. To return all additional data, use ItemListTags.ALL.

Returns:

A list of items

Throws:

java.lang.NullPointerException - If platform is null

See Also:

ItemList

getDataItemList

public AsyncRequest getDataItemList(Platform platform)

Retrieves item list.

Not all data is returned by default. See the tags parameter for more information.

Parameters:

platform - Platform to execute the method call against.

Returns:

A list of items

See Also:

ItemList

getDataLanguages

public AsyncRequest getDataLanguages(Platform platform)

Retrieve supported languages data.

Parameters:

platform - Platform to execute the method call against.

Returns:

A list with languages

Throws:

java.lang.NullPointerException - If platform is null

getDataLanguageStrings

public AsyncRequest getDataLanguageStrings(Platform platform,
                                           Locale locale,
                                           java.lang.String version)

Retrieve language strings data.

Parameters:

platform - Platform to execute the method call against.

locale - Locale code for returned data (e.g., en_US, es_ES). If not specified, the default locale for the region is used.

version - Data dragon version for returned data. If not specified, the latest version for the region is used. List of valid versions can be obtained from the #getDataVersions() method.

Returns:

Language strings

Throws:

java.lang.NullPointerException - If platform is null

See Also:

LanguageStrings

getDataLanguageStrings

public AsyncRequest getDataLanguageStrings(Platform platform)

Retrieve language strings data.

Parameters:

platform - Platform to execute the method call against.

Returns:

Language strings

See Also:

LanguageStrings

getDataMaps

public AsyncRequest getDataMaps(Platform platform,
                                Locale locale,
                                java.lang.String version)

Retrieves map data.

Parameters:

platform - Platform to execute the method call against.

locale - Locale code for returned data (e.g., en_US, es_ES). If not specified, the default locale for the region is used.

version - Data dragon version for returned data. If not specified, the latest version for the region is used. List of valid versions can be obtained from the #getDataVersions() method.

Returns:

A list of game maps

Throws:

java.lang.NullPointerException - If platform is null

See Also:

MapData

getDataMaps

public AsyncRequest getDataMaps(Platform platform)

Retrieves map data.

Parameters:

platform - Platform to execute the method call against.

Returns:

A list of game maps

See Also:

MapData

getDataMastery

public AsyncRequest getDataMastery(Platform platform,
                                   int id,
                                   Locale locale,
                                   java.lang.String version,
                                   MasteryTags... tags)

Retrieves mastery item by id.

Not all data is returned by default. See the tags parameter for more information.

Parameters:

platform - Platform to execute the method call against.

id - Mastery ID

locale - Locale code for returned data (e.g., en_US, es_ES). If not specified, the default locale for the region is used.

version - Data dragon version for returned data. If not specified, the latest version for the region is used. List of valid versions can be obtained from the #getDataVersions() method.

tags - Tags to return additional data. Only id, name, and description are returned by default if this parameter isn't specified. To return all additional data, use MasteryTags.ALL.

Returns:

A single mastery

Throws:

java.lang.NullPointerException - If platform is null

See Also:

Mastery

getDataMastery

public AsyncRequest getDataMastery(Platform platform,
                                   int id)

Retrieves mastery item by id.

Not all data is returned by default. See the tags parameter for more information.

Parameters:

platform - Platform to execute the method call against.

id - Mastery ID

Returns:

A single mastery

See Also:

Mastery

getDataMasteryList

public AsyncRequest getDataMasteryList(Platform platform,
                                       Locale locale,
                                       java.lang.String version,
                                       MasteryListTags... tags)

Retrieves mastery list.

Not all data is returned by default. See the tags parameter for more information.

Parameters:

platform - Platform to execute the method call against.

locale - Locale code for returned data (e.g., en_US, es_ES). If not specified, the default locale for the region is used.

version - Data dragon version for returned data. If not specified, the latest version for the region is used. List of valid versions can be obtained from the #getDataVersions() method.

tags - Tags to return additional data. Only type, version, data, id, name, and description are returned by default if this parameter isn't specified. To return all additional data, use MasteryListTags.ALL.

Returns:

A list with masteries

Throws:

java.lang.NullPointerException - If platform is null

See Also:

MasteryList

getDataMasteryList

public AsyncRequest getDataMasteryList(Platform platform)

Retrieves mastery list.

Not all data is returned by default. See the tags parameter for more information.

Parameters:

platform - Platform to execute the method call against.

Returns:

A list with masteries

See Also:

MasteryList

getDataProfileIcons

public AsyncRequest getDataProfileIcons(Platform platform,
                                        Locale locale,
                                        java.lang.String version)

Retrieve profile icons.

Parameters:

platform - Platform to execute the method call against.

locale - Locale code for returned data (e.g., en_US, es_ES). If not specified, the default locale for the region is used.

version - Data dragon version for returned data. If not specified, the latest version for the region is used. List of valid versions can be obtained from the #getDataVersions() method.

Returns:

Profile icons

Throws:

java.lang.NullPointerException - If platform is null

See Also:

ProfileIconData

getDataProfileIcons

public AsyncRequest getDataProfileIcons(Platform platform)

Retrieve profile icons.

Parameters:

platform - Platform to execute the method call against.

Returns:

Profile icons

See Also:

ProfileIconData

getDataRealm

public AsyncRequest getDataRealm(Platform platform)

Retrieve realm data.

Parameters:

platform - Platform to execute the method call against.

Returns:

A single realm

Throws:

java.lang.NullPointerException - If platform is null

See Also:

Realm

getDataRune

public AsyncRequest getDataRune(Platform platform,
                                int id,
                                Locale locale,
                                java.lang.String version,
                                RuneTags... tags)

Retrieves rune by id.

Not all data is returned by default. See the tags parameter for more information.

Parameters:

platform - Platform to execute the method call against.

id - Rune ID

locale - Locale code for returned data (e.g., en_US, es_ES). If not specified, the default locale for the region is used.

version - Data dragon version for returned data. If not specified, the latest version for the region is used. List of valid versions can be obtained from the #getDataVersions() method.

tags - Tags to return additional data. Only id, name, rune, and description are returned by default if this parameter isn't specified. To return all additional data, use RuneTags.ALL.

Returns:

A single rune

Throws:

java.lang.NullPointerException - If platform is null

See Also:

Rune

getDataRune

public AsyncRequest getDataRune(Platform platform,
                                int id)

Retrieves rune by id.

Not all data is returned by default. See the tags parameter for more information.

Parameters:

platform - Platform to execute the method call against.

id - Rune ID

Returns:

A single rune

See Also:

Rune

getDataRuneList

public AsyncRequest getDataRuneList(Platform platform,
                                    Locale locale,
                                    java.lang.String version,
                                    RuneListTags... tags)

Retrieves rune list.

Not all data is returned by default. See the tags parameter for more information.

Parameters:

platform - Platform to execute the method call against.

locale - Locale code for returned data (e.g., en_US, es_ES). If not specified, the default locale for the region is used.

version - Data dragon version for returned data. If not specified, the latest version for the region is used. List of valid versions can be obtained from the #getDataVersions() method.

tags - Tags to return additional data. Only type, version, data, id, name, rune, and description are returned by default if this parameter isn't specified. To return all additional data, use RuneListTags.ALL.

Returns:

A list with runes

Throws:

java.lang.NullPointerException - If platform is null

See Also:

RuneList

getDataRuneList

public AsyncRequest getDataRuneList(Platform platform)

Retrieves rune list.

Not all data is returned by default. See the tags parameter for more information.

Parameters:

platform - Platform to execute the method call against.

Returns:

A list with runes

See Also:

RuneList

getDataSummonerSpell

public AsyncRequest getDataSummonerSpell(Platform platform,
                                         int id,
                                         Locale locale,
                                         java.lang.String version,
                                         SpellTags... tags)

Retrieves summoner spell by id.

Not all data is returned by default. See the tags parameter for more information.

Parameters:

platform - Platform to execute the method call against.

id - Summoner spell ID

locale - Locale code for returned data (e.g., en_US, es_ES). If not specified, the default locale for the region is used.

version - Data dragon version for returned data. If not specified, the latest version for the region is used. List of valid versions can be obtained from the #getDataVersions() method.

tags - Tags to return additional data. Only id, key, name, description, and summonerLevel are returned by default if this parameter isn't specified. To return all additional data, use SpellTags.ALL.

Returns:

A single summoner spell

Throws:

java.lang.NullPointerException - If platform is null

See Also:

SummonerSpell

getDataSummonerSpell

public AsyncRequest getDataSummonerSpell(Platform platform,
                                         int id)

Retrieves summoner spell by id.

Not all data is returned by default. See the tags parameter for more information.

Parameters:

platform - Platform to execute the method call against.

id - Summoner spell ID

Returns:

A single summoner spell

See Also:

SummonerSpell

getDataSummonerSpellList

public AsyncRequest getDataSummonerSpellList(Platform platform,
                                             Locale locale,
                                             java.lang.String version,
                                             boolean dataById,
                                             SpellListTags... tags)

Retrieves summoner spell list.

Not all data is returned by default. See the tags parameter for more information.

Parameters:

platform - Platform to execute the method call against.

locale - Locale code for returned data (e.g., en_US, es_ES). If not specified, the default locale for the region is used.

version - Data dragon version for returned data. If not specified, the latest version for the region is used. List of valid versions can be obtained from the #getDataVersions() method.

dataById - If specified as true, the returned data map will use the spells' IDs as the keys. If specified as false, the returned data map will use the spells' keys instead

tags - Tags to return additional data. Only type, version, data, id, key, name, description, and summonerLevel are returned by default if this parameter isn't specified. To return all additional data, use SpellListTags.ALL.

Returns:

A list with summoner spells

Throws:

java.lang.NullPointerException - If platform is null

See Also:

SummonerSpellList

getDataSummonerSpellList

public AsyncRequest getDataSummonerSpellList(Platform platform)

Retrieves summoner spell list.

Not all data is returned by default. See the tags parameter for more information.

Parameters:

platform - Platform to execute the method call against.

Returns:

A list with summoner spells

See Also:

SummonerSpellList

getDataVersions

public AsyncRequest getDataVersions(Platform platform)

Retrieve version data.

Parameters:

platform - Platform to execute the method call against.

Returns:

A list with versions

Throws:

java.lang.NullPointerException - If platform is null

getFeaturedGames

public AsyncRequest getFeaturedGames(Platform platform)

Get list of featured games.

Parameters:

platform - Platform to execute the method call against.

Returns:

Featured games

Throws:

java.lang.NullPointerException - If platform is null

See Also:

FeaturedGames

getLeaguePositionsBySummonerId

public AsyncRequest getLeaguePositionsBySummonerId(Platform platform,
                                                   long summonerId)

Get league positions in all queues for a given summonerId.

Parameters:

platform - Platform to execute the method call against.

summonerId - Summoner ID

Returns:

List of league positions

Throws:

java.lang.NullPointerException - If platform is null

See Also:

LeagueList

getLeaguesBySummonerId

public AsyncRequest getLeaguesBySummonerId(Platform platform,
                                           long summonerId)

Get leagues in all queues for a given summonerId.

Parameters:

platform - Platform to execute the method call against.

summonerId - Summoner ID

Returns:

List of league lists

Throws:

java.lang.NullPointerException - If platform is null

See Also:

LeagueList

getLobbyEventsByTournament

public AsyncRequest getLobbyEventsByTournament(java.lang.String tournamentCode)

Gets a list of lobby events by tournamentCode

Parameters:

tournamentCode - Tournament code used to enter the lobby.

Returns:

Lobby event data

Throws:

java.lang.NullPointerException - If tournamentCode is null

See Also:

LobbyEventWrapper

getMasterLeagueByQueue

public AsyncRequest getMasterLeagueByQueue(Platform platform,
                                           java.lang.String queue)

Get the master league for a given queue.

Parameters:

platform - Platform to execute the method call against.

queueType - Game queue type.

Returns:

A league list

Throws:

java.lang.NullPointerException - If platform or queue is null

See Also:

LeagueList

getMasterLeagueByQueue

public AsyncRequest getMasterLeagueByQueue(Platform platform,
                                           LeagueQueue queue)

Get the master league for a given queue.

Parameters:

platform - Platform to execute the method call against.

queue - Game queue type.

Returns:

A league list

Throws:

java.lang.NullPointerException - If queue is null

See Also:

LeagueList

getMasteriesBySummoner

public AsyncRequest getMasteriesBySummoner(Platform platform,
                                           long summonerId)

Get mastery pages for a given summonerId.

Parameters:

platform - Platform to execute the method call against.

summonerId - Summoner ID associated with masteries to retrieve.

Returns:

Mastery pages of the given summoners

Throws:

java.lang.NullPointerException - If platform is null

See Also:

MasteryPages

getMatch

public AsyncRequest getMatch(Platform platform,
                             long matchId,
                             long forAccountId)

Get match by matchId.

Parameters:

platform - Platform to execute the method call against.

matchId - The ID of the match.

forAccountId - If provided, used to identify the participant to be unobfuscated.

Returns:

A map with match details

Throws:

java.lang.NullPointerException - If platform is null

See Also:

Match

getMatch

public AsyncRequest getMatch(Platform platform,
                             long matchId)

Get match by matchId.

Parameters:

platform - Platform to execute the method call against.

matchId - The ID of the match.

Returns:

A map with match details

See Also:

Match

getMatchIdsByTournamentCode

public AsyncRequest getMatchIdsByTournamentCode(Platform platform,
                                                java.lang.String tournamentCode)

Retrieve match IDs by tournamentCode.

Parameters:

platform - Platform to execute the method call against.

tournamentCode - The code of the tournament.

Returns:

A list of match IDs

Throws:

java.lang.NullPointerException - If platform or tournamentCode is null

getMatchByMatchIdAndTournamentCode

public AsyncRequest getMatchByMatchIdAndTournamentCode(Platform platform,
                                                       long matchId,
                                                       java.lang.String tournamentCode)

Retrieve match by matchId and tournamentCode.

Parameters:

platform - Platform to execute the method call against.

matchId - The ID of the match.

tournamentCode - The code of the tournament.

Returns:

A map with match details

Throws:

java.lang.NullPointerException - If platform or tournamentCode is null

See Also:

Match

getMatchListByAccountId

public AsyncRequest getMatchListByAccountId(Platform platform,
                                            long accountId,
                                            java.util.Set<java.lang.Integer> champion,
                                            java.util.Set<java.lang.Integer> queue,
                                            java.util.Set<java.lang.Integer> season,
                                            long beginTime,
                                            long endTime,
                                            int beginIndex,
                                            int endIndex)

Get matchlist for given account ID and platform ID.

Parameters:

platform - Platform to execute the method call against.

accountId - The account ID of the summoner.

champion - Set of champion IDs for which to filtering matchlist.

queue - Set of queue IDs for which to filtering matchlist.

season - Set of season IDs for which to filtering matchlist.

beginTime - The begin time to use for filtering matchlist specified as epoch milliseconds. Use -1 to not use this parameter.

endTime - The end time to use for filtering matchlist specified as epoch milliseconds. Use -1 to not use this parameter.

beginIndex - The begin index to use for filtering matchlist. Use -1 to not use this parameter.

endIndex - The end index to use for filtering matchlist. Use -1 to not use this parameter.

Returns:

A list with matches

Throws:

java.lang.NullPointerException - If platform is null

See Also:

MatchList

getMatchListByAccountId

public AsyncRequest getMatchListByAccountId(Platform platform,
                                            long accountId,
                                            java.util.Set<java.lang.Integer> champion,
                                            java.util.Set<java.lang.Integer> queue,
                                            java.util.Set<java.lang.Integer> season)

Get matchlist for given account ID and platform ID.

Parameters:

platform - Platform to execute the method call against.

accountId - The account ID of the summoner.

champion - Set of champion IDs for which to filtering matchlist.

queue - Set of queue IDs for which to filtering matchlist.

season - Set of season IDs for which to filtering matchlist.

Returns:

A list with matches

See Also:

MatchList

getMatchListByAccountId

public AsyncRequest getMatchListByAccountId(Platform platform,
                                            long accountId)

Get matchlist for given account ID and platform ID.

Parameters:

platform - Platform to execute the method call against.

accountId - The account ID of the summoner.

Returns:

A list with matches

See Also:

MatchList

getPoolSize

public int getPoolSize()

Returns the number of elements in the asynchronous request pool.

Returns:

Number of elements in the asynchronous request pool

getQueueSize

public int getQueueSize()

Returns the number of elements in the asynchronous request queue.

Returns:

Number of elements in the asynchronous request queue

getRecentMatchListByAccountId

@Deprecated
public AsyncRequest getRecentMatchListByAccountId(Platform platform,
                                                               long accountId)

Deprecated.

Get recent matchlist for given account ID and platform ID.

Parameters:

platform - Platform to execute the method call against.

accountId - The account ID of the summoner.

Returns:

A list with matches

Throws:

java.lang.NullPointerException - If platform is null

See Also:

MatchList

getRunesBySummoner

public AsyncRequest getRunesBySummoner(Platform platform,
                                       long summonerId)

Get rune pages for a given summonerId.

Parameters:

platform - Platform to execute the method call against.

summonerId - Summoner ID associated with runes to retrieve.

Returns:

Rune pages of the given summoners

Throws:

java.lang.NullPointerException - If platform is null

See Also:

RunePages

getShardData

public AsyncRequest getShardData(Platform platform)

Get shard status. Returns the data available on the status.leagueoflegends.com website for the given region.

Parameters:

platform - Platform to execute the method call against.

Returns:

Status for a single shard

Throws:

java.lang.NullPointerException - If platform is null

See Also:

ShardStatus

getSummonerByAccount

public AsyncRequest getSummonerByAccount(Platform platform,
                                         long accountId)

Get a summoner object for a given accountId.

Parameters:

platform - Platform to execute the method call against.

summonerId - Account ID associated with summoner to retrieve.

Returns:

The desired summoner

Throws:

java.lang.NullPointerException - If platform is null

See Also:

Summoner

getSummoner

public AsyncRequest getSummoner(Platform platform,
                                long summonerId)

Get a summoner object for a given summonerId.

Parameters:

platform - Platform to execute the method call against.

summonerId - Summoner ID associated with summoner to retrieve.

Returns:

The desired summoner

Throws:

java.lang.NullPointerException - If platform is null

See Also:

Summoner

getSummonerByName

public AsyncRequest getSummonerByName(Platform platform,
                                      java.lang.String summonerName)

Get a single summoner object for a given summonerName.

Parameters:

platform - Platform to execute the method call against.

summonerName - Summoner name associated with summoner to retrieve.

Returns:

A map of desired summoners

Throws:

java.lang.IllegalArgumentException - If summonerName is not a valid summoner name

java.lang.NullPointerException - If platform or summonerName is null

See Also:

Summoner

getTimelineByMatchId

public AsyncRequest getTimelineByMatchId(Platform platform,
                                         long matchId)

Get match timeline by matchId.

Parameters:

platform - Platform to execute the method call against.

matchId - The ID of the match.

Returns:

A map with match timeline details

Throws:

java.lang.NullPointerException - If platform is null

See Also:

MatchTimeline

getTournamentCode

public AsyncRequest getTournamentCode(java.lang.String tournamentCode)

Returns the tournament code DTO associated with a tournamentCode.

Parameters:

tournamentCode - The tournament code

Returns:

Tournament code DTO

Throws:

java.lang.NullPointerException - If tournamentCode is null

See Also:

TournamentCode

removeListeners

public void removeListeners(RequestListener... listeners)

Removes one or more RequestListener from getting informed when asynchronous requests finish.

Parameters:

listeners - One or more objects that implement RequestListener

See Also:

RequestListener

updateTournamentCode

public void updateTournamentCode(java.lang.String tournamentCode,
                                 TournamentMap mapType,
                                 PickType pickType,
                                 SpectatorType spectatorType,
                                 long... allowedSummonerIds)

Update the pick type, map, spectator type, or allowed summoners for a code.

Parameters:

tournamentCode - The tournament code

mapType - The map type of the game.

pickType - The pick type of the game.

spectatorType - The spectator type of the game.

allowedSummonerIds - Optional list of participants in order to validate the players eligible to join the lobby.

Throws:

java.lang.NullPointerException - If tournamentCode is null