org.dc.riot.lol.rx.service

Interface RiotApi

All Known Subinterfaces:

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

All Known Implementing Classes:

CurrentGame_v1_0

public interface RiotApi

Basic organization structure for all Riot APIs. Creating instances of the sub-interfaces of this interface and calling their methods will retrieve data from the LoL API. Riot Developer Site

Since:

1.0.0

See Also:

ApiFactory

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	RiotApi.Champion Not for stats.
static interface	RiotApi.ChampionMastery Champion mastery API to fetch player's champion mastery.
static interface	RiotApi.CurrentGame Spectator details
static interface	RiotApi.FeaturedGames Gain access to the featured games that appear on the main client page
static interface	RiotApi.League Retrieves data about players' leagues.
static interface	RiotApi.LolStatus Get statuses of servers.
static interface	RiotApi.Match This interface is closely related to the RiotApi.MatchList interface.
static interface	RiotApi.MatchList Interface to allow search of matches by Summoner ID.
static class	RiotApi.RateType Rate type enumeration.
static interface	RiotApi.RecentGames Get recent game data on specific players
static interface	RiotApi.StaticData Static data on champion stats, items, gold, runes, masteries, etc.
static interface	RiotApi.Stats Get player performance statistics.
static interface	RiotApi.Summoner Interface for retrieving data on individual players.
static interface	RiotApi.Team Fetch player teams

Method Summary

Modifier and Type	Method and Description
ApiKey	getApiKey()
default RiotApi.RateType	getRateType()
Region	getRegion()
float	getVersion()
void	setAutoRetry(boolean autoRetry)
void	setPrintUrl(boolean print)
void	setProxy(java.net.Proxy proxy)
void	setRateControl(boolean control) Enable or disable rate throttling.
void	setRetryCount(int retryCount)

Method Detail

getRateType

default RiotApi.RateType getRateType()

Returns:

the RiotApi.RateType that this RiotApi instance operates under

getRegion

Region getRegion()

Returns:

the Region that this RiotApi instance is set to query against

getApiKey

ApiKey getApiKey()

Returns:

the ApiKey this RiotApi instance is using

getVersion

float getVersion()

Returns:

the version of this RiotApi instance

setRateControl

void setRateControl(boolean control)

Enable or disable rate throttling.

Parameters:

control - turn on / off rate controlling

setProxy

void setProxy(java.net.Proxy proxy)

Parameters:

proxy - Proxy for http requests

setAutoRetry

void setAutoRetry(boolean autoRetry)

Parameters:

autoRetry - whether this RiotApi instance should automatically retry failed requests

setRetryCount

void setRetryCount(int retryCount)

Parameters:

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

setPrintUrl

void setPrintUrl(boolean print)

Parameters:

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