godfist v0.2.2 Godfist.Match
Module to interact with the match endpoint.
Link to this section Summary
Functions
Get match information by match id
Get matchlist for a ranked game played for an account id and region filtering with a given set of options
Get the last 20 matches of a given player
Get match timeline by match id
Get match ids by tournament code
Get match by match id a tournament code
Link to this section Functions
Link to this function
get_match(region, matchid)
get_match(atom, integer) :: {:ok, map} | {:error, String.t}
Get match information by match id.
Example
iex> Godfist.Match.get_match(:oce, matchid)
Link to this function
matchlist(region, id, opts \\ [])
Get matchlist for a ranked game played for an account id and region filtering with a given set of options.
Options are:
:begin_time
, The begin time to use for filtering matchlist specified as epoch miliseconds.:queue
, Set of given queue IDs for which to filtering matchlist.end_index
, The end index to use for filtering matchlist.:season
, Set of season IDs for which to filtering matchlist.:champion
, Id of champion to filter matchlist.:begin_index
, The begin index to use for filtering matchlist.:end_time
, The end time to use for filtering matchlist specified by epoch miliseconds.
Example
iex> Godfist.Match.matchlist(:lan, summid, [champion: 64, queue: 420])
Link to this function
timeline(region, id)
timeline(atom, integer) :: {:ok, map} | {:error, String.t}
Get match timeline by match id.
Example
Godfist.Match.timeline(:na, matchid)
Link to this function
tournament_by_code(region, tournament_id)
tournament_by_code(atom, integer) :: {:ok, map} | {:error, String.t}
Get match ids by tournament code.
Example
iex> Godfist.Match.tournament_by_code(:oce, tournament_id)
Link to this function
tournament_by_match(region, match_id, tournament_id)
tournament_by_match(atom, integer, integer) :: {:ok, map} | {:error, String.t}
Get match by match id a tournament code.
Example
iex> Godfist.Match.tournament_by_match(:euw, matchid, tournament_id)