org.dc.riot.lol.rx.service

Interface RiotApi.Match

All Superinterfaces:

RiotApi

Enclosing interface:

RiotApi

public static interface RiotApi.Match
extends RiotApi

This interface is closely related to the RiotApi.MatchList interface. Retrieves very detailed statistics for specified matches.

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
MatchDetail	getMatch(long matchId, boolean includeTimeline) /api/lol/{region}/v2.2/match/{matchId} 400 Bad request 401 Unauthorized 404 Match 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

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

getMatch

MatchDetail getMatch(long matchId,
                     boolean includeTimeline)
              throws java.io.IOException,
                     HttpException

/api/lol/{region}/v2.2/match/{matchId}

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

Parameters:

matchId - RiotApi.MatchList interface to get valid match IDs

includeTimeline - Attempt to include timeline data. Not all matches have timeline data associated with them.

Returns:

a MatchDetail

Throws:

HttpException - non 2XX response code returned

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