[][src]Module splits_io_api::race

The race module handles retrieving Races. A Race is a competition between multiple Runners.

API Documentation

Structs

Settings

The settings for a Race.

UpdateSettings

The new properties to use for a Race when performing an update.

Enums

JoinAs

The type of racer to join the Race as.

Update

The type of update to perform on the given property.

Functions

create

Creates a new Race.

finish

Finishes the Race for the given entry.

forfeit

Forfeits the Race for the given entry.

get

Gets a Race by its ID.

get_active

Gets all the currently active Races on Splits.io.

get_chat

Gets all of the chat messages for a Race.

get_entries

Gets all of the entries for a Race.

get_entry

Gets the entry in a Race that is associated with the current user.

join

Joins the Race for the given entry.

leave

Leaves the Race for the given entry.

ready_up

Declares the given entry as ready for a Race.

send_chat_message

Sends a message in the chat for a Race.

undo_finish

Undoes a finish for the given entry in a Race.

undo_forfeit

Undoes a forfeit for the given entry in a Race.

unready

Undoes a ready for the given entry in a Race.

update

Updates a Race.