com.exsoloscript.challonge.handler.retrofit

Interface RetrofitTournamentHandler

public interface RetrofitTournamentHandler

Tournament related API bindings

Version:

20160820.1

Author:

EXSolo

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<Tournament>	abortCheckIn(String tournament, int includeParticipants, int includeMatches) When your tournament is in a 'checking_in' or 'checked_in' state, there's no way to edit the tournament's start time (start_at) or check-in duration (check_in_duration).
retrofit2.Call<Tournament>	createTournament(TournamentQuery tournamentData) Create a new tournament.
retrofit2.Call<Tournament>	deleteTournament(String tournament) Deletes a tournament along with all its associated records.
retrofit2.Call<Tournament>	finalizeTournament(String tournament, int includeParticipants, int includeMatches) Finalize a tournament that has had all match scores submitted, rendering its results permanent.
retrofit2.Call<Tournament>	getTournament(String tournament, int includeParticipants, int includeMatches) Retrieve a single tournament record created with your account.
retrofit2.Call<List<Tournament>>	getTournaments(TournamentQueryState state, TournamentType type, String createdAfter, String createdBefore, String subdomain) Retrieve a set of tournaments created with your account.
retrofit2.Call<Tournament>	processCheckIns(String tournament, int includeParticipants, int includeMatches) This should be invoked after a tournament's check-in window closes before the tournament is started.
retrofit2.Call<Tournament>	resetTournament(String tournament, int includeParticipants, int includeMatches) Reset a tournament, clearing all of its scores and attachments.
retrofit2.Call<Tournament>	startTournament(String tournament, int includeParticipants, int includeMatches) Start a tournament, opening up first round matches for score reporting.
retrofit2.Call<Tournament>	updateTournament(String tournament, TournamentQuery tournamentData) Update a tournament's attributes.

Method Detail

getTournaments

@GET(value="tournaments.json")
retrofit2.Call<List<Tournament>> getTournaments(@Query(value="state")
                                                                                TournamentQueryState state,
                                                                                @Query(value="type")
                                                                                TournamentType type,
                                                                                @Query(value="created_after")
                                                                                String createdAfter,
                                                                                @Query(value="created_before")
                                                                                String createdBefore,
                                                                                @Query(value="subdomain")
                                                                                String subdomain)

Retrieve a set of tournaments created with your account.

Parameters:

state - only get tournaments with this state

type - only get tournaments with this type

createdAfter - get tournaments created after this date

createdBefore - get tournaments created before this date

subdomain - only get tournaments with this subdomain

Returns:

Call

getTournament

@GET(value="tournaments/{tournament}.json")
retrofit2.Call<Tournament> getTournament(@Path(value="tournament")
                                                                                      String tournament,
                                                                                      @Query(value="include_participants")
                                                                                      int includeParticipants,
                                                                                      @Query(value="include_matches")
                                                                                      int includeMatches)

Retrieve a single tournament record created with your account.

Parameters:

tournament - Tournament ID (e.g. 10230) or URL (e.g. 'single_elim' for challonge.com/single_elim). If assigned to a subdomain, URL format must be :subdomain-:tournament_url (e.g. 'test-mytourney' for test.challonge.com/mytourney)

includeParticipants - 0 or 1; include a list of participants in the response

includeMatches - include a list of matches in the response

Returns:

Call

createTournament

@POST(value="tournaments.json")
retrofit2.Call<Tournament> createTournament(@Body
                                                                             TournamentQuery tournamentData)

Create a new tournament.

Parameters:

tournamentData - An object with all the necessary information to create the tournament

Returns:

Call

updateTournament

@PUT(value="tournaments/{tournament}.json")
retrofit2.Call<Tournament> updateTournament(@Path(value="tournament")
                                                                                         String tournament,
                                                                                         @Body
                                                                                         TournamentQuery tournamentData)

Update a tournament's attributes.

Parameters:

tournament - Tournament ID (e.g. 10230) or URL (e.g. 'single_elim' for challonge.com/single_elim). If assigned to a subdomain, URL format must be :subdomain-:tournament_url (e.g. 'test-mytourney' for test.challonge.com/mytourney)

tournamentData - An object with all the necessary information to update the tournament

Returns:

Call

deleteTournament

@DELETE(value="tournaments/{tournament}.json")
retrofit2.Call<Tournament> deleteTournament(@Path(value="tournament")
                                                                                            String tournament)

Deletes a tournament along with all its associated records. There is no undo, so use with care!

Parameters:

tournament - Tournament ID (e.g. 10230) or URL (e.g. 'single_elim' for challonge.com/single_elim). If assigned to a subdomain, URL format must be :subdomain-:tournament_url (e.g. 'test-mytourney' for test.challonge.com/mytourney)

Returns:

Call

processCheckIns

@POST(value="tournaments/{tournament}/process_check_ins.json")
retrofit2.Call<Tournament> processCheckIns(@Path(value="tournament")
                                                                                                           String tournament,
                                                                                                           @Query(value="include_participants")
                                                                                                           int includeParticipants,
                                                                                                           @Query(value="include_matches")
                                                                                                           int includeMatches)

This should be invoked after a tournament's check-in window closes before the tournament is started.

1. Marks participants who have not checked in as inactive.
2. Moves inactive participants to bottom seeds (ordered by original seed).
3. Transitions the tournament state from 'checking_in' to 'checked_in'

NOTE: Checked in participants on the waiting list will be promoted if slots become available.

Parameters:

tournament - Tournament ID (e.g. 10230) or URL (e.g. 'single_elim' for challonge.com/single_elim). If assigned to a subdomain, URL format must be :subdomain-:tournament_url (e.g. 'test-mytourney' for test.challonge.com/mytourney)

includeParticipants - 0 or 1; include a list of participants in the response

includeMatches - 0 or 1; include a list of matches in the response

Returns:

Call

abortCheckIn

@POST(value="tournaments/{tournament}/abort_check_in.json")
retrofit2.Call<Tournament> abortCheckIn(@Path(value="tournament")
                                                                                                     String tournament,
                                                                                                     @Query(value="include_participants")
                                                                                                     int includeParticipants,
                                                                                                     @Query(value="include_matches")
                                                                                                     int includeMatches)

When your tournament is in a 'checking_in' or 'checked_in' state, there's no way to edit the tournament's start time (start_at) or check-in duration (check_in_duration). You must first abort check-in, then you may edit those attributes.

1. Makes all participants active and clears their checked_in_at times.
2. Transitions the tournament state from 'checking_in' or 'checked_in' to 'pending'

Parameters:

tournament - Tournament ID (e.g. 10230) or URL (e.g. 'single_elim' for challonge.com/single_elim). If assigned to a subdomain, URL format must be :subdomain-:tournament_url (e.g. 'test-mytourney' for test.challonge.com/mytourney)

includeParticipants - 0 or 1; include a list of participants in the response

includeMatches - 0 or 1; include a list of matches in the response

Returns:

Call

startTournament

@POST(value="tournaments/{tournament}/start.json")
retrofit2.Call<Tournament> startTournament(@Path(value="tournament")
                                                                                               String tournament,
                                                                                               @Query(value="include_participants")
                                                                                               int includeParticipants,
                                                                                               @Query(value="include_matches")
                                                                                               int includeMatches)

Start a tournament, opening up first round matches for score reporting. The tournament must have at least 2 participants.

Parameters:

tournament - Tournament ID (e.g. 10230) or URL (e.g. 'single_elim' for challonge.com/single_elim). If assigned to a subdomain, URL format must be :subdomain-:tournament_url (e.g. 'test-mytourney' for test.challonge.com/mytourney)

includeParticipants - 0 or 1; include a list of participants in the response

includeMatches - 0 or 1; include a list of matches in the response

Returns:

Call

finalizeTournament

@POST(value="tournaments/{tournament}/finalize.json")
retrofit2.Call<Tournament> finalizeTournament(@Path(value="tournament")
                                                                                                     String tournament,
                                                                                                     @Query(value="include_participants")
                                                                                                     int includeParticipants,
                                                                                                     @Query(value="include_matches")
                                                                                                     int includeMatches)

Finalize a tournament that has had all match scores submitted, rendering its results permanent.

Parameters:

tournament - Tournament ID (e.g. 10230) or URL (e.g. 'single_elim' for challonge.com/single_elim). If assigned to a subdomain, URL format must be :subdomain-:tournament_url (e.g. 'test-mytourney' for test.challonge.com/mytourney)

includeParticipants - 0 or 1; include a list of participants in the response

includeMatches - 0 or 1; include a list of matches in the response

Returns:

Call

resetTournament

@POST(value="tournaments/{tournament}/reset.json")
retrofit2.Call<Tournament> resetTournament(@Path(value="tournament")
                                                                                               String tournament,
                                                                                               @Query(value="include_participants")
                                                                                               int includeParticipants,
                                                                                               @Query(value="include_matches")
                                                                                               int includeMatches)

Reset a tournament, clearing all of its scores and attachments. You can then add/remove/edit participants before starting the tournament again.

Parameters:

tournament - Tournament ID (e.g. 10230) or URL (e.g. 'single_elim' for challonge.com/single_elim). If assigned to a subdomain, URL format must be :subdomain-:tournament_url (e.g. 'test-mytourney' for test.challonge.com/mytourney)

includeParticipants - 0 or 1; include a list of participants in the response

includeMatches - 0 or 1; include a list of matches in the response

Returns:

Call