public class ApiHandler extends Object implements LoLRestApi
| Modifier and Type | Class and Description |
|---|---|
class |
ApiHandler.CurrentGame |
class |
ApiHandler.FeaturedGamesHandler |
| Modifier and Type | Field and Description |
|---|---|
ApiHandler.CurrentGame |
currentGameHandler |
ApiHandler.FeaturedGamesHandler |
featuredGamesHandler |
| Constructor and Description |
|---|
ApiHandler(Shard shard,
String token)
Create a new ApiHandler object
|
| Modifier and Type | Method and Description |
|---|---|
List<BasicChampData> |
getBasicChampData()
Get basic champion data (id, freeToPlay) for all champions
|
BasicChampData |
getBasicChampData(int id)
Get basic champion data for the selected champion
|
LeagueList |
getChallenger(QueueType queue)
Get the region's challenger league
|
Champion |
getChampion(int id)
Get information about the specified champion
This method does not count towards the rate limit
|
Champion |
getChampion(int id,
ChampData champData)
Get information about the specified champion
This method does not count towards the rate limit
|
Champion |
getChampion(int id,
ChampData champData,
String version,
String locale)
Get information about the specified champion
This method does not count towards the rate limit
|
ChampionList |
getChampionListDto()
Get champion information for all champions
|
ChampionList |
getChampionListDto(ChampData champData)
Get champion information for all champions.
|
ChampionList |
getChampionListDto(String locale,
String version,
boolean dataById,
ChampData champData)
Get champion information for all champions
This method does not count towards the rate limit
|
Collection<Champion> |
getChampions()
All champions in the game.
|
Collection<Champion> |
getChampions(ChampData champData)
All champions in the game.
|
Collection<Champion> |
getChampions(ChampData champData,
String version,
String locale,
boolean dataById)
All champions in the game.
|
List<BasicChampData> |
getFreeToPlayChampions()
Get basic champion data for all free-to-play champions
|
Item |
getItem(int id)
Retrieve a specific item
This method does not count towards the rate limit
|
Item |
getItem(int id,
ItemData data)
Retrieve a specific item
This method does not count towards the rate limit
|
Item |
getItem(int id,
ItemData data,
String version,
String locale)
Retrieve a specific item
This method does not count towards the rate limit
|
ItemList |
getItemList()
Get a listing of items in the game
This method does not count towards the rate limit
|
ItemList |
getItemList(ItemData data)
Get a listing of items in the game
This method does not count towards the rate limit
|
ItemList |
getItemList(ItemData data,
String version,
String locale)
Get a listing of items in the game
This method does not count towards the rate limit
|
Map<Long,List<LeagueItem>> |
getLeagueEntries(long... summoners)
Get a listing of all league entries in the summoners' leagues
|
List<LeagueItem> |
getLeagueEntries(long summoner)
Get a listing of all league entries in the summoner's leagues
|
Map<String,List<LeagueItem>> |
getLeagueEntries(String... teamIds)
Get a listing of all league entries in the teams' leagues
|
List<LeagueItem> |
getLeagueEntries(String teamId)
Get a listing of all league entries in the team's leagues
|
Map<Long,List<LeagueList>> |
getLeagues(long... summoners)
Get a listing of leagues for the specified summoners
|
List<LeagueList> |
getLeagues(long summoner)
Get a listing of leagues for the summoner
|
Map<String,List<LeagueList>> |
getLeagues(String... teamIds)
Get a listing of leagues for the specified teams
|
List<LeagueList> |
getLeagues(String teamId)
Get a listing of leagues for the specified team
|
List<String> |
getLocales()
Retrieve supported locales for the specified region
This method does not count towards your rate limit
|
LocalizedMessages |
getLocalizedMessages()
Retrieve localized strings for the english locale
This method does not count towards your rate limit
|
LocalizedMessages |
getLocalizedMessages(String version,
String locale)
Retrieve localized strings for the english locale
This method does not count towards your rate limit
|
MapDataOverview |
getMaps()
Retrieve map information
This method does not count towards the rate limit
|
MapDataOverview |
getMaps(String version,
String locale)
Retrieve map information
This method does not count towards the rate limit
|
MasteryList |
getMasteries()
Get a listing of all masteries
This method does not count towards the rate limit
|
MasteryList |
getMasteries(MasteryData data)
Get a listing of all masteries
This method does not count towards the rate limit
|
MasteryList |
getMasteries(MasteryData data,
String version,
String locale)
Get a listing of all masteries
This method does not count towards the rate limit
|
Mastery |
getMastery(int id)
Get a specific mastery
This method does not count towards the rate limit
|
Mastery |
getMastery(int id,
MasteryData data)
Get a specific mastery
This method does not count towards the rate limit
|
Mastery |
getMastery(int id,
MasteryData data,
String version,
String locale)
Get a specific mastery
This method does not count towards the rate limit
|
Set<MasteryPage> |
getMasteryPages(int id)
Retrieve the mastery pages of a user
|
Map<Integer,Set<MasteryPage>> |
getMasteryPagesMultipleUsers(Integer... ids)
Retrieve mastery pages for multiple users
|
MatchDetail |
getMatch(long matchId)
Retrieves the specified match, including timeline.
|
MatchDetail |
getMatch(long matchId,
boolean includeTimeline)
Retrieves the specified match.
|
List<MatchSummary> |
getMatchHistory(long playerId)
Retrieve a player's match history.
|
List<MatchSummary> |
getMatchHistory(long playerId,
String... championIds)
Retrieve a player's match history.
|
List<MatchSummary> |
getMatchHistory(long playerId,
String[] championIds,
QueueType... queueTypes)
Retrieve a player's match history, filtering out all games not in the specified queues.
|
List<MatchSummary> |
getMatchHistory(long playerId,
String[] championIds,
QueueType[] queueTypes,
int beginIndex,
int endIndex)
Retrieve a player's match history, filtering out all games not in the specified queues.
|
RankedStats |
getRankedStats(long summoner)
Get ranked stats for a player
|
RankedStats |
getRankedStats(long summoner,
Season season)
Get ranked stats for a player in a specific season
|
Realm |
getRealm()
Get realm information for this region
This method does not count towards the rate limit
|
List<Game> |
getRecentGames(long summoner)
Get a listing of recent games for the summoner
|
Item |
getRune(int id)
Retrieve a specific runes
This method does not count towards the rate limit
|
Item |
getRune(int id,
ItemData data)
Retrieve a specific runes
This method does not count towards the rate limit
|
Item |
getRune(int id,
ItemData data,
String version,
String locale)
Retrieve a specific runes
This method does not count towards the rate limit
|
RuneList |
getRuneList()
Get a list of all runes
This method does not count towards the rate limit
|
RuneList |
getRuneList(ItemData data)
Get a list of all runes
This method does not count towards the rate limit
|
RuneList |
getRuneList(ItemData data,
String version,
String locale)
Get a list of all runes
This method does not count towards the rate limit
|
Set<RunePage> |
getRunePages(int id)
Retrieve the runes pages of a user
|
Map<Integer,Set<RunePage>> |
getRunePagesMultipleUsers(int... ids)
Retrieve runes pages for multiple users
|
List<ShardData> |
getShards()
Retrieves general information about each shard.
|
ShardStatus |
getShardStatus(Shard shard)
Retrieves detailed information about the specified shard.
|
List<PlayerStats> |
getStatsSummary(long summoner)
Get player stats for the player
|
List<PlayerStats> |
getStatsSummary(long summoner,
Season season)
Get player stats for the player
|
Summoner |
getSummoner(int id)
Get summoner information for the summoner with the specified id
|
Summoner |
getSummoner(String name)
Get summoner information for the specified summoner
|
long |
getSummonerId(String name)
Retrieve the summoner id for the specified user
|
List<Long> |
getSummonerIds(String... names)
Retrieve summoner ids for the specified names
|
String |
getSummonerName(int id)
Retrieve the summoner name of the specified user
|
Map<Integer,String> |
getSummonerNames(Integer... ids)
Retrieve summoner names for the specified ids
|
Map<Integer,Summoner> |
getSummoners(Integer... ids)
Get summoner information for the summoners with the specified ids
|
Map<String,Summoner> |
getSummoners(String... names)
Get summoner information for the summoners with the specified names
|
SummonerSpell |
getSummonerSpell(int id)
Retrieve a specific summoner spell
This method does not count towards the rate limit
|
SummonerSpell |
getSummonerSpell(int id,
SpellData data)
Retrieve a specific summoner spell
This method does not count towards the rate limit
|
SummonerSpell |
getSummonerSpell(int id,
SpellData data,
String version,
String locale)
Retrieve a specific summoner spell
This method does not count towards the rate limit
|
SummonerSpellList |
getSummonerSpellListDro(SpellData data,
String version,
String locale,
boolean dataById)
Get a list of all summoner spells as returned by the API
This method does not count towards the rate limit
|
SummonerSpellList |
getSummonerSpellListDto()
Get a list of all summoner spells as returned by the API
This method does not count towards the rate limit
|
SummonerSpellList |
getSummonerSpellListDto(SpellData data)
Get a list of all summoner spells as returned by the API
This method does not count towards the rate limit
|
Collection<SummonerSpell> |
getSummonerSpells()
Get a list of all summoner spells as Java Collection
This method does not count towards the rate limit
|
Collection<SummonerSpell> |
getSummonerSpells(SpellData data)
Get a list of all summoner spells as Java Collection
This method does not count towards the rate limit
|
Collection<SummonerSpell> |
getSummonerSpells(SpellData data,
String version,
String locale,
boolean dataById)
Get a list of all summoner spells as Java Collection
This method does not count towards the rate limit
|
RankedTeam |
getTeam(String teamId)
Retrieve information for the specified ranked team
|
Map<String,RankedTeam> |
getTeams(String... teamIds)
Retrieve information for the specified ranked teams
|
List<RankedTeam> |
getTeamsBySummoner(long id)
Retrieve the ranked teams of a user
|
Map<Long,List<RankedTeam>> |
getTeamsBySummoners(long... ids)
Retrieve the ranked teams of the specified users
|
List<String> |
getVersions()
Retrieve currently supported game versions.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetCurrentGameHandler, getFeaturedGamesHandlerpublic final ApiHandler.CurrentGame currentGameHandler
public final ApiHandler.FeaturedGamesHandler featuredGamesHandler
public List<BasicChampData> getBasicChampData()
public List<BasicChampData> getFreeToPlayChampions()
public BasicChampData getBasicChampData(int id)
id - The id of the championpublic List<Game> getRecentGames(long summoner)
summoner - The id of the summonerpublic List<LeagueList> getLeagues(long summoner)
summoner - The id of the summonerpublic Map<Long,List<LeagueList>> getLeagues(long... summoners)
summoners - The ids of the summonerspublic List<LeagueItem> getLeagueEntries(long summoner)
summoner - The id of the summonerpublic Map<Long,List<LeagueItem>> getLeagueEntries(long... summoners)
summoners - The ids of the summonerspublic List<LeagueList> getLeagues(String teamId)
teamId - The id of the teampublic Map<String,List<LeagueList>> getLeagues(String... teamIds)
teamIds - The ids of the teampublic List<LeagueItem> getLeagueEntries(String teamId)
teamId - The id of the teampublic Map<String,List<LeagueItem>> getLeagueEntries(String... teamIds)
teamIds - The ids of the teamspublic LeagueList getChallenger(QueueType queue)
queue - The queue type for which to retrieve the league informationpublic ChampionList getChampionListDto()
public ChampionList getChampionListDto(ChampData champData)
Get champion information for all champions.
This method does not count towards the rate limitchampData - Additional information to retrievepublic ChampionList getChampionListDto(String locale, String version, boolean dataById, ChampData champData)
Get champion information for all champions
This method does not count towards the rate limitlocale - Locale code for returned dataversion - Data dragon version for returned datadataById - If specified as true, the returned data map will use the champions' IDs as the keys.champData - Additional information to retrievepublic Collection<Champion> getChampions()
All champions in the game.
This method does not count towards the rate limitpublic Collection<Champion> getChampions(ChampData champData)
All champions in the game.
This method does not count towards the rate limitchampData - Additional information to retrievepublic Collection<Champion> getChampions(ChampData champData, String version, String locale, boolean dataById)
All champions in the game.
This method does not count towards the rate limitlocale - Locale code for returned dataversion - Data dragon version for returned datadataById - If specified as true, the returned data map will use the champions' IDs as the keys.champData - Additional information to retrievepublic Champion getChampion(int id)
Get information about the specified champion
This method does not count towards the rate limitid - The id of the championpublic Champion getChampion(int id, ChampData champData)
Get information about the specified champion
This method does not count towards the rate limitid - The id of the championchampData - Additional information to retrievepublic Champion getChampion(int id, ChampData champData, String version, String locale)
Get information about the specified champion
This method does not count towards the rate limitlocale - Locale code for returned dataversion - Data dragon version for returned dataid - The id of the championchampData - Additional information to retrievepublic ItemList getItemList()
Get a listing of items in the game
This method does not count towards the rate limitpublic ItemList getItemList(ItemData data)
Get a listing of items in the game
This method does not count towards the rate limitdata - Additional information to retrievepublic ItemList getItemList(ItemData data, String version, String locale)
Get a listing of items in the game
This method does not count towards the rate limitversion - Data dragon version for returned datalocale - Locale code for returned datadata - Additional information to retrievepublic Item getItem(int id)
Retrieve a specific item
This method does not count towards the rate limitid - The id of the itempublic Item getItem(int id, ItemData data)
Retrieve a specific item
This method does not count towards the rate limitid - The id of the itemdata - Additional information to retrievepublic Item getItem(int id, ItemData data, String version, String locale)
Retrieve a specific item
This method does not count towards the rate limitid - The id of the itemdata - Additional information to retrieveversion - Data dragon version for returned datalocale - Locale code for returned datapublic MasteryList getMasteries()
Get a listing of all masteries
This method does not count towards the rate limitpublic MasteryList getMasteries(MasteryData data)
Get a listing of all masteries
This method does not count towards the rate limitdata - Additional information to retrievepublic MasteryList getMasteries(MasteryData data, String version, String locale)
Get a listing of all masteries
This method does not count towards the rate limitdata - Additional information to retrieveversion - Data dragon version for returned datalocale - Locale code for returned datapublic Mastery getMastery(int id)
Get a specific mastery
This method does not count towards the rate limitid - The id of the masterypublic Mastery getMastery(int id, MasteryData data)
Get a specific mastery
This method does not count towards the rate limitid - The id of the masterydata - Additional information to retrievepublic Mastery getMastery(int id, MasteryData data, String version, String locale)
Get a specific mastery
This method does not count towards the rate limitid - The id of the masterydata - Additional information to retrieveversion - Data dragon version for returned datalocale - Locale code for returned datapublic Realm getRealm()
Get realm information for this region
This method does not count towards the rate limitpublic RuneList getRuneList()
Get a list of all runes
This method does not count towards the rate limitpublic RuneList getRuneList(ItemData data)
Get a list of all runes
This method does not count towards the rate limitdata - Additional information to retrievepublic RuneList getRuneList(ItemData data, String version, String locale)
Get a list of all runes
This method does not count towards the rate limitdata - Additional information to retrieveversion - Data dragon version for returned datalocale - Locale code for returned datapublic Item getRune(int id)
Retrieve a specific runes
This method does not count towards the rate limitid - The id of the runespublic Item getRune(int id, ItemData data)
Retrieve a specific runes
This method does not count towards the rate limitid - The id of the runesdata - Additional information to retrievepublic Item getRune(int id, ItemData data, String version, String locale)
Retrieve a specific runes
This method does not count towards the rate limitid - The id of the runesdata - Additional information to retrieveversion - Data dragon version for returned datalocale - Locale code for returned datapublic SummonerSpellList getSummonerSpellListDto()
Get a list of all summoner spells as returned by the API
This method does not count towards the rate limitpublic SummonerSpellList getSummonerSpellListDto(SpellData data)
Get a list of all summoner spells as returned by the API
This method does not count towards the rate limitdata - Additional information to retrievepublic SummonerSpellList getSummonerSpellListDro(SpellData data, String version, String locale, boolean dataById)
Get a list of all summoner spells as returned by the API
This method does not count towards the rate limitdata - Additional information to retrieveversion - Data dragon version for returned datalocale - Locale code for returned datadataById - If specified as true, the returned data map will use the spells' IDs as the keys.public Collection<SummonerSpell> getSummonerSpells()
Get a list of all summoner spells as Java Collection
This method does not count towards the rate limitpublic Collection<SummonerSpell> getSummonerSpells(SpellData data)
Get a list of all summoner spells as Java Collection
This method does not count towards the rate limitdata - Additional information to retrievepublic Collection<SummonerSpell> getSummonerSpells(SpellData data, String version, String locale, boolean dataById)
Get a list of all summoner spells as Java Collection
This method does not count towards the rate limitdata - Additional information to retrieveversion - Data dragon version for returned datalocale - Locale code for returned datadataById - If specified as true, the returned data map will use the spells' IDs as the keys.public SummonerSpell getSummonerSpell(int id)
Retrieve a specific summoner spell
This method does not count towards the rate limitid - The id of the spellpublic SummonerSpell getSummonerSpell(int id, SpellData data)
Retrieve a specific summoner spell
This method does not count towards the rate limitid - The id of the spelldata - Additional information to retrievepublic SummonerSpell getSummonerSpell(int id, SpellData data, String version, String locale)
Retrieve a specific summoner spell
This method does not count towards the rate limitid - The id of the spelldata - Additional information to retrieveversion - Data dragon version for returned datalocale - Locale code for returned datapublic List<String> getVersions()
Retrieve currently supported game versions.
This method does not count towards the rate limitpublic MapDataOverview getMaps()
Retrieve map information
This method does not count towards the rate limitpublic MapDataOverview getMaps(String version, String locale)
Retrieve map information
This method does not count towards the rate limitversion - The data dragon version.locale - The locale information.public List<String> getLocales()
Retrieve supported locales for the specified region
This method does not count towards your rate limitpublic LocalizedMessages getLocalizedMessages()
Retrieve localized strings for the english locale
This method does not count towards your rate limitpublic LocalizedMessages getLocalizedMessages(String version, String locale)
Retrieve localized strings for the english locale
This method does not count towards your rate limitversion - The data dragon version of the datalocale - The locale to lookup.public List<ShardData> getShards()
Retrieves general information about each shard.
public ShardStatus getShardStatus(Shard shard)
Retrieves detailed information about the specified shard.
shard - The target regionpublic MatchDetail getMatch(long matchId)
getMatch(matchId, true);matchId - The id of the match.public MatchDetail getMatch(long matchId, boolean includeTimeline)
matchId - The id of the match.includeTimeline - Whether or not the event timeline should be retrieved.public List<MatchSummary> getMatchHistory(long playerId)
playerId - The id of the player.public List<MatchSummary> getMatchHistory(long playerId, String... championIds)
playerId - The id of the player.championIds - The championIds to use for retrieval.public List<MatchSummary> getMatchHistory(long playerId, String[] championIds, QueueType... queueTypes)
playerId - The id of the player.championIds - The championIds to use for retrieval.queueTypes - The queue types to retrieve (must be one of RANKED_SOLO_5x5, RANKED_TEAM_3x3 or
RANKED_TEAM_5x5).public List<MatchSummary> getMatchHistory(long playerId, String[] championIds, QueueType[] queueTypes, int beginIndex, int endIndex)
playerId - The id of the player.championIds - The championIds to use for retrieval.queueTypes - The queue types to retrieve (must be one of RANKED_SOLO_5x5, RANKED_TEAM_3x3 or
RANKED_TEAM_5x5).beginIndex - The index of the first game that should be retrieved.endIndex - The index of the last game the should be retrieved.public RankedStats getRankedStats(long summoner)
summoner - The id of the summonerpublic RankedStats getRankedStats(long summoner, Season season)
summoner - The id of the summonerseason - The seasonpublic List<PlayerStats> getStatsSummary(long summoner)
summoner - The id of the summonerpublic List<PlayerStats> getStatsSummary(long summoner, Season season)
summoner - The id of the summonerseason - The seasonpublic Map<String,Summoner> getSummoners(String... names)
names - The names of the playersUtil.standardizeSummonerName(java.lang.String)public Summoner getSummoner(String name)
name - The name of the summonerpublic Map<Integer,Summoner> getSummoners(Integer... ids)
ids - The ids of the summonerspublic Summoner getSummoner(int id)
id - The id of the summonerpublic Map<Integer,Set<MasteryPage>> getMasteryPagesMultipleUsers(Integer... ids)
ids - The ids of the userspublic Set<MasteryPage> getMasteryPages(int id)
id - The user's idpublic Map<Integer,String> getSummonerNames(Integer... ids)
ids - The ids to lookuppublic String getSummonerName(int id)
id - The id of the userpublic Map<Integer,Set<RunePage>> getRunePagesMultipleUsers(int... ids)
ids - The ids of the userspublic Set<RunePage> getRunePages(int id)
id - The user's idpublic List<RankedTeam> getTeamsBySummoner(long id)
id - The user's idpublic Map<Long,List<RankedTeam>> getTeamsBySummoners(long... ids)
ids - The users' idspublic RankedTeam getTeam(String teamId)
teamId - The team to retrievepublic Map<String,RankedTeam> getTeams(String... teamIds)
teamIds - The ids of the teamspublic List<Long> getSummonerIds(String... names)
names - The names of the userspublic long getSummonerId(String name)
Retrieve the summoner id for the specified user
name - The name of the userCopyright © 2015. All rights reserved.