Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Attendee

A container for data related to an Event that a User is attending. Check out the HackerAPI.User class for modifying

struct
extends

{ HackerAPI.Base }

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Attendee(__namedParameters?: { avatar: undefined | string; badgeCodes: undefined | string[]; badge_codes: undefined | string[]; bio: undefined | string; createdAt: undefined | Date; created_at: undefined | Date; email: undefined | string; eventId: undefined | number; eventSlug: undefined | string; event_id: undefined | number; event_slug: undefined | string; id: undefined | number; mentorLocation: undefined | string; mentorSkills: undefined | string[]; mentor_location: undefined | string; mentor_skills: undefined | string[]; name: undefined | string; role: undefined | string; updatedAt: undefined | Date; updated_at: undefined | Date; user_email: undefined | string; user_id: undefined | number; user_name: undefined | string }): Attendee

  • Parameters

    • Default value __namedParameters: { avatar: undefined | string; badgeCodes: undefined | string[]; badge_codes: undefined | string[]; bio: undefined | string; createdAt: undefined | Date; created_at: undefined | Date; email: undefined | string; eventId: undefined | number; eventSlug: undefined | string; event_id: undefined | number; event_slug: undefined | string; id: undefined | number; mentorLocation: undefined | string; mentorSkills: undefined | string[]; mentor_location: undefined | string; mentor_skills: undefined | string[]; name: undefined | string; role: undefined | string; updatedAt: undefined | Date; updated_at: undefined | Date; user_email: undefined | string; user_id: undefined | number; user_name: undefined | string } = {}
      • avatar: undefined | string
      • badgeCodes: undefined | string[]
      • badge_codes: undefined | string[]
      • bio: undefined | string
      • createdAt: undefined | Date
      • created_at: undefined | Date
      • email: undefined | string
      • eventId: undefined | number
      • eventSlug: undefined | string
      • event_id: undefined | number
      • event_slug: undefined | string
      • id: undefined | number
      • mentorLocation: undefined | string
      • mentorSkills: undefined | string[]
      • mentor_location: undefined | string
      • mentor_skills: undefined | string[]
      • name: undefined | string
      • role: undefined | string
      • updatedAt: undefined | Date
      • updated_at: undefined | Date
      • user_email: undefined | string
      • user_id: undefined | number
      • user_name: undefined | string

    Returns Attendee

Properties

Optional avatar

avatar: undefined | string

Optional badgeCodes

badgeCodes: string[]

Optional bio

bio: undefined | string

Optional createdAt

createdAt: Date

Optional email

email: undefined | string

Optional eventId

eventId: undefined | number

Optional eventSlug

eventSlug: undefined | string

Optional id

id: undefined | number

Optional mentorLocation

mentorLocation: undefined | string

Optional mentorSkills

mentorSkills: string[]

Optional name

name: undefined | string

Optional role

role: undefined | string

specialHandlers

specialHandlers: {}

Type declaration

  • [key: string]: (...args: unknown[]) => [string, undefined | string]
      • (...args: unknown[]): [string, undefined | string]

      • Parameters

        • Rest ...args: unknown[]

        Returns [string, undefined | string]

Optional updatedAt

updatedAt: Date

Optional userId

userId: undefined | number

Methods

toHackerAPIFormat

  • toHackerAPIFormat(method?: undefined | string): {}

Static create

  • create(__namedParameters: { slug: string | number }, attendee: Attendee, token?: undefined | string): Promise<{}>

  • Adds an attendee to the event. Only their id and role are sent in the request. Check out HackerAPI.User for how to modify the other values

    Parameters

    • __namedParameters: { slug: string | number }
      • slug: string | number
    • attendee: Attendee

      The attendee's info

    • Optional token: undefined | string

    Returns Promise<{}>

    • The attendee returned from the server

Static dateHandler

  • dateHandler(key: string, date: string | Date): string[]

  • Converts a Javascript date (where only day, month and year are relevant) to a format understood by hackerapi

    Parameters

    • key: string
    • date: string | Date

      Doesn't do anything if string

    Returns string[]

    key: [0], value: [1]

Static dateTimeHandler

  • dateTimeHandler(key: string, datetime: string | Date): string[]

  • Converts Javascript date to a format understood by hackerapi

    Parameters

    • key: string
    • datetime: string | Date

    Returns string[]

    key: [0], value: [1]

Static doNotSendHandler

  • doNotSendHandler(key: string, _: any): (undefined | string)[]

  • Does not send the field to hackerapi

    Parameters

    • key: string
    • _: any

    Returns (undefined | string)[]

    key: [0], value: [1]

Static fetch

  • fetch(__namedParameters: { slug: string | number }, __namedParameters: { id: number }, token?: undefined | string): Promise<{}>

  • Gets the list of attendees from HackerAPI for a given event

    Parameters

    • __namedParameters: { slug: string | number }
      • slug: string | number
    • __namedParameters: { id: number }
      • id: number
    • Optional token: undefined | string

    Returns Promise<{}>

Static fetchAll

  • fetchAll(__namedParameters: { slug: string | number }, token?: undefined | string): Promise<{}[]>

  • Gets the list of attendees from HackerAPI for a given event

    Parameters

    • __namedParameters: { slug: string | number }
      • slug: string | number
    • Optional token: undefined | string

    Returns Promise<{}[]>

Static removeAttendee

  • removeAttendee(__namedParameters: { slug: string | number }, __namedParameters: { id: number }, token?: undefined | string): Promise<null>

  • Removes an attendee from this event

    Parameters

    • __namedParameters: { slug: string | number }
      • slug: string | number
    • __namedParameters: { id: number }
      • id: number
    • Optional token: undefined | string

    Returns Promise<null>

    If no error is thrown then successful delete

Static renameHandler

  • renameHandler(renamedKey: string): (Anonymous function)

  • HOC for renaming a field before sending it to hackerapi

    Parameters

    • renamedKey: string

      The string to rename the key to

    Returns (Anonymous function)

    key: [0], value: [1]

Generated using TypeDoc