org.dc.riot.lol.rx.service.interfaces

Class CurrentGame_v1_0

java.lang.Object

org.dc.riot.lol.rx.service.interfaces.CurrentGame_v1_0

All Implemented Interfaces:

RiotApi, RiotApi.CurrentGame

public class CurrentGame_v1_0
extends java.lang.Object
implements RiotApi.CurrentGame

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

Field Summary

Fields

Modifier and Type	Field and Description
protected ApiKey	apiKey
protected com.squareup.okhttp.OkHttpClient	client
protected Region	region

Constructor Summary

Constructors

Constructor and Description
CurrentGame_v1_0(ApiKey apiKey, Region region)

Method Summary

Modifier and Type	Method and Description
ApiKey	getApiKey()
Region	getRegion()
CurrentGameInfo	getSpectatorInfo(long summonerId) /observer-mode/rest/consumer/getSpectatorGameInfo/{platformId}/{summonerId} 403 Forbidden 429 Rate limit exceeded
float	getVersion()
void	setAutoRetry(boolean autoRetry)
void	setPrintUrl(boolean printUrls)
void	setProxy(java.net.Proxy proxy)
void	setRateControl(boolean control) Enable or disable rate throttling.
void	setRetryCount(int retryCount)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getSupportedRegions

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

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

Field Detail

apiKey

protected final ApiKey apiKey

region

protected final Region region

client

protected final com.squareup.okhttp.OkHttpClient client

Constructor Detail

CurrentGame_v1_0

public CurrentGame_v1_0(ApiKey apiKey,
                        Region region)

Method Detail

getVersion

public float getVersion()

Specified by:

getVersion in interface RiotApi

Returns:

the version of this RiotApi instance

getSpectatorInfo

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

Description copied from interface: RiotApi.CurrentGame

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

403 Forbidden
429 Rate limit exceeded

Specified by:

getSpectatorInfo in interface RiotApi.CurrentGame

Parameters:

summonerId - summoner id number

Returns:

CurrentGameInfo object

Throws:

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

HttpException - non 2XX response code returned

getRegion

public Region getRegion()

Specified by:

getRegion in interface RiotApi

Returns:

the Region that this RiotApi instance is set to query against

getApiKey

public ApiKey getApiKey()

Specified by:

getApiKey in interface RiotApi

Returns:

the ApiKey this RiotApi instance is using

setProxy

public void setProxy(java.net.Proxy proxy)

Specified by:

setProxy in interface RiotApi

Parameters:

proxy - Proxy for http requests

setPrintUrl

public void setPrintUrl(boolean printUrls)

Specified by:

setPrintUrl in interface RiotApi

Parameters:

printUrls - turn off/on URL printing. Mainly for debugging

setAutoRetry

public void setAutoRetry(boolean autoRetry)

Specified by:

setAutoRetry in interface RiotApi

Parameters:

autoRetry - whether this RiotApi instance should automatically retry failed requests

setRetryCount

public void setRetryCount(int retryCount)

Specified by:

setRetryCount in interface RiotApi

Parameters:

retryCount - number of automatic retries to attempt. If RiotApi.setAutoRetry(boolean) is false this this has no effect.

setRateControl

public void setRateControl(boolean control)

Description copied from interface: RiotApi

Enable or disable rate throttling.

Specified by:

setRateControl in interface RiotApi

Parameters:

control - turn on / off rate controlling