com.exsoloscript.challonge.handler.retrofit

Interface RetrofitMatchHandler

public interface RetrofitMatchHandler

Match related API bindings

Version:

20160822.1

Author:

EXSolo

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<Match>	getMatch(String tournament, int matchId, int includeAttachments) Retrieve a single match record for a tournament.
retrofit2.Call<List<Match>>	getMatches(String tournament, Integer participantId, MatchState state) Retrieve a tournament's match list.
retrofit2.Call<Match>	updateMatch(String tournament, int matchId, MatchQuery match) Update/submit the score(s) for a match.

Method Detail

getMatches

@GET(value="tournaments/{tournament}/matches.json")
retrofit2.Call<List<Match>> getMatches(@Path(value="tournament")
                                                                                            String tournament,
                                                                                            @Query(value="participant_id")
                                                                                            Integer participantId,
                                                                                            @Query(value="state")
                                                                                            MatchState state)

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:

Call

getMatch

@GET(value="tournaments/{tournament}/matches/{match_id}.json")
retrofit2.Call<Match> getMatch(@Path(value="tournament")
                                                                                               String tournament,
                                                                                               @Path(value="match_id")
                                                                                               int matchId,
                                                                                               @Query(value="include_attachments")
                                                                                               int includeAttachments)

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 - 0 or 1; include an array of associated attachment records

Returns:

Call

updateMatch

@PUT(value="tournaments/{tournament}/matches/{match_id}.json")
retrofit2.Call<Match> updateMatch(@Path(value="tournament")
                                                                                                  String tournament,
                                                                                                  @Path(value="match_id")
                                                                                                  int matchId,
                                                                                                  @Body
                                                                                                  MatchQuery match)

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:

Call