Class ClashV1Endpoints
ClashV1 endpoints. This class is automatically generated.
Official API Reference https://developer.riotgames.com/api-methods/#clash-v1
Inherited Members
Namespace: Camille.RiotGames
Assembly: Camille.RiotGames.dll
Syntax
public class ClashV1Endpoints : Endpoints
Methods
| Improve this Doc View SourceGetPlayersByPUUID(PlatformRoute, String, Nullable<CancellationToken>)
Get players by puuid
Implementation Notes
This endpoint returns a list of active Clash players for a given PUUID. If a summoner registers for multiple tournaments at the same time (e.g., Saturday and Sunday) then both registrations would appear in this list. Official API Reference: https://developer.riotgames.com/api-methods/#clash-v1/GET_getPlayersByPUUIDDeclaration
public Player[] GetPlayersByPUUID(PlatformRoute route, string puuid, CancellationToken? cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
PlatformRoute | route | Route to query. Corresponds to a Riot API subdomain for a region or platform. (required) |
System.String | puuid | (required, in path) |
System.Nullable<System.Threading.CancellationToken> | cancellationToken | A cancellation token that can be used to cancel this task. (optional) |
Returns
Type | Description |
---|---|
Player[] |
GetPlayersByPUUIDAsync(PlatformRoute, String, Nullable<CancellationToken>)
Get players by puuid
Implementation Notes
This endpoint returns a list of active Clash players for a given PUUID. If a summoner registers for multiple tournaments at the same time (e.g., Saturday and Sunday) then both registrations would appear in this list. Official API Reference: https://developer.riotgames.com/api-methods/#clash-v1/GET_getPlayersByPUUIDDeclaration
public Task<Player[]> GetPlayersByPUUIDAsync(PlatformRoute route, string puuid, CancellationToken? cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
PlatformRoute | route | Route to query. Corresponds to a Riot API subdomain for a region or platform. (required) |
System.String | puuid | (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<Player[]> |
GetTeamById(PlatformRoute, String, Nullable<CancellationToken>)
Get team by ID. Official API Reference: https://developer.riotgames.com/api-methods/#clash-v1/GET_getTeamById
Declaration
public Team GetTeamById(PlatformRoute route, string teamId, CancellationToken? cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
PlatformRoute | route | Route to query. Corresponds to a Riot API subdomain for a region or platform. (required) |
System.String | teamId | (required, in path) |
System.Nullable<System.Threading.CancellationToken> | cancellationToken | A cancellation token that can be used to cancel this task. (optional) |
Returns
Type | Description |
---|---|
Team |
GetTeamByIdAsync(PlatformRoute, String, Nullable<CancellationToken>)
Get team by ID. Official API Reference: https://developer.riotgames.com/api-methods/#clash-v1/GET_getTeamById
Declaration
public Task<Team> GetTeamByIdAsync(PlatformRoute route, string teamId, CancellationToken? cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
PlatformRoute | route | Route to query. Corresponds to a Riot API subdomain for a region or platform. (required) |
System.String | teamId | (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<Team> |
GetTournamentById(PlatformRoute, Int32, Nullable<CancellationToken>)
Get tournament by ID. Official API Reference: https://developer.riotgames.com/api-methods/#clash-v1/GET_getTournamentById
Declaration
public Tournament GetTournamentById(PlatformRoute route, int tournamentId, CancellationToken? cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
PlatformRoute | route | Route to query. Corresponds to a Riot API subdomain for a region or platform. (required) |
System.Int32 | tournamentId | (required, in path) |
System.Nullable<System.Threading.CancellationToken> | cancellationToken | A cancellation token that can be used to cancel this task. (optional) |
Returns
Type | Description |
---|---|
Tournament |
GetTournamentByIdAsync(PlatformRoute, Int32, Nullable<CancellationToken>)
Get tournament by ID. Official API Reference: https://developer.riotgames.com/api-methods/#clash-v1/GET_getTournamentById
Declaration
public Task<Tournament> GetTournamentByIdAsync(PlatformRoute route, int tournamentId, CancellationToken? cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
PlatformRoute | route | Route to query. Corresponds to a Riot API subdomain for a region or platform. (required) |
System.Int32 | tournamentId | (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<Tournament> |
GetTournamentByTeam(PlatformRoute, String, Nullable<CancellationToken>)
Get tournament by team ID. Official API Reference: https://developer.riotgames.com/api-methods/#clash-v1/GET_getTournamentByTeam
Declaration
public Tournament GetTournamentByTeam(PlatformRoute route, string teamId, CancellationToken? cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
PlatformRoute | route | Route to query. Corresponds to a Riot API subdomain for a region or platform. (required) |
System.String | teamId | (required, in path) |
System.Nullable<System.Threading.CancellationToken> | cancellationToken | A cancellation token that can be used to cancel this task. (optional) |
Returns
Type | Description |
---|---|
Tournament |
GetTournamentByTeamAsync(PlatformRoute, String, Nullable<CancellationToken>)
Get tournament by team ID. Official API Reference: https://developer.riotgames.com/api-methods/#clash-v1/GET_getTournamentByTeam
Declaration
public Task<Tournament> GetTournamentByTeamAsync(PlatformRoute route, string teamId, CancellationToken? cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
PlatformRoute | route | Route to query. Corresponds to a Riot API subdomain for a region or platform. (required) |
System.String | teamId | (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<Tournament> |
GetTournaments(PlatformRoute, Nullable<CancellationToken>)
Get all active or upcoming tournaments. Official API Reference: https://developer.riotgames.com/api-methods/#clash-v1/GET_getTournaments
Declaration
public Tournament[] GetTournaments(PlatformRoute route, CancellationToken? cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
PlatformRoute | route | Route to query. Corresponds to a Riot API subdomain for a region or platform. (required) |
System.Nullable<System.Threading.CancellationToken> | cancellationToken | A cancellation token that can be used to cancel this task. (optional) |
Returns
Type | Description |
---|---|
Tournament[] |
GetTournamentsAsync(PlatformRoute, Nullable<CancellationToken>)
Get all active or upcoming tournaments. Official API Reference: https://developer.riotgames.com/api-methods/#clash-v1/GET_getTournaments
Declaration
public Task<Tournament[]> GetTournamentsAsync(PlatformRoute route, CancellationToken? cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
PlatformRoute | route | Route to query. Corresponds to a Riot API subdomain for a region or platform. (required) |
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<Tournament[]> |