Class TournamentStubV5Endpoints
TournamentStubV5 endpoints. This class is automatically generated.
Official API Reference https://developer.riotgames.com/api-methods/#tournament-stub-v5
Inherited Members
Namespace: Camille.RiotGames
Assembly: Camille.RiotGames.dll
Syntax
public class TournamentStubV5Endpoints : Endpoints
Methods
| Improve this Doc View SourceCreateTournamentCode(RegionalRoute, TournamentCodeParametersV5, Int64, Nullable<Int32>, Nullable<CancellationToken>)
Create a tournament code for the given tournament - Stub method Official API Reference: https://developer.riotgames.com/api-methods/#tournament-stub-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[] |
CreateTournamentCodeAsync(RegionalRoute, TournamentCodeParametersV5, Int64, Nullable<Int32>, Nullable<CancellationToken>)
Create a tournament code for the given tournament - Stub method Official API Reference: https://developer.riotgames.com/api-methods/#tournament-stub-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[]> |
GetLobbyEventsByCode(RegionalRoute, String, Nullable<CancellationToken>)
Gets a list of lobby events by tournament code - Stub method Official API Reference: https://developer.riotgames.com/api-methods/#tournament-stub-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 |
GetLobbyEventsByCodeAsync(RegionalRoute, String, Nullable<CancellationToken>)
Gets a list of lobby events by tournament code - Stub method Official API Reference: https://developer.riotgames.com/api-methods/#tournament-stub-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> |
GetTournamentCode(RegionalRoute, String, Nullable<CancellationToken>)
Returns the tournament code DTO associated with a tournament code string - Stub Method Official API Reference: https://developer.riotgames.com/api-methods/#tournament-stub-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 |
GetTournamentCodeAsync(RegionalRoute, String, Nullable<CancellationToken>)
Returns the tournament code DTO associated with a tournament code string - Stub Method Official API Reference: https://developer.riotgames.com/api-methods/#tournament-stub-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> |
RegisterProviderData(RegionalRoute, ProviderRegistrationParametersV5, Nullable<CancellationToken>)
Creates a tournament provider and returns its ID - Stub method
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-stub-v5/POST_registerProviderDataDeclaration
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 |
RegisterProviderDataAsync(RegionalRoute, ProviderRegistrationParametersV5, Nullable<CancellationToken>)
Creates a tournament provider and returns its ID - Stub method
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-stub-v5/POST_registerProviderDataDeclaration
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> |
RegisterTournament(RegionalRoute, TournamentRegistrationParametersV5, Nullable<CancellationToken>)
Creates a tournament and returns its ID - Stub method Official API Reference: https://developer.riotgames.com/api-methods/#tournament-stub-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 |
RegisterTournamentAsync(RegionalRoute, TournamentRegistrationParametersV5, Nullable<CancellationToken>)
Creates a tournament and returns its ID - Stub method Official API Reference: https://developer.riotgames.com/api-methods/#tournament-stub-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> |