org.dc.riot.lol.rx.service

Interface RiotApi.Champion

All Superinterfaces:

RiotApi

Enclosing interface:

RiotApi

public static interface RiotApi.Champion
extends RiotApi

Not for stats. This API is more concerned with enabled, ranked, free to play, etc. For champion stats see the RiotApi.StaticData interface.

Since:

1.0.0

See Also:

RiotApi.StaticData.getChampion(long, String, String, ChampDataTag...), RiotApi.StaticData.getChampions(boolean, String, String, ChampListDataTag...)

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
ChampDto	getChampion(long championId) /api/lol/{region}/v1.2/champion/{id} 400 Bad request 401 Unauthorized 429 Rate limit exceeded 500 Internal server error 503 Service unavailable
ChampListDto	getChampions(boolean freeToPlay) /api/lol/{region}/v1.2/champion 400 Bad request 401 Unauthorized 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

getChampions

ChampListDto getChampions(boolean freeToPlay)
                   throws java.io.IOException,
                          HttpException

/api/lol/{region}/v1.2/champion

400 Bad request
401 Unauthorized
429 Rate limit exceeded
500 Internal server error
503 Service unavailable

Parameters:

freeToPlay - fetch only free to play champions

Returns:

ChampListDto

Throws:

HttpException - non 2XX response code returned

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

getChampion

ChampDto getChampion(long championId)
              throws java.io.IOException,
                     HttpException

/api/lol/{region}/v1.2/champion/{id}

400 Bad request
401 Unauthorized
429 Rate limit exceeded
500 Internal server error
503 Service unavailable

Parameters:

championId - the champ id

Returns:

ChampDto single champion dto

Throws:

HttpException - non 2XX response code returned

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