Class TournamentV5Endpoints

TournamentV5 endpoints. This class is automatically generated.

Official API Reference https://developer.riotgames.com/api-methods/#tournament-v5

Inheritance
System.Object
Endpoints
TournamentV5Endpoints
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Camille.RiotGames
Assembly: Camille.RiotGames.dll
Syntax
public class TournamentV5Endpoints : Endpoints

Methods

| Improve this Doc View Source

CreateTournamentCode(RegionalRoute, TournamentCodeParametersV5, Int64, Nullable<Int32>, Nullable<CancellationToken>)

Create a tournament code for the given tournament. Official API Reference: https://developer.riotgames.com/api-methods/#tournament-v5/POST_createTournamentCode

Declaration
public string[] CreateTournamentCode(RegionalRoute route, TournamentCodeParametersV5 body, long tournamentId, int? count = null, CancellationToken? cancellationToken = null)
Parameters
Type Name Description
RegionalRoute route

Route to query. Corresponds to a Riot API subdomain for a region or platform. (required)
TournamentCodeParametersV5 body
System.Int64 tournamentId

The tournament ID (required, in query)
System.Nullable<System.Int32> count

The number of codes to create (max 1000) (optional, in query)
System.Nullable<System.Threading.CancellationToken> cancellationToken

A cancellation token that can be used to cancel this task. (optional)
Returns
Type Description
System.String[]
| Improve this Doc View Source

CreateTournamentCodeAsync(RegionalRoute, TournamentCodeParametersV5, Int64, Nullable<Int32>, Nullable<CancellationToken>)

Create a tournament code for the given tournament. Official API Reference: https://developer.riotgames.com/api-methods/#tournament-v5/POST_createTournamentCode

Declaration
public Task<string[]> CreateTournamentCodeAsync(RegionalRoute route, TournamentCodeParametersV5 body, long tournamentId, int? count = null, CancellationToken? cancellationToken = null)
Parameters
Type Name Description
RegionalRoute route

Route to query. Corresponds to a Riot API subdomain for a region or platform. (required)
TournamentCodeParametersV5 body
System.Int64 tournamentId

The tournament ID (required, in query)
System.Nullable<System.Int32> count

The number of codes to create (max 1000) (optional, in query)
System.Nullable<System.Threading.CancellationToken> cancellationToken

A cancellation token that can be used to cancel this task. (optional)
Returns
Type Description
System.Threading.Tasks.Task<System.String[]>
| Improve this Doc View Source

GetGames(RegionalRoute, String, Nullable<CancellationToken>)

Get games details

Implementation Notes

Additional endpoint to get tournament games. From this endpoint, you are able to get participants PUUID (the callback doesn't contain this info).

You can also use it to check if the game was recorded and validate callbacks. If the endpoint returns the game, it means a callback was attempted.

This will only work for tournament codes created after November 10, 2023. Official API Reference: https://developer.riotgames.com/api-methods/#tournament-v5/GET_getGames

Declaration
public TournamentGamesV5[] GetGames(RegionalRoute route, string tournamentCode, CancellationToken? cancellationToken = null)
Parameters
Type Name Description
RegionalRoute route

Route to query. Corresponds to a Riot API subdomain for a region or platform. (required)
System.String tournamentCode

(required, in path)
System.Nullable<System.Threading.CancellationToken> cancellationToken

A cancellation token that can be used to cancel this task. (optional)
Returns
Type Description
TournamentGamesV5[]
| Improve this Doc View Source

GetGamesAsync(RegionalRoute, String, Nullable<CancellationToken>)

Get games details

Implementation Notes

Additional endpoint to get tournament games. From this endpoint, you are able to get participants PUUID (the callback doesn't contain this info).

You can also use it to check if the game was recorded and validate callbacks. If the endpoint returns the game, it means a callback was attempted.

This will only work for tournament codes created after November 10, 2023. Official API Reference: https://developer.riotgames.com/api-methods/#tournament-v5/GET_getGames

Declaration
public Task<TournamentGamesV5[]> GetGamesAsync(RegionalRoute route, string tournamentCode, CancellationToken? cancellationToken = null)
Parameters
Type Name Description
RegionalRoute route

Route to query. Corresponds to a Riot API subdomain for a region or platform. (required)
System.String tournamentCode

(required, in path)
System.Nullable<System.Threading.CancellationToken> cancellationToken

A cancellation token that can be used to cancel this task. (optional)
Returns
Type Description
System.Threading.Tasks.Task<TournamentGamesV5[]>
| Improve this Doc View Source

GetLobbyEventsByCode(RegionalRoute, String, Nullable<CancellationToken>)

Gets a list of lobby events by tournament code. Official API Reference: https://developer.riotgames.com/api-methods/#tournament-v5/GET_getLobbyEventsByCode

Declaration
public LobbyEventV5Wrapper GetLobbyEventsByCode(RegionalRoute route, string tournamentCode, CancellationToken? cancellationToken = null)
Parameters
Type Name Description
RegionalRoute route

Route to query. Corresponds to a Riot API subdomain for a region or platform. (required)
System.String tournamentCode

The short code to look up lobby events for (required, in path)
System.Nullable<System.Threading.CancellationToken> cancellationToken

A cancellation token that can be used to cancel this task. (optional)
Returns
Type Description
LobbyEventV5Wrapper
| Improve this Doc View Source

GetLobbyEventsByCodeAsync(RegionalRoute, String, Nullable<CancellationToken>)

Gets a list of lobby events by tournament code. Official API Reference: https://developer.riotgames.com/api-methods/#tournament-v5/GET_getLobbyEventsByCode

Declaration
public Task<LobbyEventV5Wrapper> GetLobbyEventsByCodeAsync(RegionalRoute route, string tournamentCode, CancellationToken? cancellationToken = null)
Parameters
Type Name Description
RegionalRoute route

Route to query. Corresponds to a Riot API subdomain for a region or platform. (required)
System.String tournamentCode

The short code to look up lobby events for (required, in path)
System.Nullable<System.Threading.CancellationToken> cancellationToken

A cancellation token that can be used to cancel this task. (optional)
Returns
Type Description
System.Threading.Tasks.Task<LobbyEventV5Wrapper>
| Improve this Doc View Source

GetTournamentCode(RegionalRoute, String, Nullable<CancellationToken>)

Returns the tournament code DTO associated with a tournament code string. Official API Reference: https://developer.riotgames.com/api-methods/#tournament-v5/GET_getTournamentCode

Declaration
public TournamentCodeV5 GetTournamentCode(RegionalRoute route, string tournamentCode, CancellationToken? cancellationToken = null)
Parameters
Type Name Description
RegionalRoute route

Route to query. Corresponds to a Riot API subdomain for a region or platform. (required)
System.String tournamentCode

The tournament code string. (required, in path)
System.Nullable<System.Threading.CancellationToken> cancellationToken

A cancellation token that can be used to cancel this task. (optional)
Returns
Type Description
TournamentCodeV5
| Improve this Doc View Source

GetTournamentCodeAsync(RegionalRoute, String, Nullable<CancellationToken>)

Returns the tournament code DTO associated with a tournament code string. Official API Reference: https://developer.riotgames.com/api-methods/#tournament-v5/GET_getTournamentCode

Declaration
public Task<TournamentCodeV5> GetTournamentCodeAsync(RegionalRoute route, string tournamentCode, CancellationToken? cancellationToken = null)
Parameters
Type Name Description
RegionalRoute route

Route to query. Corresponds to a Riot API subdomain for a region or platform. (required)
System.String tournamentCode

The tournament code string. (required, in path)
System.Nullable<System.Threading.CancellationToken> cancellationToken

A cancellation token that can be used to cancel this task. (optional)
Returns
Type Description
System.Threading.Tasks.Task<TournamentCodeV5>
| Improve this Doc View Source

RegisterProviderData(RegionalRoute, ProviderRegistrationParametersV5, Nullable<CancellationToken>)

Creates a tournament provider and returns its ID.

Implementation Notes

Providers will need to call this endpoint first to register their callback URL and their API key with the tournament system before any other tournament provider endpoints will work. Official API Reference: https://developer.riotgames.com/api-methods/#tournament-v5/POST_registerProviderData
Declaration
public int RegisterProviderData(RegionalRoute route, ProviderRegistrationParametersV5 body, CancellationToken? cancellationToken = null)
Parameters
Type Name Description
RegionalRoute route

Route to query. Corresponds to a Riot API subdomain for a region or platform. (required)
ProviderRegistrationParametersV5 body
System.Nullable<System.Threading.CancellationToken> cancellationToken

A cancellation token that can be used to cancel this task. (optional)
Returns
Type Description
System.Int32
| Improve this Doc View Source

RegisterProviderDataAsync(RegionalRoute, ProviderRegistrationParametersV5, Nullable<CancellationToken>)

Creates a tournament provider and returns its ID.

Implementation Notes

Providers will need to call this endpoint first to register their callback URL and their API key with the tournament system before any other tournament provider endpoints will work. Official API Reference: https://developer.riotgames.com/api-methods/#tournament-v5/POST_registerProviderData
Declaration
public Task<int> RegisterProviderDataAsync(RegionalRoute route, ProviderRegistrationParametersV5 body, CancellationToken? cancellationToken = null)
Parameters
Type Name Description
RegionalRoute route

Route to query. Corresponds to a Riot API subdomain for a region or platform. (required)
ProviderRegistrationParametersV5 body
System.Nullable<System.Threading.CancellationToken> cancellationToken

A cancellation token that can be used to cancel this task. (optional)
Returns
Type Description
System.Threading.Tasks.Task<System.Int32>
| Improve this Doc View Source

RegisterTournament(RegionalRoute, TournamentRegistrationParametersV5, Nullable<CancellationToken>)

Creates a tournament and returns its ID. Official API Reference: https://developer.riotgames.com/api-methods/#tournament-v5/POST_registerTournament

Declaration
public int RegisterTournament(RegionalRoute route, TournamentRegistrationParametersV5 body, CancellationToken? cancellationToken = null)
Parameters
Type Name Description
RegionalRoute route

Route to query. Corresponds to a Riot API subdomain for a region or platform. (required)
TournamentRegistrationParametersV5 body
System.Nullable<System.Threading.CancellationToken> cancellationToken

A cancellation token that can be used to cancel this task. (optional)
Returns
Type Description
System.Int32
| Improve this Doc View Source

RegisterTournamentAsync(RegionalRoute, TournamentRegistrationParametersV5, Nullable<CancellationToken>)

Creates a tournament and returns its ID. Official API Reference: https://developer.riotgames.com/api-methods/#tournament-v5/POST_registerTournament

Declaration
public Task<int> RegisterTournamentAsync(RegionalRoute route, TournamentRegistrationParametersV5 body, CancellationToken? cancellationToken = null)
Parameters
Type Name Description
RegionalRoute route

Route to query. Corresponds to a Riot API subdomain for a region or platform. (required)
TournamentRegistrationParametersV5 body
System.Nullable<System.Threading.CancellationToken> cancellationToken

A cancellation token that can be used to cancel this task. (optional)
Returns
Type Description
System.Threading.Tasks.Task<System.Int32>
| Improve this Doc View Source

UpdateCode(RegionalRoute, TournamentCodeUpdateParametersV5, String, Nullable<CancellationToken>)

Update the pick type, map, spectator type, or allowed puuids for a code. Official API Reference: https://developer.riotgames.com/api-methods/#tournament-v5/PUT_updateCode

Declaration
public void UpdateCode(RegionalRoute route, TournamentCodeUpdateParametersV5 body, string tournamentCode, CancellationToken? cancellationToken = null)
Parameters
Type Name Description
RegionalRoute route

Route to query. Corresponds to a Riot API subdomain for a region or platform. (required)
TournamentCodeUpdateParametersV5 body
System.String tournamentCode

The tournament code to update (required, in path)
System.Nullable<System.Threading.CancellationToken> cancellationToken

A cancellation token that can be used to cancel this task. (optional)
| Improve this Doc View Source

UpdateCodeAsync(RegionalRoute, TournamentCodeUpdateParametersV5, String, Nullable<CancellationToken>)

Update the pick type, map, spectator type, or allowed puuids for a code. Official API Reference: https://developer.riotgames.com/api-methods/#tournament-v5/PUT_updateCode

Declaration
public Task UpdateCodeAsync(RegionalRoute route, TournamentCodeUpdateParametersV5 body, string tournamentCode, CancellationToken? cancellationToken = null)
Parameters
Type Name Description
RegionalRoute route

Route to query. Corresponds to a Riot API subdomain for a region or platform. (required)
TournamentCodeUpdateParametersV5 body
System.String tournamentCode

The tournament code to update (required, in path)
System.Nullable<System.Threading.CancellationToken> cancellationToken

A cancellation token that can be used to cancel this task. (optional)
Returns
Type Description
System.Threading.Tasks.Task