Entrant

Entrant

An Entrant is an Attendee who entered and competed in an Event. This is the same as Entrant in Smash.gg's context

Constructor

Entrant(
    id: number,
    name: string, 
    eventId: number,
    skill: number,
    attendeeData: Attendee[]
)

Properties

• id
  • number,
• name
  • string,
• eventId
  • number,
• skill
  • number,
• attendeeData
  • Attendee[]

Methods

• getId()

  • get the numeric id of the Entrant
  • returns number

• getName()

  • get the name of the Entrant
  • returns string

• getEventId()

  • get the numeric identifier of the Event the Entrant is in
  • returns number

• getSkill()

  • get the skill level of the Entrant
  • returns number

• getAttendeeData(position: number)

  • get a list of Attendee data connected to the Entrant
  • parameters
    • position
      • number
      • the array index of the desired Attendee
  • returns Attendee | Attendee[]

• getAttendeeId(position: number)

  • get the numeric id of the Attendee connected to the Entrant
  • parameters
    • position
      • number
      • the array index of the desired Attendee
  • returns number

• getGamerTag(position: number)

  • get the gamer tag of the Attendee connected to the Entrant
  • parameters
    • position
      • number
      • the array index of the desired Attendee
  • returns string

• getSponsor(position: number)

  • get the sponsor prefix of the Attendee connected to the Entrant
  • parameters
    • position
      • number
      • the array index of the desired Attendee
  • returns string | null

• getPhoneNumber(position: number)

  • get the phone number of the Attendee connected to the Entrant
  • parameters
    • position
      • number
      • the array index of the desired Attendee
  • returns number | null

• getContactInfo(position: number)

  • get the contact info of the Attendee connected to the Entrant
  • parameters
    • position
      • number
      • the array index of the desired Attendee
  • returns IAttendee.ContactInfo | null

• getCity(position: number)

  • get the city of the Attendee connected to the Entrant
  • parameters
    • position
      • number
      • the array index of the desired Attendee
  • returns string | null

• getState(position: number)

  • get the state of the Attendee connected to the Entrant
  • parameters
    • position
      • number
      • the array index of the desired Attendee
  • returns string | null

• getStateId(position: number)

  • get the numeric id of the state of the Attendee connected to the Entrant
  • parameters
    • position
      • number
      • the array index of the desired Attendee
  • returns number | null

• getCountry(position: number)

  • get the country of the Attendee connected to the Entrant
  • parameters
    • position
      • number
      • the array index of the desired Attendee
  • returns string | null

• getCountryId(position: number)

  • get the numeric id of the country of the Attendee connected to the Entrant
  • parameters
    • position
      • number
      • the array index of the desired Attendee
  • returns number | null

• getName(position: number)

  • get the name of the of the Attendee connected to the Entrant
  • parameters
    • position
      • number
      • the array index of the desired Attendee
  • returns string | null

• getFirstName(position: number)

  • get the first name of the Attendee connected to the Entrant
  • parameters
    • position
      • number
      • the array index of the desired Attendee
  • returns string | null

• getLastName(position: number)

  • get the last name of the Attendee connected to the Entrant
  • parameters
    • position
      • number
      • the array index of the desired Attendee
  • returns string | null

• getZipcode(position: number)

  • get the zip code of the Attendee connected to the Entrant
  • parameters
    • position
      • number
      • the array index of the desired Attendee
  • returns string | null

• getConnectedAccounts()

  • returns object | null

EntrantOptions

{
    page?: number | null,
    perPage?: number | null,
    sortBy?: string | null,
    filter?: null | {
        id?: number,
        entrantName?: string,
        checkInState?: number,
        phaseGroupId?: number[],
        phaseId?: number[],
        eventId?: number,
        seach?:{
            fieldsToSearch: string[],
            searchString: string
        }
    }
}

---