org.dc.riot.lol.rx.service

Interface RiotApi.MatchList

All Superinterfaces:

RiotApi

Enclosing interface:

RiotApi

public static interface RiotApi.MatchList
extends RiotApi

Interface to allow search of matches by Summoner ID. This interface is closely related to the RiotApi.Match interface.

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
MatchListDto	getMatchList(long summonerId, long[] championIds, RankedQueue[] rankedQueues, Season[] seasons, long beginTime, long endTime, int beginIndex, int endIndex) /api/lol/{region}/v2.2/matchlist/by-summoner/{summonerId} A number of optional parameters are provided for filtering.
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

getMatchList

MatchListDto getMatchList(long summonerId,
                          long[] championIds,
                          RankedQueue[] rankedQueues,
                          Season[] seasons,
                          long beginTime,
                          long endTime,
                          int beginIndex,
                          int endIndex)
                   throws java.io.IOException,
                          HttpException

/api/lol/{region}/v2.2/matchlist/by-summoner/{summonerId}

A number of optional parameters are provided for filtering. It is up to the caller to ensure that the combination of filter parameters provided is valid for the requested summoner, otherwise, no matches may be returned. If either of the beginTime or endTime parameters is set, they must both be set, although there is no maximum limit on their range. If the beginTime parameter is specified on its own, endTime is assumed to be the current time. If the endTime parameter is specified on its own, beginTime is assumed to be the start of the summoner's match history.

400 Bad request
401 Unauthorized
404 Game not found
422 Summoner has an entry, but hasn't played since the start of 2013
429 Rate limit exceeded
500 Internal server error
503 Service unavailable

Parameters:

summonerId - ID of summoner to search. See the RiotApi.Summoner interface for valid IDs.

championIds - Optional. ID(s) to search; null is ok.

rankedQueues - Optional. Ranked queues to search.

seasons - Optional. Seasons to search.

beginTime - Optional. Specify -1 for no value.

endTime - Optional. Specify -1 for no value.

beginIndex - Optional. Specify -1 for no value.

endIndex - Optional. Specify -1 for no value.

Returns:

MatchListDto

Throws:

HttpException - non 2XX response code returned

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