Package | Description |
---|---|
<Unnamed> | |
net.rithms.riot.api |
This package provides the
RiotApi class to request data from the Riot Api. |
net.rithms.riot.api.endpoints.tournament | |
net.rithms.riot.api.request |
This package contains the classes and interfaces that are used to send requests to the Riot Api and parse the responses.
|
net.rithms.riot.api.request.ratelimit |
This package contains the classes that are used by requests internally to automatically handle rate limit
|
net.rithms.test |
This package provides JUnit tests to test this api's classes and functions.
|
net.rithms.test.async |
This package provides JUnit tests to test asynchronous api calls.
|
net.rithms.test.sync |
This package provides JUnit tests to test synchronous api calls.
|
Modifier and Type | Method and Description |
---|---|
static void |
StaticDataWithLocaleExample.main(java.lang.String[] args) |
static void |
MatchListExample.main(java.lang.String[] args) |
static void |
AsyncExample.main(java.lang.String[] args) |
static void |
SummonerExample.main(java.lang.String[] args) |
Constructor and Description |
---|
AsyncExample() |
Modifier and Type | Method and Description |
---|---|
AsyncRequest |
RiotApiAsync.callCustomApiMethod(ApiMethod method)
Call a custom
ApiMethod |
java.lang.Object |
RiotApi.callCustomApiMethod(ApiMethod method)
Call a custom
ApiMethod |
void |
ApiMethod.checkRequirements() |
int |
RiotApi.createTournament(int providerId)
Creates a tournament and returns its ID.
|
int |
RiotApi.createTournament(java.lang.String tournamentName,
int providerId)
Creates a tournament and returns its ID.
|
java.util.List<java.lang.String> |
RiotApi.createTournamentCodes(int tournamentId,
int count,
int teamSize,
TournamentMap mapType,
PickType pickType,
SpectatorType spectatorType,
long... allowedSummonerIds)
Create tournament codes for the given tournament.
|
java.util.List<java.lang.String> |
RiotApi.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.
|
int |
RiotApi.createTournamentProvider(java.lang.String region,
java.lang.String callbackUrl)
Creates a tournament provider and returns its ID.
|
CurrentGameInfo |
RiotApi.getActiveGameBySummoner(Platform platform,
long summonerId)
Get current game information for the given summoner ID.
|
LeagueList |
RiotApi.getChallengerLeagueByQueue(Platform platform,
LeagueQueue queue)
Get the challenger league for a given
queue . |
LeagueList |
RiotApi.getChallengerLeagueByQueue(Platform platform,
java.lang.String queue)
Get the challenger league for a given
queue . |
Champion |
RiotApi.getChampion(Platform platform,
int id)
Retrieve champion by
id . |
java.util.List<ChampionMastery> |
RiotApi.getChampionMasteriesBySummoner(Platform platform,
long summonerId)
Get all champion mastery entries sorted by number of champion points descending
|
ChampionMastery |
RiotApi.getChampionMasteriesBySummonerByChampion(Platform platform,
long summonerId,
int championId)
Get a champion mastery by
summonerId and championId . |
int |
RiotApi.getChampionMasteryScoresBySummoner(Platform platform,
long summonerId)
Get a player's total champion mastery score, which is sum of individual champion mastery levels
|
ChampionList |
RiotApi.getChampions(Platform platform)
Retrieve all champions.
|
ChampionList |
RiotApi.getChampions(Platform platform,
boolean freeToPlay)
Retrieve all champions.
|
Champion |
RiotApi.getDataChampion(Platform platform,
int id)
Retrieves a champion by
id . |
Champion |
RiotApi.getDataChampion(Platform platform,
int id,
Locale locale,
java.lang.String version,
ChampionTags... tags)
Retrieves a champion by
id . |
ChampionList |
RiotApi.getDataChampionList(Platform platform)
Retrieves champion list.
|
ChampionList |
RiotApi.getDataChampionList(Platform platform,
Locale locale,
java.lang.String version,
boolean dataById,
ChampionListTags... tags)
Retrieves champion list.
|
Item |
RiotApi.getDataItem(Platform platform,
int id)
Retrieves item by
id . |
Item |
RiotApi.getDataItem(Platform platform,
int id,
Locale locale,
java.lang.String version,
ItemTags... tags)
Retrieves item by
id . |
ItemList |
RiotApi.getDataItemList(Platform platform)
Retrieves item list.
|
ItemList |
RiotApi.getDataItemList(Platform platform,
Locale locale,
java.lang.String version,
ItemListTags... tags)
Retrieves item list.
|
java.util.List<java.lang.String> |
RiotApi.getDataLanguages(Platform platform)
Retrieve supported languages data.
|
LanguageStrings |
RiotApi.getDataLanguageStrings(Platform platform)
Retrieve language strings data.
|
LanguageStrings |
RiotApi.getDataLanguageStrings(Platform platform,
Locale locale,
java.lang.String version)
Retrieve language strings data.
|
MapData |
RiotApi.getDataMaps(Platform platform)
Retrieves map data.
|
MapData |
RiotApi.getDataMaps(Platform platform,
Locale locale,
java.lang.String version)
Retrieves map data.
|
Mastery |
RiotApi.getDataMastery(Platform platform,
int id)
Retrieves mastery item by
id . |
Mastery |
RiotApi.getDataMastery(Platform platform,
int id,
Locale locale,
java.lang.String version,
MasteryTags... tags)
Retrieves mastery item by
id . |
MasteryList |
RiotApi.getDataMasteryList(Platform platform)
Retrieves mastery list.
|
MasteryList |
RiotApi.getDataMasteryList(Platform platform,
Locale locale,
java.lang.String version,
MasteryListTags... tags)
Retrieves mastery list.
|
ProfileIconData |
RiotApi.getDataProfileIcons(Platform platform)
Retrieve profile icons.
|
ProfileIconData |
RiotApi.getDataProfileIcons(Platform platform,
Locale locale,
java.lang.String version)
Retrieve profile icons.
|
Realm |
RiotApi.getDataRealm(Platform platform)
Retrieve realm data.
|
Rune |
RiotApi.getDataRune(Platform platform,
int id)
Retrieves rune by
id . |
Rune |
RiotApi.getDataRune(Platform platform,
int id,
Locale locale,
java.lang.String version,
RuneTags... tags)
Retrieves rune by
id . |
RuneList |
RiotApi.getDataRuneList(Platform platform)
Retrieves rune list.
|
RuneList |
RiotApi.getDataRuneList(Platform platform,
Locale locale,
java.lang.String version,
RuneListTags... tags)
Retrieves rune list.
|
SummonerSpell |
RiotApi.getDataSummonerSpell(Platform platform,
int id)
Retrieves summoner spell by
id . |
SummonerSpell |
RiotApi.getDataSummonerSpell(Platform platform,
int id,
Locale locale,
java.lang.String version,
SpellTags... tags)
Retrieves summoner spell by
id . |
SummonerSpellList |
RiotApi.getDataSummonerSpellList(Platform platform)
Retrieves summoner spell list.
|
SummonerSpellList |
RiotApi.getDataSummonerSpellList(Platform platform,
Locale locale,
java.lang.String version,
boolean dataById,
SpellListTags... tags)
Retrieves summoner spell list.
|
java.util.List<java.lang.String> |
RiotApi.getDataVersions(Platform platform)
Retrieve version data.
|
FeaturedGames |
RiotApi.getFeaturedGames(Platform platform)
Get list of featured games.
|
java.util.Set<LeaguePosition> |
RiotApi.getLeaguePositionsBySummonerId(Platform platform,
long summonerId)
Get league positions in all queues for a given
summonerId . |
java.util.List<LeagueList> |
RiotApi.getLeaguesBySummonerId(Platform platform,
long summonerId)
Get leagues in all queues for a given
summonerId . |
LobbyEventWrapper |
RiotApi.getLobbyEventsByTournament(java.lang.String tournamentCode)
Gets a list of lobby events by
tournamentCode |
MasteryPages |
RiotApi.getMasteriesBySummoner(Platform platform,
long summonerId)
Get mastery pages for a given
summonerId . |
LeagueList |
RiotApi.getMasterLeagueByQueue(Platform platform,
LeagueQueue queue)
Get the master league for a given
queue . |
LeagueList |
RiotApi.getMasterLeagueByQueue(Platform platform,
java.lang.String queue)
Get the master league for a given
queue . |
Match |
RiotApi.getMatch(Platform platform,
long matchId)
Get match by
matchId . |
Match |
RiotApi.getMatch(Platform platform,
long matchId,
long forAccountId)
Get match by
matchId . |
Match |
RiotApi.getMatchByMatchIdAndTournamentCode(Platform platform,
long matchId,
java.lang.String tournamentCode)
Retrieve match by
matchId and tournamentCode . |
java.util.List<java.lang.Long> |
RiotApi.getMatchIdsByTournamentCode(Platform platform,
java.lang.String tournamentCode)
Retrieve match IDs by
tournamentCode . |
MatchList |
RiotApi.getMatchListByAccountId(Platform platform,
long accountId)
Get matchlist for given account ID and platform ID.
|
MatchList |
RiotApi.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.
|
MatchList |
RiotApi.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.
|
MatchList |
RiotApi.getRecentMatchListByAccountId(Platform platform,
long accountId)
Deprecated.
|
RunePages |
RiotApi.getRunesBySummoner(Platform platform,
long summonerId)
Get rune pages for a given
summonerId . |
ShardStatus |
RiotApi.getShardData(Platform platform)
Get shard status.
|
Summoner |
RiotApi.getSummoner(Platform platform,
long summonerId)
Get a summoner object for a given
summonerId . |
Summoner |
RiotApi.getSummonerByAccount(Platform platform,
long accountId)
Get a summoner object for a given
accountId . |
Summoner |
RiotApi.getSummonerByName(Platform platform,
java.lang.String summonerName)
Get a single summoner object for a given
summonerName . |
MatchTimeline |
RiotApi.getTimelineByMatchId(Platform platform,
long matchId)
Get match timeline by
matchId . |
TournamentCode |
RiotApi.getTournamentCode(java.lang.String tournamentCode)
Returns the tournament code DTO associated with a
tournamentCode . |
void |
RiotApi.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.
|
Modifier and Type | Method and Description |
---|---|
void |
TournamentApiMethod.checkRequirements() |
Modifier and Type | Method and Description |
---|---|
RiotApiException |
Request.getException()
Returns the exception that was thrown when calling
Request.execute() . |
Modifier and Type | Method and Description |
---|---|
void |
RequestListener.onRequestFailed(RiotApiException e)
Invoked when a request fails.
|
void |
RequestAdapter.onRequestFailed(RiotApiException e) |
Modifier and Type | Method and Description |
---|---|
<T> T |
Request.getDto()
Retrieves the result of the request.
|
<T> T |
AsyncRequest.getDtoAndThrowException()
Retrieves the request's result.
|
Constructor and Description |
---|
Request(ApiConfig config,
ApiMethod object)
Constructs a synchronous request
|
Modifier and Type | Class and Description |
---|---|
class |
RateLimitException
Thrown when the Riot Api returns error code 429 (rate limit exceeded).
|
class |
RespectedRateLimitException
Thrown when the
RateLimitHandler decides to drop a request instead of sending it to the Riot API to prevent violating the rate
limit. |
Modifier and Type | Method and Description |
---|---|
void |
UtilTest.testJoinString() |
void |
UtilTest.testNormalizeSummonerName() |
void |
UtilTest.testNormalizeSummonerNames() |
Modifier and Type | Method and Description |
---|---|
void |
AsyncSummonerTest.testGetMasteryPages() |
void |
AsyncSummonerTest.testGetRunePages() |
void |
AsyncSummonerTest.testGetSummonerByName() |
void |
AsyncSummonerTest.testGetSummoners() |
void |
AsyncSummonerTest.testGetSummonersByAccount() |
Modifier and Type | Method and Description |
---|---|
void |
SummonerTest.testGetMasteryPages() |
void |
SummonerTest.testGetRunePages() |
void |
SummonerTest.testGetSummoner() |
void |
SummonerTest.testGetSummonerByAccount() |
void |
SummonerTest.testGetSummonerByName() |