Class ClashV1Endpoints
ClashV1 endpoints. This class is automatically generated.
Official API Reference https://developer.riotgames.com/api-methods/#clash-v1
Inherited Members
Namespace: MingweiSamuel.Camille
Assembly: Camille.dll
Syntax
public class ClashV1Endpoints : Endpoints
Methods
| Improve this Doc View SourceGetPlayersBySummoner(Region, String, Nullable<CancellationToken>)
Get players by summoner ID.
Implementation Notes
This endpoint returns a list of active Clash players for a given summoner ID. 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_getPlayersBySummoner
Declaration
public Player[] GetPlayersBySummoner(Region region, string summonerId, CancellationToken? cancellationToken = default(CancellationToken? ))
Parameters
Type | Name | Description |
---|---|---|
Region | region | Region to query. |
System.String | summonerId | (required) |
System.Nullable<System.Threading.CancellationToken> | cancellationToken | A cancellation token that can be used to cancel this task. |
Returns
Type | Description |
---|---|
Player[] |
GetPlayersBySummonerAsync(Region, String, Nullable<CancellationToken>)
Get players by summoner ID.
Implementation Notes
This endpoint returns a list of active Clash players for a given summoner ID. 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_getPlayersBySummoner
Declaration
public Task<Player[]> GetPlayersBySummonerAsync(Region region, string summonerId, CancellationToken? cancellationToken = default(CancellationToken? ))
Parameters
Type | Name | Description |
---|---|---|
Region | region | Region to query. |
System.String | summonerId | (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<Player[]> |
GetTeamById(Region, String, Nullable<CancellationToken>)
Get team by ID.
Official API Reference: https://developer.riotgames.com/api-methods/#clash-v1/GET_getTeamById
Declaration
public Team GetTeamById(Region region, string teamId, CancellationToken? cancellationToken = default(CancellationToken? ))
Parameters
Type | Name | Description |
---|---|---|
Region | region | Region to query. |
System.String | teamId | (required) |
System.Nullable<System.Threading.CancellationToken> | cancellationToken | A cancellation token that can be used to cancel this task. |
Returns
Type | Description |
---|---|
Team |
GetTeamByIdAsync(Region, 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(Region region, string teamId, CancellationToken? cancellationToken = default(CancellationToken? ))
Parameters
Type | Name | Description |
---|---|---|
Region | region | Region to query. |
System.String | teamId | (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<Team> |
GetTournamentById(Region, Int32, Nullable<CancellationToken>)
Get tournament by ID.
Official API Reference: https://developer.riotgames.com/api-methods/#clash-v1/GET_getTournamentById
Declaration
public Tournament GetTournamentById(Region region, int tournamentId, CancellationToken? cancellationToken = default(CancellationToken? ))
Parameters
Type | Name | Description |
---|---|---|
Region | region | Region to query. |
System.Int32 | tournamentId | (required) |
System.Nullable<System.Threading.CancellationToken> | cancellationToken | A cancellation token that can be used to cancel this task. |
Returns
Type | Description |
---|---|
Tournament |
GetTournamentByIdAsync(Region, 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(Region region, int tournamentId, CancellationToken? cancellationToken = default(CancellationToken? ))
Parameters
Type | Name | Description |
---|---|---|
Region | region | Region to query. |
System.Int32 | tournamentId | (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<Tournament> |
GetTournamentByTeam(Region, 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(Region region, string teamId, CancellationToken? cancellationToken = default(CancellationToken? ))
Parameters
Type | Name | Description |
---|---|---|
Region | region | Region to query. |
System.String | teamId | (required) |
System.Nullable<System.Threading.CancellationToken> | cancellationToken | A cancellation token that can be used to cancel this task. |
Returns
Type | Description |
---|---|
Tournament |
GetTournamentByTeamAsync(Region, 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(Region region, string teamId, CancellationToken? cancellationToken = default(CancellationToken? ))
Parameters
Type | Name | Description |
---|---|---|
Region | region | Region to query. |
System.String | teamId | (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<Tournament> |
GetTournaments(Region, 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(Region region, CancellationToken? cancellationToken = default(CancellationToken? ))
Parameters
Type | Name | Description |
---|---|---|
Region | region | Region to query. |
System.Nullable<System.Threading.CancellationToken> | cancellationToken | A cancellation token that can be used to cancel this task. |
Returns
Type | Description |
---|---|
Tournament[] |
GetTournamentsAsync(Region, 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(Region region, CancellationToken? cancellationToken = default(CancellationToken? ))
Parameters
Type | Name | Description |
---|---|---|
Region | region | Region to query. |
System.Nullable<System.Threading.CancellationToken> | cancellationToken | A cancellation token that can be used to cancel this task. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<Tournament[]> |