com.exsoloscript.challonge.handler.retrofit

Interface RetrofitParticipantHandler

public interface RetrofitParticipantHandler

Participant related API bindings

Version:

20160822.1

Author:

EXSolo

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<Participant>	addParticipant(String tournament, ParticipantQuery participant) Add a participant to a tournament (up until it is started).
retrofit2.Call<List<Participant>>	bulkAddParticipants(String tournament, List<ParticipantQuery> participants) Bulk add participants to a tournament (up until it is started).
retrofit2.Call<Participant>	checkInParticipant(String tournament, int participantId) Checks a participant in, setting checked_in_at to the current time.
retrofit2.Call<Participant>	deleteParticipant(String tournament, int participantId) If the tournament has not started, delete a participant, automatically filling in the abandoned seed number.
retrofit2.Call<Participant>	getParticipant(String tournament, int participantId, int includeMatches) Retrieve a single participant record for a tournament.
retrofit2.Call<List<Participant>>	getParticipants(String tournament) Retrieve a tournament's participant list.
retrofit2.Call<List<Participant>>	randomizeParticipants(String tournament) Randomize seeds among participants.
retrofit2.Call<Participant>	undoParticipantCheckIn(String tournament, int participantId) Marks a participant as having not checked in, setting checked_in_at to nil.
retrofit2.Call<Participant>	updateParticipant(String tournament, int participantId, ParticipantQuery participant) Update the attributes of a tournament participant.

Method Detail

getParticipants

@GET(value="tournaments/{tournament}/participants.json")
retrofit2.Call<List<Participant>> getParticipants(@Path(value="tournament")
                                                                                                            String tournament)

Retrieve a tournament's participant list.

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

getParticipant

@GET(value="tournaments/{tournament}/participants/{participant_id}.json")
retrofit2.Call<Participant> getParticipant(@Path(value="tournament")
                                                                                                                      String tournament,
                                                                                                                      @Path(value="participant_id")
                                                                                                                      int participantId,
                                                                                                                      @Query(value="include_matches")
                                                                                                                      int includeMatches)

Retrieve a single participant record for a tournament.

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)

participantId - The participant's unique ID

includeMatches - 0 or 1; Includes an array of associated match records

Returns:

Call

addParticipant

@POST(value="tournaments/{tournament}/participants.json")
retrofit2.Call<Participant> addParticipant(@Path(value="tournament")
                                                                                                      String tournament,
                                                                                                      @Body
                                                                                                      ParticipantQuery participant)

Add a participant to a tournament (up until it is started).

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)

participant - The participant data

Returns:

Call

bulkAddParticipants

@POST(value="tournaments/{tournament}/participants/bulk_add.json")
retrofit2.Call<List<Participant>> bulkAddParticipants(@Path(value="tournament")
                                                                                                                          String tournament,
                                                                                                                          @Body
                                                                                                                          List<ParticipantQuery> participants)

Bulk add participants to a tournament (up until it is started). If an invalid participant is detected, bulk participant creation will halt and any previously added participants (from this API request) will be rolled back.

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)

participants - The participant data

Returns:

Call

updateParticipant

@PUT(value="tournaments/{tournament}/participants/{participant_id}.json")
retrofit2.Call<Participant> updateParticipant(@Path(value="tournament")
                                                                                                                         String tournament,
                                                                                                                         @Path(value="participant_id")
                                                                                                                         int participantId,
                                                                                                                         @Body
                                                                                                                         ParticipantQuery participant)

Update the attributes of a tournament participant.

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)

participantId - The participant's unique ID

participant - The participant data

Returns:

Call

checkInParticipant

@POST(value="tournaments/{tournament}/participants/{participant_id}/check_in.json")
retrofit2.Call<Participant> checkInParticipant(@Path(value="tournament")
                                                                                                                                    String tournament,
                                                                                                                                    @Path(value="participant_id")
                                                                                                                                    int participantId)

Checks a participant in, setting checked_in_at to the current time.

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)

participantId - The participant's unique ID

Returns:

Call

undoParticipantCheckIn

@POST(value="tournaments/{tournament}/participants/{participant_id}/undo_check_in.json")
retrofit2.Call<Participant> undoParticipantCheckIn(@Path(value="tournament")
                                                                                                                                             String tournament,
                                                                                                                                             @Path(value="participant_id")
                                                                                                                                             int participantId)

Marks a participant as having not checked in, setting checked_in_at to nil.

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)

participantId - The participant's unique ID

Returns:

Call

deleteParticipant

@DELETE(value="tournaments/{tournament}/participants/{participant_id}.json")
retrofit2.Call<Participant> deleteParticipant(@Path(value="tournament")
                                                                                                                            String tournament,
                                                                                                                            @Path(value="participant_id")
                                                                                                                            int participantId)

If the tournament has not started, delete a participant, automatically filling in the abandoned seed number. If tournament is underway, mark a participant inactive, automatically forfeiting his/her remaining matches.

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)

participantId - The participant's unique ID

Returns:

Call

randomizeParticipants

@POST(value="tournaments/{tournament}/participants/randomize.json")
retrofit2.Call<List<Participant>> randomizeParticipants(@Path(value="tournament")
                                                                                                                             String tournament)

Randomize seeds among participants. Only applicable before a tournament has started.

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