org.dc.riot.lol.rx.service

Interface RiotApi.Summoner

All Superinterfaces:

RiotApi

Enclosing interface:

RiotApi

public static interface RiotApi.Summoner
extends RiotApi

Interface for retrieving data on individual players.

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
static java.lang.String	encodeName(java.lang.String name)
java.util.Map<java.lang.String,SummonerDto>	getByAccounts(long... accountIds) /api/lol/{region}/v1.4/summoner/by-account/{accountIds} 400 Bad request 401 Unauthorized 404 No summoner data found for any specified inputs 429 Rate limit exceeded 500 Internal server error 503 Service unavailable
java.util.Map<java.lang.String,SummonerDto>	getByIds(long... summonerIds) /api/lol/{region}/v1.4/summoner/{summonerIds} 400 Bad request 401 Unauthorized 404 Stats data not found 429 Rate limit exceeded 500 Internal server error 503 Service unavailable
java.util.Map<java.lang.String,SummonerDto>	getByNames(java.lang.String... summonerNames) /api/lol/{region}/v1.4/summoner/by-name/{summonerNames} 400 Bad request 401 Unauthorized 404 Stats data not found 429 Rate limit exceeded 500 Internal server error 503 Service unavailable
java.util.Map<java.lang.String,MasteryPagesDto>	getMasteries(long... summonerIds) /api/lol/{region}/v1.4/summoner/{summonerIds}/masteries 400 Bad request 401 Unauthorized 404 Stats data not found 429 Rate limit exceeded 500 Internal server error 503 Service unavailable
java.util.Map<java.lang.String,java.lang.String>	getNames(long... summonerIds) /api/lol/{region}/v1.4/summoner/{summonerIds}/name 400 Bad request 401 Unauthorized 404 Stats data not found 429 Rate limit exceeded 500 Internal server error 503 Service unavailable
java.util.Map<java.lang.String,RunePagesDto>	getRunes(long... summonerIds) /api/lol/{region}/v1.4/summoner/{summonerIds}/runes 400 Bad request 401 Unauthorized 404 Stats data not found 429 Rate limit exceeded 500 Internal server error 503 Service unavailable
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

encodeName

static java.lang.String encodeName(java.lang.String name)

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

getByNames

java.util.Map<java.lang.String,SummonerDto> getByNames(java.lang.String... summonerNames)
                                                throws java.io.IOException,
                                                       HttpException

/api/lol/{region}/v1.4/summoner/by-name/{summonerNames}

400 Bad request
401 Unauthorized
404 Stats data not found
429 Rate limit exceeded
500 Internal server error
503 Service unavailable

Parameters:

summonerNames - array of String names

Returns:

Map of encoded names (name with all lowercase and spaces trimmed) to SummonerDto

Throws:

HttpException - non 2XX response code returned

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

getByAccounts

java.util.Map<java.lang.String,SummonerDto> getByAccounts(long... accountIds)
                                                   throws java.io.IOException,
                                                          HttpException

/api/lol/{region}/v1.4/summoner/by-account/{accountIds}

400 Bad request
401 Unauthorized
404 No summoner data found for any specified inputs
429 Rate limit exceeded
500 Internal server error
503 Service unavailable

Parameters:

accountIds - Comma-separated list of account IDs associated with summoners to retrieve. Maximum allowed at once is 40.

Returns:

Map of summoner data mapped from long Strings to SummonerDto

Throws:

HttpException - non 2XX response code returned

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

getByIds

java.util.Map<java.lang.String,SummonerDto> getByIds(long... summonerIds)
                                              throws java.io.IOException,
                                                     HttpException

/api/lol/{region}/v1.4/summoner/{summonerIds}

400 Bad request
401 Unauthorized
404 Stats data not found
429 Rate limit exceeded
500 Internal server error
503 Service unavailable

Parameters:

summonerIds - List of long IDs

Returns:

Map of summoner IDs mapped from longs to Strings

Throws:

HttpException - non 2XX response code returned

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

getMasteries

java.util.Map<java.lang.String,MasteryPagesDto> getMasteries(long... summonerIds)
                                                      throws java.io.IOException,
                                                             HttpException

/api/lol/{region}/v1.4/summoner/{summonerIds}/masteries

400 Bad request
401 Unauthorized
404 Stats data not found
429 Rate limit exceeded
500 Internal server error
503 Service unavailable

Parameters:

summonerIds - List of long IDs

Returns:

Map of summoner IDs mapped from longs to Strings

Throws:

HttpException - non 2XX response code returned

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

getNames

java.util.Map<java.lang.String,java.lang.String> getNames(long... summonerIds)
                                                   throws java.io.IOException,
                                                          HttpException

/api/lol/{region}/v1.4/summoner/{summonerIds}/name

400 Bad request
401 Unauthorized
404 Stats data not found
429 Rate limit exceeded
500 Internal server error
503 Service unavailable

Parameters:

summonerIds - List of long IDs

Returns:

Map of summoner IDs mapped from longs to Strings

Throws:

HttpException - non 2XX response code returned

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

getRunes

java.util.Map<java.lang.String,RunePagesDto> getRunes(long... summonerIds)
                                               throws java.io.IOException,
                                                      HttpException

/api/lol/{region}/v1.4/summoner/{summonerIds}/runes

400 Bad request
401 Unauthorized
404 Stats data not found
429 Rate limit exceeded
500 Internal server error
503 Service unavailable

Parameters:

summonerIds - List of long IDs

Returns:

Map of summoner IDs mapped from longs to Strings

Throws:

HttpException - non 2XX response code returned

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