Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Match

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

api_key

api_key: string

attachment_count

attachment_count: number

attachments

attachments: Attachment[]

baseUrl

baseUrl: string

created_at

created_at: Date

group_id

group_id: number

has_attachment

has_attachment: false

id

id: number

identifier

identifier: string

location

location: string

loser_id

loser_id: number

player1_id

player1_id: number

player1_is_prereq_match_loser

player1_is_prereq_match_loser: boolean

player1_prereq_match_id

player1_prereq_match_id: number

player1_votes

player1_votes: number

player2_id

player2_id: number

player2_is_prereq_match_loser

player2_is_prereq_match_loser: boolean

player2_prereq_match_id

player2_prereq_match_id: number

player2_votes

player2_votes: number

prerequisite_match_ids_csv

prerequisite_match_ids_csv: string

round

round: number

scheduled_time

scheduled_time: Date

scores_csv

scores_csv: string

started_at

started_at: Date

state

state: matchStateType

tournament_id

tournament_id: number

underway_at

underway_at: Date

updated_at

updated_at: Date

winner_id

winner_id: number

Methods

createAttachment

  • 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.

    Parameters

    Returns Promise<Attachment>

get

  • Retrieve a single match record for a tournament.

    Returns Promise<Match>

getAllAttachments

Private processAttachment

Private processAttachments

  • processAttachments(attachments: any): Attachment[]

reopen

  • reopen(): Promise<Match>

  • Reopens a match that was marked completed, automatically resetting matches that follow it

    Returns Promise<Match>

selectWinner

  • selectWinner(winner_id: number, scores: string): Promise<Match>

  • Choose winner passing in a participant id and the scores in csv format

    Parameters

    • winner_id: number
    • scores: string

    Returns Promise<Match>

update

Generated using TypeDoc