Struct riven::endpoints::TournamentV5
source · pub struct TournamentV5<'a> { /* private fields */ }
Expand description
TournamentV5 endpoints handle, accessed by calling tournament_v5()
on a RiotApi
instance.
§Riot Developer API Reference
Note: this struct is automatically generated.
Implementations§
source§impl<'a> TournamentV5<'a>
impl<'a> TournamentV5<'a>
sourcepub fn create_tournament_code(
&self,
route: RegionalRoute,
body: &TournamentCodeParametersV5,
tournament_id: i64,
count: Option<i32>
) -> impl Future<Output = Result<Vec<String>>> + 'a
pub fn create_tournament_code( &self, route: RegionalRoute, body: &TournamentCodeParametersV5, tournament_id: i64, count: Option<i32> ) -> impl Future<Output = Result<Vec<String>>> + 'a
Create a tournament code for the given tournament.
§Parameters
route
- Route to query.tournament_id
(required, in query) - The tournament IDcount
(optional, in query) - The number of codes to create (max 1000)
§Riot Developer API Reference
tournament-v5.createTournamentCode
Note: this method is automatically generated.
sourcepub fn get_tournament_code(
&self,
route: RegionalRoute,
tournament_code: &str
) -> impl Future<Output = Result<TournamentCodeV5>> + 'a
pub fn get_tournament_code( &self, route: RegionalRoute, tournament_code: &str ) -> impl Future<Output = Result<TournamentCodeV5>> + 'a
Returns the tournament code DTO associated with a tournament code string.
§Parameters
route
- Route to query.tournament_code
(required, in path) - The tournament code string.
§Riot Developer API Reference
tournament-v5.getTournamentCode
Note: this method is automatically generated.
sourcepub fn update_code(
&self,
route: RegionalRoute,
body: &TournamentCodeUpdateParametersV5,
tournament_code: &str
) -> impl Future<Output = Result<()>> + 'a
pub fn update_code( &self, route: RegionalRoute, body: &TournamentCodeUpdateParametersV5, tournament_code: &str ) -> impl Future<Output = Result<()>> + 'a
sourcepub fn get_games(
&self,
route: RegionalRoute,
tournament_code: &str
) -> impl Future<Output = Result<Vec<TournamentGamesV5>>> + 'a
pub fn get_games( &self, route: RegionalRoute, tournament_code: &str ) -> impl Future<Output = Result<Vec<TournamentGamesV5>>> + 'a
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.
§Parameters
route
- Route to query.tournament_code
(required, in path)
§Riot Developer API Reference
Note: this method is automatically generated.
sourcepub fn get_lobby_events_by_code(
&self,
route: RegionalRoute,
tournament_code: &str
) -> impl Future<Output = Result<LobbyEventV5Wrapper>> + 'a
pub fn get_lobby_events_by_code( &self, route: RegionalRoute, tournament_code: &str ) -> impl Future<Output = Result<LobbyEventV5Wrapper>> + 'a
Gets a list of lobby events by tournament code.
§Parameters
route
- Route to query.tournament_code
(required, in path) - The short code to look up lobby events for
§Riot Developer API Reference
tournament-v5.getLobbyEventsByCode
Note: this method is automatically generated.
sourcepub fn register_provider_data(
&self,
route: RegionalRoute,
body: &ProviderRegistrationParametersV5
) -> impl Future<Output = Result<i32>> + 'a
pub fn register_provider_data( &self, route: RegionalRoute, body: &ProviderRegistrationParametersV5 ) -> impl Future<Output = Result<i32>> + 'a
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.
§Parameters
route
- Route to query.
§Riot Developer API Reference
tournament-v5.registerProviderData
Note: this method is automatically generated.
sourcepub fn register_tournament(
&self,
route: RegionalRoute,
body: &TournamentRegistrationParametersV5
) -> impl Future<Output = Result<i32>> + 'a
pub fn register_tournament( &self, route: RegionalRoute, body: &TournamentRegistrationParametersV5 ) -> impl Future<Output = Result<i32>> + 'a
Creates a tournament and returns its ID.
§Parameters
route
- Route to query.
§Riot Developer API Reference
tournament-v5.registerTournament
Note: this method is automatically generated.