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

tournament-v5

Note: this struct is automatically generated.

Implementations§

source§

impl<'a> TournamentV5<'a>

source

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 ID
  • count (optional, in query) - The number of codes to create (max 1000)
§Riot Developer API Reference

tournament-v5.createTournamentCode

Note: this method is automatically generated.

source

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.

source

pub fn update_code( &self, route: RegionalRoute, body: &TournamentCodeUpdateParametersV5, tournament_code: &str ) -> impl Future<Output = Result<()>> + 'a

Update the pick type, map, spectator type, or allowed puuids for a code.

§Parameters
  • route - Route to query.
  • tournament_code (required, in path) - The tournament code to update
§Riot Developer API Reference

tournament-v5.updateCode

Note: this method is automatically generated.

source

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

tournament-v5.getGames

Note: this method is automatically generated.

source

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.

source

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.

source

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.

Auto Trait Implementations§

§

impl<'a> Freeze for TournamentV5<'a>

§

impl<'a> !RefUnwindSafe for TournamentV5<'a>

§

impl<'a> Send for TournamentV5<'a>

§

impl<'a> Sync for TournamentV5<'a>

§

impl<'a> Unpin for TournamentV5<'a>

§

impl<'a> !UnwindSafe for TournamentV5<'a>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more