org.dc.riot.lol.rx.service

Interface RiotApi.CurrentGame

All Superinterfaces:

RiotApi

All Known Implementing Classes:

CurrentGame_v1_0

Enclosing interface:

RiotApi

public static interface RiotApi.CurrentGame
extends RiotApi

Spectator details

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
CurrentGameInfo	getSpectatorInfo(long summonerId) /observer-mode/rest/consumer/getSpectatorGameInfo/{platformId}/{summonerId} 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

getSpectatorInfo

CurrentGameInfo getSpectatorInfo(long summonerId)
                          throws java.io.IOException,
                                 HttpException

/observer-mode/rest/consumer/getSpectatorGameInfo/{platformId}/{summonerId}

403 Forbidden
429 Rate limit exceeded

Parameters:

summonerId - summoner id number

Returns:

CurrentGameInfo object

Throws:

HttpException - non 2XX response code returned

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