Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Activity

A container for data related to an event activity

class
extends

{ HackerAPI.Base }

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Activity(__namedParameters?: { category: undefined | string; endTime: undefined | Date; end_time: undefined | Date; eventId: undefined | number; event_id: undefined | number; id: undefined | number; location: undefined | string; name: undefined | string; restrictions: any; startTime: undefined | Date; start_time: undefined | Date }): Activity

  • Creates a new Activity instance.

    constructor

    Parameters

    • Default value __namedParameters: { category: undefined | string; endTime: undefined | Date; end_time: undefined | Date; eventId: undefined | number; event_id: undefined | number; id: undefined | number; location: undefined | string; name: undefined | string; restrictions: any; startTime: undefined | Date; start_time: undefined | Date } = {}
      • category: undefined | string
      • endTime: undefined | Date
      • end_time: undefined | Date
      • eventId: undefined | number
      • event_id: undefined | number
      • id: undefined | number
      • location: undefined | string
      • name: undefined | string
      • restrictions: any
      • startTime: undefined | Date
      • start_time: undefined | Date

    Returns Activity

Properties

Optional category

category: undefined | string

Optional endTime

endTime: Date

Optional eventId

eventId: undefined | number

Optional id

id: undefined | number

Optional location

location: undefined | string

Optional name

name: undefined | string

Optional restrictions

restrictions: any

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 startTime

startTime: Date

Methods

toHackerAPIFormat

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

Static create

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

  • Creates an activity on hackerapi

    Parameters

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

    Returns Promise<{}>

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 delete

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

  • Deletes a specific activity for an event

    Parameters

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

    Returns Promise<null>

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 a specific activity for an 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 activities for an event

    Parameters

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

    Returns Promise<{}[]>

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]

Static update

  • update(__namedParameters: { slug: string | number }, activity: Activity, token?: undefined | string): Promise<{}>

  • Updates an activity on hackerapi

    Parameters

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

    Returns Promise<{}>

Generated using TypeDoc