0.3.0

tabroom-api/dev.gmitch215.tabroom.api.user

Package-level declarations

Types

data class NSDAUser(val fullName: String, val memberId: Int, val meritPoints: Int, val pointsToNextDegree: Int, val lastPointsDate: String)

Represents a user connected to a NSDA account.

data class Round(val label: String, val start: String, val room: String, val docShareLink: String, val data: List<RoundData>)

Represents a round in a tournament that a user is competiting in.

data class RoundData(val judge: Judge, val judgeParadigm: String, val ballot: Ballot?, val rfd: String?)

Represents the result data for a round.

data class Session(val lastActiveTime: String?, val lastActiveDate: String?, val browser: String, val ip: String, val isp: String?, val location: String?)

Represents a session for a user.

TournamentEntry

data class TournamentEntry(val tournament: Tournament, val date: String, val code: String, val division: String, val rounds: List<Round>)

Represents a historical tournament entry for a user.

data class User(val email: String, val firstName: String, val middleName: String?, val lastName: String, val phoneNumber: String, val pronouns: String, val timeZone: String, val address: String?, val city: String, val state: String, val country: String, val zipCode: Int, val nsda: NSDAUser?)

Represents a logged-in user on Tabroom.

Functions

getCurrentSessions

@JvmName(name = "getCurrentSessionsAsync")

suspend fun getCurrentSessions(): List<Session>

Fetches the current sessions for the user when logged in.

@JvmName(name = "getCurrentUserAsync")

suspend fun getCurrentUser(): User

Fetches the current user from Tabroom.

getCurrentUserAsPromise

fun getCurrentUserAsPromise(): Promise<User>

Fetches the current user from Tabroom.

getCurrentUserSync

@JvmName(name = "getCurrentUser")

fun getCurrentUserSync(): User

Fetches the current user from Tabroom.

getEntryHistory

@JvmName(name = "getEntryHistoryAsync")

suspend fun getEntryHistory(limit: Int = 10): List<TournamentEntry>

Fetches the entry history of the current user.

getEntryHistoryAsPromise

fun getEntryHistoryAsPromise(): Promise<List<TournamentEntry>>

Gets the entry history for the current user.

getEntryHistorySync

@JvmName(name = "getEntryHistory")

fun getEntryHistorySync(): List<TournamentEntry>

Gets the entry history for the current user.

getJudgeParadigm

@JvmName(name = "getJudgeParadigmAsync")

suspend fun getJudgeParadigm(judgeId: Int): String

Fetches the judge paradigm for a given judge ID.

getJudgeParadigmAsPromise

fun getJudgeParadigmAsPromise(judgeId: Int): Promise<String>

Gets the judge paradigm for a judge by their ID.

getJudgeParadigmSync

@JvmName(name = "getJudgeParadigm")

fun getJudgeParadigmSync(judgeId: Int): String

Gets the judge paradigm for a judge by their ID.

getRoundResults

@JvmName(name = "getRoundResultsAsync")

suspend fun getRoundResults(tourneyId: Int, studentId: Int): List<Round>

Gets the round results for the current user.

getRoundResultsAsPromise

fun getRoundResultsAsPromise(tourneyId: Int, studentId: Int): Promise<List<Round>>

Gets the round results for a student in a tournament.

getRoundResultsSync

@JvmName(name = "getRoundResults")

fun getRoundResultsSync(tourneyId: Int, studentId: Int): List<Round>

Gets the round results for a student in a tournament.