org.dc.riot.lol.rx.service

Interface RiotApi.FeaturedGames

All Superinterfaces:

RiotApi

Enclosing interface:

RiotApi

public static interface RiotApi.FeaturedGames
extends RiotApi

Gain access to the featured games that appear on the main client page

Since:

1.0.0

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
FeaturedGamesDto	getFeaturedGames() /observer-mode/rest/featured 403 Forbidden 429 Rate limit exceeded
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

getFeaturedGames

FeaturedGamesDto getFeaturedGames()
                           throws java.io.IOException,
                                  HttpException

/observer-mode/rest/featured

403 Forbidden
429 Rate limit exceeded

Returns:

RiotApi.FeaturedGames object with all the featured games for the Region queried against or null if some network error occurred

Throws:

HttpException - non 2XX response code returned

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