org.dc.riot.lol.rx.service

Interface RiotApi.LolStatus

All Superinterfaces:

RiotApi

Enclosing interface:

RiotApi

public static interface RiotApi.LolStatus
extends RiotApi

Get statuses of servers. API calls to this endpoint do not count against rate limit

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
ShardStatus	getShard() /shards/{region} Get shard status.
Shard[]	getShards() /shards Most useful for finding which locales are supported on which servers 403 Forbidden
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

getShards

Shard[] getShards()
           throws java.io.IOException,
                  HttpException

/shards

Most useful for finding which locales are supported on which servers

403 Forbidden

Returns:

Array of Shard statuses

Throws:

HttpException - non 2XX response code returned

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

getShard

ShardStatus getShard()
              throws java.io.IOException,
                     HttpException

/shards/{region}

Get shard status. Returns the data available on the status.leagueoflegends.com website for the given region.

403 Forbidden

Returns:

a ShardStatus for the specified Region

Throws:

HttpException - non 2XX response code returned

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