Attendee

Attendee

An Attendee is a person who attendeed a tournament. This is equivalent to Participant in Smash.gg's context.

Constructor

Attendee(
    id: number,
    gamerTag: string,
    prefix: string | null,
    createdAt: number | null,
    claimed: boolean | null,
    verified: boolean | null,
    playerId: number | null,
    phoneNumber: number | null,
    connectedAccounts: object | null,
    contactInfo: IAttendee.ContactInfo | null,
    eventIds: number[] | null
)

Properties

• id
  • number
• gamerTag
  • string
• prefix
  • string | null
• createdAt
  • number | null
• claimed
  • boolean | null
• verified
  • boolean | null
• playerId
  • number | null
• phoneNumber
  • number | null
• connectedAccounts
  • object | null
• contactInfo
  • IAttendee.ContactInfo | null
• eventIds
  • number[] | null

Methods

• getId()
  • get the numeric id for the Attendee in the tournament
  • returns number
• getGamerTag()
  • get the gamer tag of the Attendee
  • returns string
• getSponsor()
  • get the sponsor prefix of the Attendee
  • returns string | null
• getCreatedAt()
  • get the unix epoch of when this Attendee was created
  • returns number | null
• getClaimed()
  • get the true/false value of if this Attendee is claimed by a user
  • returns boolean | null
• getVerified()
  • get the true/false value of if this Attendee is verified
  • returns boolean | null
• getPlayerId()
  • get the numeric identifier of the associated User object
  • returns number | null
• getPhoneNumber()
  • get the phone number of the Attendee
  • returns number | null
• getContactInfo()
  • get the contact info of the Attendee
  • returns ContactInfo | null
• getCity()
  • get the city the Attendee is from
  • returns string | null
• getState()
  • get the state the Attendee is from
  • returns string | null
• getStateId()
  • get the numeric id of the state the Attendee is from
  • returns number | null
• getCountry()
  • get the country the Attendee is from
  • returns string | null
• getCountryId()
  • get the numeric id of the country the Attendee is from
  • returns number | null
• getContactName()
  • get the contact name of the Attendee
  • returns string | null
• getFirstName()
  • get the first name of the Attendee
  • returns string | null
• getLastName()
  • get the last name of the Attendee
  • returns string | null
• getZipcode()
  • get the zip code of the Attendee
  • returns string | null
• getConnectedAccounts()
  • get a list of connected accounts to this Attendee
  • returns object | null
• async getUserAccount()
  • get the corresponding smash.gg User object associated with this Attendee
  • returns Promise resolving User
• async getEnteredPhases()
  • get list of Phases that this Attendee entered
  • returns Promise resolving a list of Phase objects
• async getEnteredPhaseGroups()
  • get list of Phase Groups that this Attendee entered
  • returns Promise resolving a list of PhaseGroup objects

AttendeeOptions

{
    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
        }
    }
}

---