Struct riven::endpoints::MatchV4

pub struct MatchV4<'a> { /* fields omitted */ }

MatchV4 endpoints handle, accessed by calling match_v4() on a RiotApi instance.

Riot Developer API Reference

match-v4

Note: this struct is automatically generated.

Methods

impl<'a> MatchV4<'a>

pub fn get_match_ids_by_tournament_code(
    &self,
    region: Region,
    tournament_code: &str
) -> impl Future<Output = Result<Vec<i64>>> + 'a

Get match IDs by tournament code.

Parameters

• region - Region to query.
• tournamentCode - The tournament code.

Riot Developer API Reference

match-v4.getMatchIdsByTournamentCode

Note: this method is automatically generated.

pub fn get_match(
    &self,
    region: Region,
    match_id: i64
) -> impl Future<Output = Result<Option<Match>>> + 'a

Get match by match ID.

Parameters

• region - Region to query.
• matchId - The match ID.

Riot Developer API Reference

match-v4.getMatch

Note: this method is automatically generated.

pub fn get_match_by_tournament_code(
    &self,
    region: Region,
    match_id: i64,
    tournament_code: &str
) -> impl Future<Output = Result<Match>> + 'a

Get match by match ID and tournament code.

Parameters

• region - Region to query.
• tournamentCode - The tournament code.
• matchId - The match ID.

Riot Developer API Reference

match-v4.getMatchByTournamentCode

Note: this method is automatically generated.

pub fn get_matchlist(
    &self,
    region: Region,
    encrypted_account_id: &str,
    begin_time: Option<i64>,
    begin_index: Option<i32>,
    champion: Option<Vec<Champion>>,
    end_time: Option<i64>,
    end_index: Option<i32>,
    queue: Option<Vec<Queue>>,
    season: Option<Vec<Season>>
) -> impl Future<Output = Result<Option<Matchlist>>> + 'a

Get matchlist for games played on given account ID and platform ID and filtered using given filter parameters, if any.

Implementation Notes

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 account, otherwise, no matches may be returned.

If beginIndex is specified, but not endIndex, then endIndex defaults to beginIndex+100. If endIndex is specified, but not beginIndex, then beginIndex defaults to 0. If both are specified, then endIndex must be greater than beginIndex. The maximum range allowed is 100, otherwise a 400 error code is returned.

If beginTime is specified, but not endTime, then endTime defaults to the the current unix timestamp in milliseconds (the maximum time range limitation is not observed in this specific case). If endTime is specified, but not beginTime, then beginTime defaults to the start of the account's match history returning a 400 due to the maximum time range limitation. If both are specified, then endTime should be greater than beginTime. The maximum time range allowed is one week, otherwise a 400 error code is returned.

Parameters

• region - Region to query.
• encryptedAccountId - The account ID.
• champion (optional) - Set of champion IDs for filtering the matchlist.
• queue (optional) - Set of queue IDs for filtering the matchlist.
• season (optional) - Set of season IDs for filtering the matchlist.
• endTime (optional) - The end time to use for filtering matchlist specified as epoch milliseconds. If beginTime is specified, but not endTime, then endTime defaults to the the current unix timestamp in milliseconds (the maximum time range limitation is not observed in this specific case). If endTime is specified, but not beginTime, then beginTime defaults to the start of the account's match history returning a 400 due to the maximum time range limitation. If both are specified, then endTime should be greater than beginTime. The maximum time range allowed is one week, otherwise a 400 error code is returned.
• beginTime (optional) - The begin time to use for filtering matchlist specified as epoch milliseconds. If beginTime is specified, but not endTime, then endTime defaults to the the current unix timestamp in milliseconds (the maximum time range limitation is not observed in this specific case). If endTime is specified, but not beginTime, then beginTime defaults to the start of the account's match history returning a 400 due to the maximum time range limitation. If both are specified, then endTime should be greater than beginTime. The maximum time range allowed is one week, otherwise a 400 error code is returned.
• endIndex (optional) - The end index to use for filtering matchlist. If beginIndex is specified, but not endIndex, then endIndex defaults to beginIndex+100. If endIndex is specified, but not beginIndex, then beginIndex defaults to 0. If both are specified, then endIndex must be greater than beginIndex. The maximum range allowed is 100, otherwise a 400 error code is returned.
• beginIndex (optional) - The begin index to use for filtering matchlist. If beginIndex is specified, but not endIndex, then endIndex defaults to beginIndex+100. If endIndex is specified, but not beginIndex, then beginIndex defaults to 0. If both are specified, then endIndex must be greater than beginIndex. The maximum range allowed is 100, otherwise a 400 error code is returned.

Riot Developer API Reference

match-v4.getMatchlist

Note: this method is automatically generated.

pub fn get_match_timeline(
    &self,
    region: Region,
    match_id: i64
) -> impl Future<Output = Result<Option<MatchTimeline>>> + 'a

Get match timeline by match ID.

Implementation Notes

Not all matches have timeline data.

Parameters

• region - Region to query.
• matchId - The match ID.

Riot Developer API Reference

match-v4.getMatchTimeline

Note: this method is automatically generated.