Class MatchV4Endpoints

MatchV4 endpoints. This class is automatically generated.

Official API Reference https://developer.riotgames.com/api-methods/#match-v4

Inheritance

System.Object

Endpoints

MatchV4Endpoints

Inherited Members

Endpoints.QUERY_PARAMS_EMPTY

Endpoints.RiotApi

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: MingweiSamuel.Camille

Assembly: Camille.dll

Syntax

public class MatchV4Endpoints : Endpoints

Methods

| Improve this Doc View Source

GetMatch(Region, Int64, Nullable<CancellationToken>)

Get match by match ID.

Official API Reference: https://developer.riotgames.com/api-methods/#match-v4/GET_getMatch

Declaration

public Match GetMatch(Region region, long matchId, CancellationToken? cancellationToken = default(CancellationToken? ))

Parameters

Type	Name	Description
Region	region	Region to query.
System.Int64	matchId	The match ID. (required)
System.Nullable<System.Threading.CancellationToken>	cancellationToken	A cancellation token that can be used to cancel this task.

Returns

Type	Description
Match

| Improve this Doc View Source

GetMatchAsync(Region, Int64, Nullable<CancellationToken>)

Get match by match ID.

Official API Reference: https://developer.riotgames.com/api-methods/#match-v4/GET_getMatch

Declaration

public Task<Match> GetMatchAsync(Region region, long matchId, CancellationToken? cancellationToken = default(CancellationToken? ))

Parameters

Type	Name	Description
Region	region	Region to query.
System.Int64	matchId	The match ID. (required)
System.Nullable<System.Threading.CancellationToken>	cancellationToken	A cancellation token that can be used to cancel this task.

Returns

Type	Description
System.Threading.Tasks.Task<Match>

| Improve this Doc View Source

GetMatchByTournamentCode(Region, Int64, String, Nullable<CancellationToken>)

Get match by match ID and tournament code.

Official API Reference: https://developer.riotgames.com/api-methods/#match-v4/GET_getMatchByTournamentCode

Declaration

public Match GetMatchByTournamentCode(Region region, long matchId, string tournamentCode, CancellationToken? cancellationToken = default(CancellationToken? ))

Parameters

Type	Name	Description
Region	region	Region to query.
System.Int64	matchId	The match ID. (required)
System.String	tournamentCode	The tournament code. (required)
System.Nullable<System.Threading.CancellationToken>	cancellationToken	A cancellation token that can be used to cancel this task.

Returns

Type	Description
Match

| Improve this Doc View Source

GetMatchByTournamentCodeAsync(Region, Int64, String, Nullable<CancellationToken>)

Get match by match ID and tournament code.

Official API Reference: https://developer.riotgames.com/api-methods/#match-v4/GET_getMatchByTournamentCode

Declaration

public Task<Match> GetMatchByTournamentCodeAsync(Region region, long matchId, string tournamentCode, CancellationToken? cancellationToken = default(CancellationToken? ))

Parameters

Type	Name	Description
Region	region	Region to query.
System.Int64	matchId	The match ID. (required)
System.String	tournamentCode	The tournament code. (required)
System.Nullable<System.Threading.CancellationToken>	cancellationToken	A cancellation token that can be used to cancel this task.

Returns

Type	Description
System.Threading.Tasks.Task<Match>

| Improve this Doc View Source

GetMatchIdsByTournamentCode(Region, String, Nullable<CancellationToken>)

Get match IDs by tournament code.

Official API Reference: https://developer.riotgames.com/api-methods/#match-v4/GET_getMatchIdsByTournamentCode

Declaration

public long[] GetMatchIdsByTournamentCode(Region region, string tournamentCode, CancellationToken? cancellationToken = default(CancellationToken? ))

Parameters

Type	Name	Description
Region	region	Region to query.
System.String	tournamentCode	The tournament code. (required)
System.Nullable<System.Threading.CancellationToken>	cancellationToken	A cancellation token that can be used to cancel this task.

Returns

Type	Description
System.Int64[]

| Improve this Doc View Source

GetMatchIdsByTournamentCodeAsync(Region, String, Nullable<CancellationToken>)

Get match IDs by tournament code.

Official API Reference: https://developer.riotgames.com/api-methods/#match-v4/GET_getMatchIdsByTournamentCode

Declaration

public Task<long[]> GetMatchIdsByTournamentCodeAsync(Region region, string tournamentCode, CancellationToken? cancellationToken = default(CancellationToken? ))

Parameters

Type	Name	Description
Region	region	Region to query.
System.String	tournamentCode	The tournament code. (required)
System.Nullable<System.Threading.CancellationToken>	cancellationToken	A cancellation token that can be used to cancel this task.

Returns

Type	Description
System.Threading.Tasks.Task<System.Int64[]>

| Improve this Doc View Source

GetMatchlist(Region, String, Int32[], Int32[], Int32[], Nullable<Int64>, Nullable<Int64>, Nullable<Int32>, Nullable<Int32>, Nullable<CancellationToken>)

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.

Official API Reference: https://developer.riotgames.com/api-methods/#match-v4/GET_getMatchlist

Declaration

public Matchlist GetMatchlist(Region region, string encryptedAccountId, int[] champion = null, int[] queue = null, int[] season = null, long? endTime = default(long? ), long? beginTime = default(long? ), int? endIndex = default(int? ), int? beginIndex = default(int? ), CancellationToken? cancellationToken = default(CancellationToken? ))

Parameters

Type	Name	Description
Region	region	Region to query.
System.String	encryptedAccountId	The account ID. (required)
System.Int32[]	champion	Set of champion IDs for filtering the matchlist. (optional)
System.Int32[]	queue	Set of queue IDs for filtering the matchlist. (optional)
System.Int32[]	season	Set of season IDs for filtering the matchlist. (optional)
System.Nullable<System.Int64>	endTime	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. (optional)
System.Nullable<System.Int64>	beginTime	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. (optional)
System.Nullable<System.Int32>	endIndex	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. (optional)
System.Nullable<System.Int32>	beginIndex	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. (optional)
System.Nullable<System.Threading.CancellationToken>	cancellationToken	A cancellation token that can be used to cancel this task.

Returns

Type	Description
Matchlist

| Improve this Doc View Source

GetMatchlistAsync(Region, String, Int32[], Int32[], Int32[], Nullable<Int64>, Nullable<Int64>, Nullable<Int32>, Nullable<Int32>, Nullable<CancellationToken>)

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

Implementation Notes

Official API Reference: https://developer.riotgames.com/api-methods/#match-v4/GET_getMatchlist

Declaration

public Task<Matchlist> GetMatchlistAsync(Region region, string encryptedAccountId, int[] champion = null, int[] queue = null, int[] season = null, long? endTime = default(long? ), long? beginTime = default(long? ), int? endIndex = default(int? ), int? beginIndex = default(int? ), CancellationToken? cancellationToken = default(CancellationToken? ))

Parameters

Type	Name	Description
Region	region	Region to query.
System.String	encryptedAccountId	The account ID. (required)
System.Int32[]	champion	Set of champion IDs for filtering the matchlist. (optional)
System.Int32[]	queue	Set of queue IDs for filtering the matchlist. (optional)
System.Int32[]	season	Set of season IDs for filtering the matchlist. (optional)
System.Nullable<System.Int64>	endTime	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. (optional)
System.Nullable<System.Int64>	beginTime	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. (optional)
System.Nullable<System.Int32>	endIndex	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. (optional)
System.Nullable<System.Int32>	beginIndex	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. (optional)
System.Nullable<System.Threading.CancellationToken>	cancellationToken	A cancellation token that can be used to cancel this task.

Returns

Type	Description
System.Threading.Tasks.Task<Matchlist>

| Improve this Doc View Source

GetMatchTimeline(Region, Int64, Nullable<CancellationToken>)

Get match timeline by match ID.

Implementation Notes

Not all matches have timeline data.

Official API Reference: https://developer.riotgames.com/api-methods/#match-v4/GET_getMatchTimeline

Declaration

public MatchTimeline GetMatchTimeline(Region region, long matchId, CancellationToken? cancellationToken = default(CancellationToken? ))

Parameters

Type	Name	Description
Region	region	Region to query.
System.Int64	matchId	The match ID. (required)
System.Nullable<System.Threading.CancellationToken>	cancellationToken	A cancellation token that can be used to cancel this task.

Returns

Type	Description
MatchTimeline

| Improve this Doc View Source

GetMatchTimelineAsync(Region, Int64, Nullable<CancellationToken>)

Get match timeline by match ID.

Implementation Notes

Not all matches have timeline data.

Official API Reference: https://developer.riotgames.com/api-methods/#match-v4/GET_getMatchTimeline

Declaration

public Task<MatchTimeline> GetMatchTimelineAsync(Region region, long matchId, CancellationToken? cancellationToken = default(CancellationToken? ))

Parameters

Type	Name	Description
Region	region	Region to query.
System.Int64	matchId	The match ID. (required)
System.Nullable<System.Threading.CancellationToken>	cancellationToken	A cancellation token that can be used to cancel this task.

Returns

Type	Description
System.Threading.Tasks.Task<MatchTimeline>