Package at.stefangeyer.challonge.rest

Interface RestClient

public interface RestClient
Challonge Rest Client Definition

  • Method Details

    • initialize

      void initialize​(Credentials credentials, Serializer serializer)
      Initializes the factory with the necessary dependencies
      Parameters:
      credentials - The username and api key to use
      serializer - The serializer to use

    • getTournaments

      java.util.List<TournamentWrapper> getTournaments​(TournamentQueryState state, TournamentType type, java.time.OffsetDateTime createdAfter, java.time.OffsetDateTime createdBefore, java.lang.String subdomain) throws DataAccessException
      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:
      The filtered tournaments
      Throws:
      DataAccessException - Exchange with the rest api failed

    • getTournaments

      void getTournaments​(TournamentQueryState state, TournamentType type, java.time.OffsetDateTime createdAfter, java.time.OffsetDateTime createdBefore, java.lang.String subdomain, Callback<java.util.List<TournamentWrapper>> onSuccess, Callback<DataAccessException> onFailure)
      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
      onSuccess - Called with result if call was successful
      onFailure - Called with exception if call was not successful

    • getTournament

      TournamentWrapper getTournament​(java.lang.String tournament, boolean includeParticipants, boolean includeMatches) throws DataAccessException
      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 - Include a list of participants in the response
      includeMatches - Include a list of matches in the response
      Returns:
      The matching tournament
      Throws:
      DataAccessException - Exchange with the rest api failed

    • getTournament

      void getTournament​(java.lang.String tournament, boolean includeParticipants, boolean includeMatches, Callback<TournamentWrapper> onSuccess, Callback<DataAccessException> onFailure)
      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 - Include a list of participants in the response
      includeMatches - Include a list of matches in the response
      onSuccess - Called with result if call was successful
      onFailure - Called with exception if call was not successful

    • createTournament

      TournamentWrapper createTournament​(TournamentQueryWrapper tournamentData) throws DataAccessException
      Create a new tournament.
      Parameters:
      tournamentData - An object with all the necessary information to create the tournament
      Returns:
      The created tournament
      Throws:
      DataAccessException - Exchange with the rest api failed

    • createTournament

      void createTournament​(TournamentQueryWrapper tournamentData, Callback<TournamentWrapper> onSuccess, Callback<DataAccessException> onFailure)
      Create a new tournament.
      Parameters:
      tournamentData - An object with all the necessary information to create the tournament
      onSuccess - Called with result if call was successful
      onFailure - Called with exception if call was not successful

    • updateTournament

      TournamentWrapper updateTournament​(java.lang.String tournament, TournamentQueryWrapper tournamentData) throws DataAccessException
      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:
      The updated tournament
      Throws:
      DataAccessException - Exchange with the rest api failed

    • updateTournament

      void updateTournament​(java.lang.String tournament, TournamentQueryWrapper tournamentData, Callback<TournamentWrapper> onSuccess, Callback<DataAccessException> onFailure)
      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
      onSuccess - Called with result if call was successful
      onFailure - Called with exception if call was not successful

    • deleteTournament

      TournamentWrapper deleteTournament​(java.lang.String tournament) throws DataAccessException
      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:
      The deleted tournament
      Throws:
      DataAccessException - Exchange with the rest api failed

    • deleteTournament

      void deleteTournament​(java.lang.String tournament, Callback<TournamentWrapper> onSuccess, Callback<DataAccessException> onFailure)
      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)
      onSuccess - Called with result if call was successful
      onFailure - Called with exception if call was not successful

    • processCheckIns

      TournamentWrapper processCheckIns​(java.lang.String tournament, boolean includeParticipants, boolean includeMatches) throws DataAccessException
      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 - Include a list of participants in the response
      includeMatches - Include a list of matches in the response
      Returns:
      The updated tournament
      Throws:
      DataAccessException - Exchange with the rest api failed

    • processCheckIns

      void processCheckIns​(java.lang.String tournament, boolean includeParticipants, boolean includeMatches, Callback<TournamentWrapper> onSuccess, Callback<DataAccessException> onFailure)
      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 - Include a list of participants in the response
      includeMatches - Include a list of matches in the response
      onSuccess - Called with result if call was successful
      onFailure - Called with exception if call was not successful

    • abortCheckIn

      TournamentWrapper abortCheckIn​(java.lang.String tournament, boolean includeParticipants, boolean includeMatches) throws DataAccessException
      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 - Include a list of participants in the response
      includeMatches - Include a list of matches in the response
      Returns:
      The updated tournament
      Throws:
      DataAccessException - Exchange with the rest api failed

    • abortCheckIn

      void abortCheckIn​(java.lang.String tournament, boolean includeParticipants, boolean includeMatches, Callback<TournamentWrapper> onSuccess, Callback<DataAccessException> onFailure)
      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 - Include a list of participants in the response
      includeMatches - Include a list of matches in the response
      onSuccess - Called with result if call was successful
      onFailure - Called with exception if call was not successful

    • startTournament

      TournamentWrapper startTournament​(java.lang.String tournament, boolean includeParticipants, boolean includeMatches) throws DataAccessException
      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 - Include a list of participants in the response
      includeMatches - Include a list of matches in the response
      Returns:
      The started tournament
      Throws:
      DataAccessException - Exchange with the rest api failed

    • startTournament

      void startTournament​(java.lang.String tournament, boolean includeParticipants, boolean includeMatches, Callback<TournamentWrapper> onSuccess, Callback<DataAccessException> onFailure)
      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 - Include a list of participants in the response
      includeMatches - Include a list of matches in the response
      onSuccess - Called with result if call was successful
      onFailure - Called with exception if call was not successful

    • finalizeTournament

      TournamentWrapper finalizeTournament​(java.lang.String tournament, boolean includeParticipants, boolean includeMatches) throws DataAccessException
      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 - Include a list of participants in the response
      includeMatches - Include a list of matches in the response
      Returns:
      The finalized tournament
      Throws:
      DataAccessException - Exchange with the rest api failed

    • finalizeTournament

      void finalizeTournament​(java.lang.String tournament, boolean includeParticipants, boolean includeMatches, Callback<TournamentWrapper> onSuccess, Callback<DataAccessException> onFailure)
      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 - Include a list of participants in the response
      includeMatches - Include a list of matches in the response
      onSuccess - Called with result if call was successful
      onFailure - Called with exception if call was not successful

    • resetTournament

      TournamentWrapper resetTournament​(java.lang.String tournament, boolean includeParticipants, boolean includeMatches) throws DataAccessException
      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 - Include a list of participants in the response
      includeMatches - Include a list of matches in the response
      Returns:
      The reset tournament
      Throws:
      DataAccessException - Exchange with the rest api failed

    • resetTournament

      void resetTournament​(java.lang.String tournament, boolean includeParticipants, boolean includeMatches, Callback<TournamentWrapper> onSuccess, Callback<DataAccessException> onFailure)
      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 - Include a list of participants in the response
      includeMatches - Include a list of matches in the response
      onSuccess - Called with result if call was successful
      onFailure - Called with exception if call was not successful

    • openTournamentForPredictions

      TournamentWrapper openTournamentForPredictions​(java.lang.String tournament, boolean includeParticipants, boolean includeMatches) throws DataAccessException
      Sets the state of the tournament to start accepting predictions. Your tournament's 'prediction_method' attribute must be set to 1 (exponential scoring) or 2 (linear scoring) to use this option. Note: Once open for predictions, match records will be persisted, so participant additions and removals will no longer be permitted.
      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 - Include a list of participants in the response
      includeMatches - Include a list of matches in the response
      Returns:
      The reset tournament
      Throws:
      DataAccessException - Exchange with the rest api failed

    • openTournamentForPredictions

      void openTournamentForPredictions​(java.lang.String tournament, boolean includeParticipants, boolean includeMatches, Callback<TournamentWrapper> onSuccess, Callback<DataAccessException> onFailure)
      Sets the state of the tournament to start accepting predictions. Your tournament's 'prediction_method' attribute must be set to 1 (exponential scoring) or 2 (linear scoring) to use this option. Note: Once open for predictions, match records will be persisted, so participant additions and removals will no longer be permitted.
      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 - Include a list of participants in the response
      includeMatches - Include a list of matches in the response
      onSuccess - Called with result if call was successful
      onFailure - Called with exception if call was not successful

    • getParticipants

      java.util.List<ParticipantWrapper> getParticipants​(java.lang.String tournament) throws DataAccessException
      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:
      The tournaments participants
      Throws:
      DataAccessException - Exchange with the rest api failed

    • getParticipants

      void getParticipants​(java.lang.String tournament, Callback<java.util.List<ParticipantWrapper>> onSuccess, Callback<DataAccessException> onFailure)
      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)
      onSuccess - Called with result if call was successful
      onFailure - Called with exception if call was not successful

    • getParticipant

      ParticipantWrapper getParticipant​(java.lang.String tournament, long participantId, boolean includeMatches) throws DataAccessException
      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 - Includes an array of associated match records
      Returns:
      The requested participant
      Throws:
      DataAccessException - Exchange with the rest api failed

    • getParticipant

      void getParticipant​(java.lang.String tournament, long participantId, boolean includeMatches, Callback<ParticipantWrapper> onSuccess, Callback<DataAccessException> onFailure)
      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 - Includes an array of associated match records
      onSuccess - Called with result if call was successful
      onFailure - Called with exception if call was not successful

    • addParticipant

      ParticipantWrapper addParticipant​(java.lang.String tournament, ParticipantQueryWrapper participant) throws DataAccessException
      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:
      The added participant
      Throws:
      DataAccessException - Exchange with the rest api failed

    • addParticipant

      void addParticipant​(java.lang.String tournament, ParticipantQueryWrapper participant, Callback<ParticipantWrapper> onSuccess, Callback<DataAccessException> onFailure)
      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
      onSuccess - Called with result if call was successful
      onFailure - Called with exception if call was not successful

    • bulkAddParticipants

      java.util.List<ParticipantWrapper> bulkAddParticipants​(java.lang.String tournament, ParticipantQueryListWrapper participants) throws DataAccessException
      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:
      The added participants
      Throws:
      DataAccessException - Exchange with the rest api failed

    • bulkAddParticipants

      void bulkAddParticipants​(java.lang.String tournament, ParticipantQueryListWrapper participants, Callback<java.util.List<ParticipantWrapper>> onSuccess, Callback<DataAccessException> onFailure)
      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
      onSuccess - Called with result if call was successful
      onFailure - Called with exception if call was not successful

    • updateParticipant

      ParticipantWrapper updateParticipant​(java.lang.String tournament, long participantId, ParticipantQueryWrapper participant) throws DataAccessException
      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:
      The updates participant
      Throws:
      DataAccessException - Exchange with the rest api failed

    • updateParticipant

      void updateParticipant​(java.lang.String tournament, long participantId, ParticipantQueryWrapper participant, Callback<ParticipantWrapper> onSuccess, Callback<DataAccessException> onFailure)
      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
      onSuccess - Called with result if call was successful
      onFailure - Called with exception if call was not successful

    • checkInParticipant

      ParticipantWrapper checkInParticipant​(java.lang.String tournament, long participantId) throws DataAccessException
      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:
      The checked in participant
      Throws:
      DataAccessException - Exchange with the rest api failed

    • checkInParticipant

      void checkInParticipant​(java.lang.String tournament, long participantId, Callback<ParticipantWrapper> onSuccess, Callback<DataAccessException> onFailure)
      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
      onSuccess - Called with result if call was successful
      onFailure - Called with exception if call was not successful

    • undoCheckInParticipant

      ParticipantWrapper undoCheckInParticipant​(java.lang.String tournament, long participantId) throws DataAccessException
      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:
      The checked out participant
      Throws:
      DataAccessException - Exchange with the rest api failed

    • undoCheckInParticipant

      void undoCheckInParticipant​(java.lang.String tournament, long participantId, Callback<ParticipantWrapper> onSuccess, Callback<DataAccessException> onFailure)
      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
      onSuccess - Called with result if call was successful
      onFailure - Called with exception if call was not successful

    • deleteParticipant

      ParticipantWrapper deleteParticipant​(java.lang.String tournament, long participantId) throws DataAccessException
      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:
      The deleted participant
      Throws:
      DataAccessException - Exchange with the rest api failed

    • deleteParticipant

      void deleteParticipant​(java.lang.String tournament, long participantId, Callback<ParticipantWrapper> onSuccess, Callback<DataAccessException> onFailure)
      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
      onSuccess - Called with result if call was successful
      onFailure - Called with exception if call was not successful

    • randomizeParticipants

      java.util.List<ParticipantWrapper> randomizeParticipants​(java.lang.String tournament) throws DataAccessException
      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:
      The randomized participants
      Throws:
      DataAccessException - Exchange with the rest api failed

    • randomizeParticipants

      void randomizeParticipants​(java.lang.String tournament, Callback<java.util.List<ParticipantWrapper>> onSuccess, Callback<DataAccessException> onFailure)
      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)
      onSuccess - Called with result if call was successful
      onFailure - Called with exception if call was not successful

    • getMatches

      java.util.List<MatchWrapper> getMatches​(java.lang.String tournament, java.lang.Long participantId, MatchState state) throws DataAccessException
      Retrieve a tournament's match 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)
      participantId - Only retrieve matches that include the specified participant. This parameter is optional. Provide null if you want to skip it.
      state - all (default), pending, open, complete. This parameter is optional. Provide null if you want to skip it.
      Returns:
      The tournament's matches
      Throws:
      DataAccessException - Exchange with the rest api failed

    • getMatches

      void getMatches​(java.lang.String tournament, java.lang.Long participantId, MatchState state, Callback<java.util.List<MatchWrapper>> onSuccess, Callback<DataAccessException> onFailure)
      Retrieve a tournament's match 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)
      participantId - Only retrieve matches that include the specified participant. This parameter is optional. Provide null if you want to skip it.
      state - all (default), pending, open, complete. This parameter is optional. Provide null if you want to skip it.
      onSuccess - Called with result if call was successful
      onFailure - Called with exception if call was not successful

    • getMatch

      MatchWrapper getMatch​(java.lang.String tournament, long matchId, boolean includeAttachments) throws DataAccessException
      Retrieve a single match 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)
      matchId - The match's unique ID
      includeAttachments - Include an array of associated attachment records
      Returns:
      The requested match
      Throws:
      DataAccessException - Exchange with the rest api failed

    • getMatch

      void getMatch​(java.lang.String tournament, long matchId, boolean includeAttachments, Callback<MatchWrapper> onSuccess, Callback<DataAccessException> onFailure)
      Retrieve a single match 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)
      matchId - The match's unique ID
      includeAttachments - Include an array of associated attachment records
      onSuccess - Called with result if call was successful
      onFailure - Called with exception if call was not successful

    • updateMatch

      MatchWrapper updateMatch​(java.lang.String tournament, long matchId, MatchQueryWrapper match) throws DataAccessException
      Update/submit the score(s) for a match.
      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)
      matchId - The match's unique ID
      match - The match data
      Returns:
      The updated match
      Throws:
      DataAccessException - Exchange with the rest api failed

    • updateMatch

      void updateMatch​(java.lang.String tournament, long matchId, MatchQueryWrapper match, Callback<MatchWrapper> onSuccess, Callback<DataAccessException> onFailure)
      Update/submit the score(s) for a match.
      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)
      matchId - The match's unique ID
      match - The match data
      onSuccess - Called with result if call was successful
      onFailure - Called with exception if call was not successful

    • markMatchAsUnderway

      MatchWrapper markMatchAsUnderway​(java.lang.String tournament, long matchId) throws DataAccessException
      Marks a match as underway
      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)
      matchId - The match's unique ID
      Returns:
      The updated match
      Throws:
      DataAccessException - Exchange with the rest api failed

    • markMatchAsUnderway

      void markMatchAsUnderway​(java.lang.String tournament, long matchId, Callback<MatchWrapper> onSuccess, Callback<DataAccessException> onFailure)
      Marks a match as underway
      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)
      matchId - The match's unique ID
      onSuccess - Called with result if call was successful
      onFailure - Called with exception if call was not successful

    • unmarkMatchAsUnderway

      MatchWrapper unmarkMatchAsUnderway​(java.lang.String tournament, long matchId) throws DataAccessException
      Unmarks a match as underway
      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)
      matchId - The match's unique ID
      Returns:
      The updated match
      Throws:
      DataAccessException - Exchange with the rest api failed

    • unmarkMatchAsUnderway

      void unmarkMatchAsUnderway​(java.lang.String tournament, long matchId, Callback<MatchWrapper> onSuccess, Callback<DataAccessException> onFailure)
      Marks a match as underway
      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)
      matchId - The match's unique ID
      onSuccess - Called with result if call was successful
      onFailure - Called with exception if call was not successful

    • reopenMatch

      MatchWrapper reopenMatch​(java.lang.String tournament, long matchId) throws DataAccessException
      Reopens a match that was marked completed, automatically resetting matches that follow it
      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)
      matchId - The match's unique ID
      Returns:
      The reopened match
      Throws:
      DataAccessException - Exchange with the rest api failed

    • reopenMatch

      void reopenMatch​(java.lang.String tournament, long matchId, Callback<MatchWrapper> onSuccess, Callback<DataAccessException> onFailure)
      Reopens a match that was marked completed, automatically resetting matches that follow it
      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)
      matchId - The match's unique ID
      onSuccess - Called with result if call was successful
      onFailure - Called with exception if call was not successful

    • getAttachments

      java.util.List<AttachmentWrapper> getAttachments​(java.lang.String tournament, long matchId) throws DataAccessException
      Retrieve a match's attachments.
      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)
      matchId - The match's unique ID
      Returns:
      The match attachments
      Throws:
      DataAccessException - Exchange with the rest api failed

    • getAttachments

      void getAttachments​(java.lang.String tournament, long matchId, Callback<java.util.List<AttachmentWrapper>> onSuccess, Callback<DataAccessException> onFailure)
      Retrieve a match's attachments.
      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)
      matchId - The match's unique ID
      onSuccess - Called with result if call was successful
      onFailure - Called with exception if call was not successful

    • getAttachment

      AttachmentWrapper getAttachment​(java.lang.String tournament, long matchId, long attachmentId) throws DataAccessException
      Retrieve a single match attachment record.
      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)
      matchId - The match's unique ID
      attachmentId - The attachment's unique ID
      Returns:
      The requested attachment
      Throws:
      DataAccessException - Exchange with the rest api failed

    • getAttachment

      void getAttachment​(java.lang.String tournament, long matchId, long attachmentId, Callback<AttachmentWrapper> onSuccess, Callback<DataAccessException> onFailure)
      Retrieve a single match attachment record.
      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)
      matchId - The match's unique ID
      attachmentId - The attachment's unique ID
      onSuccess - Called with result if call was successful
      onFailure - Called with exception if call was not successful

    • createAttachment

      AttachmentWrapper createAttachment​(java.lang.String tournament, long matchId, AttachmentQuery attachment) throws DataAccessException
      Add a file, link, or text attachment to a match. NOTE: The associated tournament's "accept_attachments" attribute must be true for this action to succeed.

      At least 1 of the 3 optional parameters (asset, url or description in the enumeration object) must be provided. Files up to 25MB are allowed for tournaments hosted by Challonge Premier subscribers.

      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)
      matchId - The match's unique ID
      attachment - The attachment to create
      Returns:
      The created attachment
      Throws:
      DataAccessException - Exchange with the rest api failed

    • createAttachment

      void createAttachment​(java.lang.String tournament, long matchId, AttachmentQuery attachment, Callback<AttachmentWrapper> onSuccess, Callback<DataAccessException> onFailure)
      Add a file, link, or text attachment to a match. NOTE: The associated tournament's "accept_attachments" attribute must be true for this action to succeed.

      At least 1 of the 3 optional parameters (asset, url or description in the enumeration object) must be provided. Files up to 25MB are allowed for tournaments hosted by Challonge Premier subscribers.

      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)
      matchId - The match's unique ID
      attachment - The attachment to create
      onSuccess - Called with result if call was successful
      onFailure - Called with exception if call was not successful

    • updateAttachment

      AttachmentWrapper updateAttachment​(java.lang.String tournament, long matchId, long attachmentId, AttachmentQuery attachment) throws DataAccessException
      Update the attributes of a match attachment.

      Sending the asset does neither work with base64 nor with a multipart-form-data request

      At least 1 of the 3 optional parameters (asset, url or description in the enumeration object) must be provided. Files up to 25MB are allowed for tournaments hosted by Challonge Premier subscribers.

      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)
      matchId - The match's unique ID
      attachmentId - The attachment's unique ID
      attachment - The attachment to update
      Returns:
      The updated attachment
      Throws:
      DataAccessException - Exchange with the rest api failed

    • updateAttachment

      void updateAttachment​(java.lang.String tournament, long matchId, long attachmentId, AttachmentQuery attachment, Callback<AttachmentWrapper> onSuccess, Callback<DataAccessException> onFailure)
      Update the attributes of a match attachment.

      Sending the asset does neither work with base64 nor with a multipart-form-data request

      At least 1 of the 3 optional parameters (asset, url or description in the enumeration object) must be provided. Files up to 25MB are allowed for tournaments hosted by Challonge Premier subscribers.

      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)
      matchId - The match's unique ID
      attachmentId - The attachment's unique ID
      attachment - The attachment to update
      onSuccess - Called with result if call was successful
      onFailure - Called with exception if call was not successful

    • deleteAttachment

      AttachmentWrapper deleteAttachment​(java.lang.String tournament, long matchId, long attachmentId) throws DataAccessException
      Delete a match attachment.
      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)
      matchId - The match's unique ID
      attachmentId - The attachment's unique ID
      Returns:
      The deleted attachment
      Throws:
      DataAccessException - Exchange with the rest api failed

    • deleteAttachment

      void deleteAttachment​(java.lang.String tournament, long matchId, long attachmentId, Callback<AttachmentWrapper> onSuccess, Callback<DataAccessException> onFailure)
      Delete a match attachment.
      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)
      matchId - The match's unique ID
      attachmentId - The attachment's unique ID
      onSuccess - Called with result if call was successful
      onFailure - Called with exception if call was not successful