org.dc.riot.lol.rx.service

Interface RiotApi.League

All Superinterfaces:

RiotApi

Enclosing interface:

RiotApi

public static interface RiotApi.League
extends RiotApi

Retrieves data about players' leagues. Generally, requests with invalid parameters will return null instead of of throwing exceptions.

Since:

1.0.0

See Also:

LeagueDto, LeagueEntryDto

Nested Class Summary

Nested classes/interfaces inherited from interface org.dc.riot.lol.rx.service.RiotApi

RiotApi.Champion, RiotApi.ChampionMastery, RiotApi.CurrentGame, RiotApi.FeaturedGames, RiotApi.League, RiotApi.LolStatus, RiotApi.Match, RiotApi.MatchList, RiotApi.RateType, RiotApi.RecentGames, RiotApi.StaticData, RiotApi.Stats, RiotApi.Summoner, RiotApi.Team

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,LeagueDto[]>	getBySummonerEntries(long... summonerIds) /api/lol/{region}/v2.5/league/by-summoner/{summonerIds}/entry 400 Bad request 401 Unauthorized 404 League data not found 429 Rate limit exceeded 500 Internal server error 503 Service unavailable
java.util.Map<java.lang.String,LeagueDto[]>	getBySummoners(long... summonerIds) /api/lol/{region}/v2.5/league/by-summoner/{summonerIds}/entry 400 Bad request 401 Unauthorized 404 League data not found 429 Rate limit exceeded 500 Internal server error 503 Service unavailable
java.util.Map<java.lang.String,LeagueDto[]>	getByTeamEntries(java.lang.String... teamIds) /api/lol/{region}/v2.5/league/by-team/{teamIds}/entry 400 Bad request 401 Unauthorized 404 League data not found 429 Rate limit exceeded 500 Internal server error 503 Service unavailable
java.util.Map<java.lang.String,LeagueDto[]>	getByTeams(java.lang.String... teamIds) /api/lol/{region}/v2.5/league/by-team/{teamIds} 400 Bad request 401 Unauthorized 404 League data not found 429 Rate limit exceeded 500 Internal server error 503 Service unavailable
LeagueDto	getChallenger(QueueType.ChallengerMaster queue) /api/lol/{region}/v2.5/league/challenger 400 Bad request, (e.g.
LeagueDto	getMaster(QueueType.ChallengerMaster queue) /api/lol/{region}/v2.5/league/master 400 Bad request 401 Unauthorized 404 League data not found 429 Rate limit exceeded 500 Internal server error 503 Service unavailable
static Region[]	getSupportedRegions(float version)

Methods inherited from interface org.dc.riot.lol.rx.service.RiotApi

getApiKey, getRateType, getRegion, getVersion, setAutoRetry, setPrintUrl, setProxy, setRateControl, setRetryCount

Method Detail

getSupportedRegions

static Region[] getSupportedRegions(float version)

Parameters:

version - a positive value denoting the version (e.g. 1.2)

Returns:

the set of Regions this API supports

Throws:

InvalidVersionException - if the version number cannot be mapped to a valid version

getBySummonerEntries

java.util.Map<java.lang.String,LeagueDto[]> getBySummonerEntries(long... summonerIds)
                                                          throws java.io.IOException,
                                                                 HttpException

/api/lol/{region}/v2.5/league/by-summoner/{summonerIds}/entry

400 Bad request
401 Unauthorized
404 League data not found
429 Rate limit exceeded
500 Internal server error
503 Service unavailable

Parameters:

summonerIds - set of summoners to look up

Returns:

a Map of summonerId Strings to List of LeagueDto objects or null if nothing found

Throws:

HttpException - non 2XX response code returned

java.io.IOException - some connection error (e.g. server down)

getBySummoners

java.util.Map<java.lang.String,LeagueDto[]> getBySummoners(long... summonerIds)
                                                    throws java.io.IOException,
                                                           HttpException

/api/lol/{region}/v2.5/league/by-summoner/{summonerIds}/entry

400 Bad request
401 Unauthorized
404 League data not found
429 Rate limit exceeded
500 Internal server error
503 Service unavailable

Parameters:

summonerIds - set of summoners to look up

Returns:

a Map of summonerId Strings to List of LeagueDto objects or null if nothing found

Throws:

HttpException - non 2XX response code returned

java.io.IOException - some connection error (e.g. server down)

getByTeams

java.util.Map<java.lang.String,LeagueDto[]> getByTeams(java.lang.String... teamIds)
                                                throws java.io.IOException,
                                                       HttpException

/api/lol/{region}/v2.5/league/by-team/{teamIds}

400 Bad request
401 Unauthorized
404 League data not found
429 Rate limit exceeded
500 Internal server error
503 Service unavailable

Parameters:

teamIds - set of teams to look up, max length of 10

Returns:

Map of teamId Strings to List of LeagueDto objects or null if nothing found

Throws:

HttpException - non 2XX response code returned

java.io.IOException - some connection error (e.g. server down)

getByTeamEntries

java.util.Map<java.lang.String,LeagueDto[]> getByTeamEntries(java.lang.String... teamIds)
                                                      throws java.io.IOException,
                                                             HttpException

/api/lol/{region}/v2.5/league/by-team/{teamIds}/entry

400 Bad request
401 Unauthorized
404 League data not found
429 Rate limit exceeded
500 Internal server error
503 Service unavailable

Parameters:

teamIds - set of teams to look up

Returns:

a Map of teamId Strings to List of LeagueDto objects or null if nothing found

Throws:

HttpException - non 2XX response code returned

java.io.IOException - some connection error (e.g. server down)

getChallenger

LeagueDto getChallenger(QueueType.ChallengerMaster queue)
                 throws java.io.IOException,
                        HttpException

/api/lol/{region}/v2.5/league/challenger

400 Bad request, (e.g. requested Challenger data for an unranked queue type)
401 Unauthorized
404 League data not found
429 Rate limit exceeded
500 Internal server error
503 Service unavailable

Parameters:

queue - the queue type to search for

Returns:

a LeagueDto object with data or null if bad request.

Throws:

HttpException - non 2XX response code returned

java.io.IOException - some connection error (e.g. server down)

getMaster

LeagueDto getMaster(QueueType.ChallengerMaster queue)
             throws java.io.IOException,
                    HttpException

/api/lol/{region}/v2.5/league/master

400 Bad request
401 Unauthorized
404 League data not found
429 Rate limit exceeded
500 Internal server error
503 Service unavailable

Parameters:

queue - the queue type to search for

Returns:

a LeagueDto object with data or null if bad request

Throws:

HttpException - non 2XX response code returned

java.io.IOException - some connection error (e.g. server down)