| Package | Description |
|---|---|
| com.mingweisamuel.zyra |
Contains core elements of the Zyra library, such as
RiotApi and all of the endpoint
sets.com.mingweisamuel.zyra.util Contains general utilities used internally.com.mingweisamuel.zyra.enums Contains general static classes and enums useful for interacting with the
Riot API.The remaining sub-packages contain generated DTO classes returned by their respective endpoint set. |
| com.mingweisamuel.zyra.entity |
Entity classes, high level representations of Riot API objects for ease of use.
All objects should be created via the EntityApi get* methods. |
| com.mingweisamuel.zyra.enums |
Contains general static classes and enums useful for interacting with the Riot API.
|
| com.mingweisamuel.zyra.util |
Contains generally useful classes used internally by Zyra.
|
| Modifier and Type | Method and Description |
|---|---|
List<ChampionMastery> |
ChampionMasteryV4Endpoints.getAllChampionMasteries(Region region,
String encryptedSummonerId)
Get all champion mastery entries sorted by number of champion points descending,
Link to Portal
|
CompletableFuture<List<ChampionMastery>> |
ChampionMasteryV4Endpoints.getAllChampionMasteriesAsync(Region region,
String encryptedSummonerId)
Get all champion mastery entries sorted by number of champion points descending,
Link to Portal
|
List<LeaguePosition> |
LeagueV4Endpoints.getAllLeaguePositionsForSummoner(Region region,
String encryptedSummonerId)
(Deprecated) Get league positions in all queues for a given summoner ID.
|
CompletableFuture<List<LeaguePosition>> |
LeagueV4Endpoints.getAllLeaguePositionsForSummonerAsync(Region region,
String encryptedSummonerId)
(Deprecated) Get league positions in all queues for a given summoner ID.
|
Summoner |
SummonerV4Endpoints.getByAccountId(Region region,
String encryptedAccountId)
Get a summoner by account ID.
|
CompletableFuture<Summoner> |
SummonerV4Endpoints.getByAccountIdAsync(Region region,
String encryptedAccountId)
Get a summoner by account ID.
|
Summoner |
SummonerV4Endpoints.getByPUUID(Region region,
String encryptedPUUID)
Get a summoner by PUUID.
|
CompletableFuture<Summoner> |
SummonerV4Endpoints.getByPUUIDAsync(Region region,
String encryptedPUUID)
Get a summoner by PUUID.
|
Summoner |
SummonerV4Endpoints.getBySummonerId(Region region,
String encryptedSummonerId)
Get a summoner by summoner ID.
|
CompletableFuture<Summoner> |
SummonerV4Endpoints.getBySummonerIdAsync(Region region,
String encryptedSummonerId)
Get a summoner by summoner ID.
|
Summoner |
SummonerV4Endpoints.getBySummonerName(Region region,
String summonerName)
Get a summoner by summoner name.
|
CompletableFuture<Summoner> |
SummonerV4Endpoints.getBySummonerNameAsync(Region region,
String summonerName)
Get a summoner by summoner name.
|
LeagueList |
LeagueV4Endpoints.getChallengerLeague(Region region,
String queue)
Get the challenger league for given queue.
|
CompletableFuture<LeagueList> |
LeagueV4Endpoints.getChallengerLeagueAsync(Region region,
String queue)
Get the challenger league for given queue.
|
ChampionInfo |
ChampionV3Endpoints.getChampionInfo(Region region)
Returns champion rotations, including free-to-play and low-level free-to-play rotations (REST)
Link to Portal
|
CompletableFuture<ChampionInfo> |
ChampionV3Endpoints.getChampionInfoAsync(Region region)
Returns champion rotations, including free-to-play and low-level free-to-play rotations (REST)
Link to Portal
|
ChampionMastery |
ChampionMasteryV4Endpoints.getChampionMastery(Region region,
String encryptedSummonerId,
long championId)
Get a champion mastery by player ID and champion ID.
|
CompletableFuture<ChampionMastery> |
ChampionMasteryV4Endpoints.getChampionMasteryAsync(Region region,
String encryptedSummonerId,
long championId)
Get a champion mastery by player ID and champion ID.
|
Integer |
ChampionMasteryV4Endpoints.getChampionMasteryScore(Region region,
String encryptedSummonerId)
Get a player's total champion mastery score, which is the sum of individual champion mastery levels.
|
CompletableFuture<Integer> |
ChampionMasteryV4Endpoints.getChampionMasteryScoreAsync(Region region,
String encryptedSummonerId)
Get a player's total champion mastery score, which is the sum of individual champion mastery levels.
|
CurrentGameInfo |
SpectatorV4Endpoints.getCurrentGameInfoBySummoner(Region region,
String encryptedSummonerId)
Get current game information for the given summoner ID.
|
CompletableFuture<CurrentGameInfo> |
SpectatorV4Endpoints.getCurrentGameInfoBySummonerAsync(Region region,
String encryptedSummonerId)
Get current game information for the given summoner ID.
|
FeaturedGames |
SpectatorV4Endpoints.getFeaturedGames(Region region)
Get list of featured games.
|
CompletableFuture<FeaturedGames> |
SpectatorV4Endpoints.getFeaturedGamesAsync(Region region)
Get list of featured games.
|
LeagueList |
LeagueV4Endpoints.getGrandmasterLeague(Region region,
String queue)
Get the grandmaster league of a specific queue.
|
CompletableFuture<LeagueList> |
LeagueV4Endpoints.getGrandmasterLeagueAsync(Region region,
String queue)
Get the grandmaster league of a specific queue.
|
LeagueList |
LeagueV4Endpoints.getLeagueById(Region region,
String leagueId)
Get league with given ID, including inactive entries.
|
CompletableFuture<LeagueList> |
LeagueV4Endpoints.getLeagueByIdAsync(Region region,
String leagueId)
Get league with given ID, including inactive entries.
|
List<LeagueEntry> |
LeagueV4Endpoints.getLeagueEntries(Region region,
String division,
String tier,
String queue)
Get all the league entries.
|
List<LeagueEntry> |
LeagueV4Endpoints.getLeagueEntries(Region region,
String division,
String tier,
String queue,
Integer page)
Get all the league entries.
|
CompletableFuture<List<LeagueEntry>> |
LeagueV4Endpoints.getLeagueEntriesAsync(Region region,
String division,
String tier,
String queue)
Get all the league entries.
|
CompletableFuture<List<LeagueEntry>> |
LeagueV4Endpoints.getLeagueEntriesAsync(Region region,
String division,
String tier,
String queue,
Integer page)
Get all the league entries.
|
List<LeagueEntry> |
LeagueV4Endpoints.getLeagueEntriesForSummoner(Region region,
String encryptedSummonerId)
Get league entries in all queues for a given summoner ID.
|
CompletableFuture<List<LeagueEntry>> |
LeagueV4Endpoints.getLeagueEntriesForSummonerAsync(Region region,
String encryptedSummonerId)
Get league entries in all queues for a given summoner ID.
|
LobbyEventDTOWrapper |
TournamentStubV4Endpoints.getLobbyEventsByCode(Region region,
String tournamentCode)
Gets a mock list of lobby events by tournament code.
|
LobbyEventDTOWrapper |
TournamentV4Endpoints.getLobbyEventsByCode(Region region,
String tournamentCode)
Gets a list of lobby events by tournament code.
|
CompletableFuture<LobbyEventDTOWrapper> |
TournamentStubV4Endpoints.getLobbyEventsByCodeAsync(Region region,
String tournamentCode)
Gets a mock list of lobby events by tournament code.
|
CompletableFuture<LobbyEventDTOWrapper> |
TournamentV4Endpoints.getLobbyEventsByCodeAsync(Region region,
String tournamentCode)
Gets a list of lobby events by tournament code.
|
LeagueList |
LeagueV4Endpoints.getMasterLeague(Region region,
String queue)
Get the master league for given queue.
|
CompletableFuture<LeagueList> |
LeagueV4Endpoints.getMasterLeagueAsync(Region region,
String queue)
Get the master league for given queue.
|
Match |
MatchV4Endpoints.getMatch(Region region,
long matchId)
Get match by match ID.
|
CompletableFuture<Match> |
MatchV4Endpoints.getMatchAsync(Region region,
long matchId)
Get match by match ID.
|
Match |
MatchV4Endpoints.getMatchByTournamentCode(Region region,
String tournamentCode,
long matchId)
Get match by match ID and tournament code.
|
CompletableFuture<Match> |
MatchV4Endpoints.getMatchByTournamentCodeAsync(Region region,
String tournamentCode,
long matchId)
Get match by match ID and tournament code.
|
List<Long> |
MatchV4Endpoints.getMatchIdsByTournamentCode(Region region,
String tournamentCode)
Get match IDs by tournament code.
|
CompletableFuture<List<Long>> |
MatchV4Endpoints.getMatchIdsByTournamentCodeAsync(Region region,
String tournamentCode)
Get match IDs by tournament code.
|
Matchlist |
MatchV4Endpoints.getMatchlist(Region region,
String encryptedAccountId)
Get matchlist for games played on given account ID and platform ID and filtered using given filter parameters, if any.
|
Matchlist |
MatchV4Endpoints.getMatchlist(Region region,
String encryptedAccountId,
List<Integer> champion)
Get matchlist for games played on given account ID and platform ID and filtered using given filter parameters, if any.
|
Matchlist |
MatchV4Endpoints.getMatchlist(Region region,
String encryptedAccountId,
List<Integer> champion,
List<Integer> queue)
Get matchlist for games played on given account ID and platform ID and filtered using given filter parameters, if any.
|
Matchlist |
MatchV4Endpoints.getMatchlist(Region region,
String encryptedAccountId,
List<Integer> champion,
List<Integer> queue,
List<Integer> season)
Get matchlist for games played on given account ID and platform ID and filtered using given filter parameters, if any.
|
Matchlist |
MatchV4Endpoints.getMatchlist(Region region,
String encryptedAccountId,
List<Integer> champion,
List<Integer> queue,
List<Integer> season,
Long beginTime)
Get matchlist for games played on given account ID and platform ID and filtered using given filter parameters, if any.
|
Matchlist |
MatchV4Endpoints.getMatchlist(Region region,
String encryptedAccountId,
List<Integer> champion,
List<Integer> queue,
List<Integer> season,
Long beginTime,
Long endTime)
Get matchlist for games played on given account ID and platform ID and filtered using given filter parameters, if any.
|
Matchlist |
MatchV4Endpoints.getMatchlist(Region region,
String encryptedAccountId,
List<Integer> champion,
List<Integer> queue,
List<Integer> season,
Long beginTime,
Long endTime,
Integer beginIndex)
Get matchlist for games played on given account ID and platform ID and filtered using given filter parameters, if any.
|
Matchlist |
MatchV4Endpoints.getMatchlist(Region region,
String encryptedAccountId,
List<Integer> champion,
List<Integer> queue,
List<Integer> season,
Long beginTime,
Long endTime,
Integer beginIndex,
Integer endIndex)
Get matchlist for games played on given account ID and platform ID and filtered using given filter parameters, if any.
|
CompletableFuture<Matchlist> |
MatchV4Endpoints.getMatchlistAsync(Region region,
String encryptedAccountId)
Get matchlist for games played on given account ID and platform ID and filtered using given filter parameters, if any.
|
CompletableFuture<Matchlist> |
MatchV4Endpoints.getMatchlistAsync(Region region,
String encryptedAccountId,
List<Integer> champion)
Get matchlist for games played on given account ID and platform ID and filtered using given filter parameters, if any.
|
CompletableFuture<Matchlist> |
MatchV4Endpoints.getMatchlistAsync(Region region,
String encryptedAccountId,
List<Integer> champion,
List<Integer> queue)
Get matchlist for games played on given account ID and platform ID and filtered using given filter parameters, if any.
|
CompletableFuture<Matchlist> |
MatchV4Endpoints.getMatchlistAsync(Region region,
String encryptedAccountId,
List<Integer> champion,
List<Integer> queue,
List<Integer> season)
Get matchlist for games played on given account ID and platform ID and filtered using given filter parameters, if any.
|
CompletableFuture<Matchlist> |
MatchV4Endpoints.getMatchlistAsync(Region region,
String encryptedAccountId,
List<Integer> champion,
List<Integer> queue,
List<Integer> season,
Long beginTime)
Get matchlist for games played on given account ID and platform ID and filtered using given filter parameters, if any.
|
CompletableFuture<Matchlist> |
MatchV4Endpoints.getMatchlistAsync(Region region,
String encryptedAccountId,
List<Integer> champion,
List<Integer> queue,
List<Integer> season,
Long beginTime,
Long endTime)
Get matchlist for games played on given account ID and platform ID and filtered using given filter parameters, if any.
|
CompletableFuture<Matchlist> |
MatchV4Endpoints.getMatchlistAsync(Region region,
String encryptedAccountId,
List<Integer> champion,
List<Integer> queue,
List<Integer> season,
Long beginTime,
Long endTime,
Integer beginIndex)
Get matchlist for games played on given account ID and platform ID and filtered using given filter parameters, if any.
|
CompletableFuture<Matchlist> |
MatchV4Endpoints.getMatchlistAsync(Region region,
String encryptedAccountId,
List<Integer> champion,
List<Integer> queue,
List<Integer> season,
Long beginTime,
Long endTime,
Integer beginIndex,
Integer endIndex)
Get matchlist for games played on given account ID and platform ID and filtered using given filter parameters, if any.
|
MatchTimeline |
MatchV4Endpoints.getMatchTimeline(Region region,
long matchId)
Get match timeline by match ID.
|
CompletableFuture<MatchTimeline> |
MatchV4Endpoints.getMatchTimelineAsync(Region region,
long matchId)
Get match timeline by match ID.
|
List<LeaguePosition> |
LeagueV4Endpoints.getPositionalLeagueEntries(Region region,
String positionalQueue,
String tier,
String division,
String position,
int page)
(Deprecated) Get all the positional league entries.
|
CompletableFuture<List<LeaguePosition>> |
LeagueV4Endpoints.getPositionalLeagueEntriesAsync(Region region,
String positionalQueue,
String tier,
String division,
String position,
int page)
(Deprecated) Get all the positional league entries.
|
List<String> |
LeagueV4Endpoints.getQueuesWithPositionRanks(Region region)
(Deprecated) Get the queues that have positional ranks enabled.
|
CompletableFuture<List<String>> |
LeagueV4Endpoints.getQueuesWithPositionRanksAsync(Region region)
(Deprecated) Get the queues that have positional ranks enabled.
|
ShardStatus |
LolStatusV3Endpoints.getShardData(Region region)
Get League of Legends status for the given shard.
|
CompletableFuture<ShardStatus> |
LolStatusV3Endpoints.getShardDataAsync(Region region)
Get League of Legends status for the given shard.
|
String |
ThirdPartyCodeV4Endpoints.getThirdPartyCodeBySummonerId(Region region,
String encryptedSummonerId)
Get third party code for a given summoner ID.
|
CompletableFuture<String> |
ThirdPartyCodeV4Endpoints.getThirdPartyCodeBySummonerIdAsync(Region region,
String encryptedSummonerId)
Get third party code for a given summoner ID.
|
TournamentCode |
TournamentV4Endpoints.getTournamentCode(Region region,
String tournamentCode)
Returns the tournament code DTO associated with a tournament code string.
|
CompletableFuture<TournamentCode> |
TournamentV4Endpoints.getTournamentCodeAsync(Region region,
String tournamentCode)
Returns the tournament code DTO associated with a tournament code string.
|
| Modifier and Type | Field and Description |
|---|---|
protected Region |
Entity.region
This Entity's region.
|
| Modifier and Type | Method and Description |
|---|---|
Region |
Entity.getRegion()
This entity's region.
|
| Modifier and Type | Method and Description |
|---|---|
MatchEntity |
EntityApi.getMatch(Region region,
long matchId)
Gets a match entity by region and match ID.
|
MatchEntity |
EntityApi.getMatch(Region region,
long matchId,
String forAccountIdEnc)
Gets a match entity by region and match ID.
|
SummonerEntity |
EntityApi.getSummoner(Region region,
String summonerIdEnc)
Gets a summoner entity by region and summoner ID.
|
SummonerEntity |
EntityApi.getSummoner(Region region,
String summonerIdEnc,
String accountIdEnc)
Gets a summoner entity by region, summoner ID, and account ID.
|
SummonerEntity |
EntityApi.getSummoner(Region region,
String summonerIdEnc,
String accountIdEnc,
String name)
Gets a summoner entity by region, summoner ID, and a supplied summoner name (which will be normalized).
|
SummonerEntity |
EntityApi.getSummoner(Region region,
Summoner summoner)
Gets a summoner entity by a
Summoner instance. |
SummonerEntity |
EntityApi.getSummonerByAccountId(Region region,
String accountIdEnc)
Gets a summoner by region and account ID.
|
SummonerEntity |
EntityApi.getSummonerByName(Region region,
String name)
Gets a summoner by region and a supplied summoner name (which will be normalized).
|
| Modifier and Type | Method and Description |
|---|---|
static Region |
Region.parse(String value)
Parses a region or platform string.
|
static Region |
Region.valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static Region[] |
Region.values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
| Modifier and Type | Method and Description |
|---|---|
CompletableFuture<org.asynchttpclient.Response> |
RateLimitedRequester.getRequestNonRateLimitedAsync(String methodId,
String relativeUrl,
Region region,
List<org.asynchttpclient.Param> params) |
CompletableFuture<org.asynchttpclient.Response> |
RateLimitedRequester.getRequestRateLimitedAsync(String methodId,
String relativeUrl,
Region region,
List<org.asynchttpclient.Param> params) |
Copyright © 2019. All rights reserved.