org.dc.riot.lol.rx.service

Interface RiotApi.StaticData

All Superinterfaces:

RiotApi

Enclosing interface:

RiotApi

public static interface RiotApi.StaticData
extends RiotApi

Static data on champion stats, items, gold, runes, masteries, etc. all served up on a per patch basis

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
ChampionDto	getChampion(long champId, java.lang.String version, java.lang.String locale, ChampDataTag... champData) /api/lol/static-data/{region}/v1.2/champion/{id} 400 Bad request 401 Unauthorized 404 Champion not found, bad champId 500 Internal server error 503 Service unavailable
ChampionListDto	getChampions(boolean dataById, java.lang.String version, java.lang.String locale, ChampListDataTag... champData) /api/lol/static-data/{region}/v1.2/champion 400 Bad request 401 Unauthorized 500 Internal server error 503 Service unavailable
ItemDto	getItem(long itemId, java.lang.String version, java.lang.String locale, ItemDataTag... itemData) /api/lol/static-data/{region}/v1.2/item/{id} 400 Bad request 401 Unauthorized 404 Item id not found 500 Internal server error 503 Service unavailable
ItemListDto	getItems(java.lang.String version, java.lang.String locale, ItemListDataTag... itemListData) /api/lol/static-data/{region}/v1.2/item 400 Bad request 401 Unauthorized 500 Internal server error 503 Service unavailable
LanguageStringsDto	getLanguageStrings(java.lang.String version, java.lang.String locale) /api/lol/static-data/{region}/v1.2/language-strings 400 Bad request 401 Unauthorized 500 Internal server error 503 Service unavailable
java.lang.String[]	getLocales() /api/lol/static-data/{region}/v1.2/languages Gets language strings 400 Bad request 401 Unauthorized 500 Internal server error 503 Service unavailable
MapDataDto	getMap(java.lang.String version, java.lang.String locale) /api/lol/static-data/{region}/v1.2/map 400 Bad request 401 Unauthorized 500 Internal server error 503 Service unavailable
MasteryListDto	getMasteries(java.lang.String version, java.lang.String locale, MasteryListDataTag... masteryListData) /api/lol/static-data/{region}/v1.2/mastery 400 Bad request 401 Unauthorized 500 Internal server error 503 Service unavailable
MasteryDto	getMastery(long id, java.lang.String version, java.lang.String locale, MasteryDataTag... masteryData) /api/lol/static-data/{region}/v1.2/mastery/{id} 400 Bad request 401 Unauthorized 404 Mastery data not found 500 Internal server error 503 Service unavailable
default RiotApi.RateType	getRateType()
RealmDto	getRealm() /api/lol/static-data/{region}/v1.2/realm 400 Bad request 401 Unauthorized 500 Internal server error 503 Service unavailable
RuneDto	getRune(long id, java.lang.String version, java.lang.String locale, RuneDataTag... runeData) /api/lol/static-data/na/v1.2/rune/{id} 400 Bad request 401 Unauthorized 403 Forbidden 404 Rune data not found 500 Internal server error 503 Service unavailable
RuneListDto	getRunes(java.lang.String version, java.lang.String locale, RuneListDataTag... runeListData) /api/lol/static-data/na/v1.2/rune 400 Bad request 401 Unauthorized 500 Internal server error 503 Service unavailable
SummonerSpellDto	getSummonerSpell(long id, java.lang.String version, java.lang.String locale, SpellDataTag... spellData) /api/lol/static-data/{region}/v1.2/summoner-spell/{id} 400 Bad request 401 Unauthorized 404 Summoner spell data not found 500 Internal server error 503 Service unavailable
SummonerSpellListDto	getSummonerSpells(boolean dataById, java.lang.String version, java.lang.String locale, SpellDataTag... spellData) /api/lol/static-data/{region}/v1.2/summoner-spell 400 Bad request 401 Unauthorized 500 Internal server error 503 Service unavailable
static Region[]	getSupportedRegions(float version)
java.lang.String[]	getVersions() /api/lol/static-data/{region}/v1.2/versions 401 Unauthorized 500 Internal server error 503 Service unavailable

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

getApiKey, 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

getRateType

default RiotApi.RateType getRateType()

Specified by:

getRateType in interface RiotApi

Returns:

the RiotApi.RateType that this RiotApi instance operates under

getChampions

ChampionListDto getChampions(boolean dataById,
                             java.lang.String version,
                             java.lang.String locale,
                             ChampListDataTag... champData)
                      throws java.io.IOException,
                             HttpException

/api/lol/static-data/{region}/v1.2/champion

400 Bad request
401 Unauthorized
500 Internal server error
503 Service unavailable

Parameters:

dataById - If specified as true, the returned data map will use the champions' IDs as the keys. If not specified or specified as false, the returned data map will use the champions' keys instead.

version - patch to reference, null will use latest patch

locale - locale String (e.g. en_US) null will use default for region

champData - Champ data tags to retrieve. Only id, key, name, and title are returned by default if this parameter isn't specified, null is ok

Returns:

a ChampionDto object with requested data filled in or null if no champion could be found matching the given query

Throws:

HttpException - non 2XX response code returned

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

getChampion

ChampionDto getChampion(long champId,
                        java.lang.String version,
                        java.lang.String locale,
                        ChampDataTag... champData)
                 throws java.io.IOException,
                        HttpException

/api/lol/static-data/{region}/v1.2/champion/{id}

400 Bad request
401 Unauthorized
404 Champion not found, bad champId
500 Internal server error
503 Service unavailable

Parameters:

champId - the champion ID

version - patch to reference, null will use latest patch

locale - locale String (e.g. en_US) null will use default for region

champData - Champ data tags to retrieve. Only id, key, name, and title are returned by default if this parameter isn't specified, null is ok

Returns:

a ChampionDto object with requested data filled in or null if no champion could be found matching the given query

Throws:

HttpException - non 2XX response code returned

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

getItems

ItemListDto getItems(java.lang.String version,
                     java.lang.String locale,
                     ItemListDataTag... itemListData)
              throws java.io.IOException,
                     HttpException

/api/lol/static-data/{region}/v1.2/item

400 Bad request
401 Unauthorized
500 Internal server error
503 Service unavailable

Parameters:

version - patch to reference, null will use latest patch

locale - locale String (e.g. en_US) null will use default for region

itemListData - Tags to return additional data. Only type, version, basic, data, id, name, plaintext, group, and description are returned by default if this parameter isn't specified. To return all additional data, use the tag 'all'.

Returns:

ItemListDto filled in

Throws:

HttpException - non 2XX response code returned

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

getItem

ItemDto getItem(long itemId,
                java.lang.String version,
                java.lang.String locale,
                ItemDataTag... itemData)
         throws java.io.IOException,
                HttpException

/api/lol/static-data/{region}/v1.2/item/{id}

400 Bad request
401 Unauthorized
404 Item id not found
500 Internal server error
503 Service unavailable

Parameters:

itemId - item id to fetch

version - patch to reference, null will use latest patch

locale - locale String (e.g. en_US) null will use default for region

itemData - Tags to return additional data. Only id, name, plaintext, group, and description are returned by default if this parameter isn't specified. To return all additional data, use the tag 'all'.

Returns:

ItemListDto filled in according to itemListData

Throws:

HttpException - non 2XX response code returned

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

getLanguageStrings

LanguageStringsDto getLanguageStrings(java.lang.String version,
                                      java.lang.String locale)
                               throws java.io.IOException,
                                      HttpException

/api/lol/static-data/{region}/v1.2/language-strings

400 Bad request
401 Unauthorized
500 Internal server error
503 Service unavailable

Parameters:

version - patch to reference, null will use latest patch

locale - locale String (e.g. en_US) null will use default for region

Returns:

LanguageStringsDto

Throws:

HttpException - non 2XX response code returned

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

getLocales

java.lang.String[] getLocales()
                       throws java.io.IOException,
                              HttpException

/api/lol/static-data/{region}/v1.2/languages

Gets language strings

400 Bad request
401 Unauthorized
500 Internal server error
503 Service unavailable

Returns:

String array of all supported locales

Throws:

HttpException - non 2XX response code returned

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

getMap

MapDataDto getMap(java.lang.String version,
                  java.lang.String locale)
           throws java.io.IOException,
                  HttpException

/api/lol/static-data/{region}/v1.2/map

400 Bad request
401 Unauthorized
500 Internal server error
503 Service unavailable

Parameters:

version - patch to reference, null will use latest patch

locale - locale String (e.g. en_US) null will use default for region

Returns:

MapDataDto object

Throws:

HttpException - non 2XX response code returned

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

getMasteries

MasteryListDto getMasteries(java.lang.String version,
                            java.lang.String locale,
                            MasteryListDataTag... masteryListData)
                     throws java.io.IOException,
                            HttpException

/api/lol/static-data/{region}/v1.2/mastery

400 Bad request
401 Unauthorized
500 Internal server error
503 Service unavailable

Parameters:

version - patch to reference, null will use latest patch

locale - locale String (e.g. en_US) null will use default for region

masteryListData - Tags to return additional data. Only type, version, data, id, name, and description are returned by default if this parameter isn't specified. To return all additional data, use the tag 'all'.

Returns:

MasteryListDto filled in according to tags

Throws:

HttpException - non 2XX response code returned

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

getMastery

MasteryDto getMastery(long id,
                      java.lang.String version,
                      java.lang.String locale,
                      MasteryDataTag... masteryData)
               throws java.io.IOException,
                      HttpException

/api/lol/static-data/{region}/v1.2/mastery/{id}

400 Bad request
401 Unauthorized
404 Mastery data not found
500 Internal server error
503 Service unavailable

Parameters:

id - mastery id

version - patch to reference, null will use latest patch

locale - locale String (e.g. en_US) null will use default for region

masteryData - Tags to return additional data. Only id, name, and description are returned by default if this parameter isn't specified. To return all additional data, use the tag 'all'.

Returns:

MasteryDto filled in according to tags

Throws:

HttpException - non 2XX response code returned

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

getRealm

RealmDto getRealm()
           throws java.io.IOException,
                  HttpException

/api/lol/static-data/{region}/v1.2/realm

400 Bad request
401 Unauthorized
500 Internal server error
503 Service unavailable

Returns:

RealmDto object

Throws:

HttpException - non 2XX response code returned

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

getRunes

RuneListDto getRunes(java.lang.String version,
                     java.lang.String locale,
                     RuneListDataTag... runeListData)
              throws java.io.IOException,
                     HttpException

/api/lol/static-data/na/v1.2/rune

400 Bad request
401 Unauthorized
500 Internal server error
503 Service unavailable

Parameters:

version - patch to reference, null will use latest patch

locale - locale String (e.g. en_US) null will use default for region

runeListData - Tags to return additional data. Only type, version, data, id, name, rune, and description are returned by default if this parameter isn't specified. To return all additional data, use the tag 'all'.

Returns:

RuneListDto object filled in according to tags

Throws:

HttpException - non 2XX response code returned

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

getRune

RuneDto getRune(long id,
                java.lang.String version,
                java.lang.String locale,
                RuneDataTag... runeData)
         throws java.io.IOException,
                HttpException

/api/lol/static-data/na/v1.2/rune/{id}

400 Bad request
401 Unauthorized
403 Forbidden
404 Rune data not found
500 Internal server error
503 Service unavailable

Parameters:

id - rune id to query

version - patch to reference, null will use latest patch

locale - locale String (e.g. en_US) null will use default for region

runeData - Tags to return additional data. Only id, name, rune, and description are returned by default if this parameter isn't specified. To return all additional data, use the tag 'ALL'.

Returns:

RuneListDto object filled in according to tags

Throws:

HttpException - non 2XX response code returned

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

getSummonerSpells

SummonerSpellListDto getSummonerSpells(boolean dataById,
                                       java.lang.String version,
                                       java.lang.String locale,
                                       SpellDataTag... spellData)
                                throws java.io.IOException,
                                       HttpException

/api/lol/static-data/{region}/v1.2/summoner-spell

400 Bad request
401 Unauthorized
500 Internal server error
503 Service unavailable

Parameters:

dataById - If specified as true, the returned data map will use the spells' IDs as the keys. If not specified or specified as false, the returned data map will use the spells' keys instead.

version - patch to reference, null will use latest patch

locale - locale String (e.g. en_US) null will use default for region

spellData - Tags to return additional data. Only type, version, data, id, key, name, description, and summonerLevel are returned by default if this parameter isn't specified. To return all additional data, use the tag 'ALL'.

Returns:

SummonerSpellListDto object filled in according to tags

Throws:

HttpException - non 2XX response code returned

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

getSummonerSpell

SummonerSpellDto getSummonerSpell(long id,
                                  java.lang.String version,
                                  java.lang.String locale,
                                  SpellDataTag... spellData)
                           throws java.io.IOException,
                                  HttpException

/api/lol/static-data/{region}/v1.2/summoner-spell/{id}

400 Bad request
401 Unauthorized
404 Summoner spell data not found
500 Internal server error
503 Service unavailable

Parameters:

id - summoner spell ID

version - patch to reference, null will use latest patch

locale - locale String (e.g. en_US) null will use default for region

spellData - Tags to return additional data. Only type, version, data, id, key, name, description, and summonerLevel are returned by default if this parameter isn't specified. To return all additional data, use the tag 'ALL'.

Returns:

SummonerSpellDto object filled in according to tags

Throws:

HttpException - non 2XX response code returned

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

getVersions

java.lang.String[] getVersions()
                        throws java.io.IOException,
                               HttpException

/api/lol/static-data/{region}/v1.2/versions

401 Unauthorized
500 Internal server error
503 Service unavailable

Returns:

String array with every patch arranged from newest at [0] to oldest at [length - 1]

Throws:

HttpException - non 2XX response code returned

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