Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ActivityRedemption

A redemption for an activity

constructor
param

Hierarchy

  • Base
    • ActivityRedemption

Index

Constructors

Properties

Methods

Constructors

constructor

  • new ActivityRedemption(__namedParameters: { badgeCode: undefined | string; badge_code: undefined | string; eventActivityId: undefined | number; event_activity_id: undefined | number; id: undefined | number; name: undefined | string; overrideReason: undefined | null | string; override_reason: undefined | null | string; scanTime: undefined | Date; scanTimes: undefined | Date[]; scan_time: undefined | Date; scan_times: undefined | Date[]; userId: undefined | number; user_id: undefined | number; volunteerId: undefined | number; volunteer_id: undefined | number }): ActivityRedemption

  • Creates an ActivityRedemption instance

    constructor

    Parameters

    • __namedParameters: { badgeCode: undefined | string; badge_code: undefined | string; eventActivityId: undefined | number; event_activity_id: undefined | number; id: undefined | number; name: undefined | string; overrideReason: undefined | null | string; override_reason: undefined | null | string; scanTime: undefined | Date; scanTimes: undefined | Date[]; scan_time: undefined | Date; scan_times: undefined | Date[]; userId: undefined | number; user_id: undefined | number; volunteerId: undefined | number; volunteer_id: undefined | number }
      • badgeCode: undefined | string
      • badge_code: undefined | string
      • eventActivityId: undefined | number
      • event_activity_id: undefined | number
      • id: undefined | number
      • name: undefined | string
      • overrideReason: undefined | null | string
      • override_reason: undefined | null | string
      • scanTime: undefined | Date
      • scanTimes: undefined | Date[]
      • scan_time: undefined | Date
      • scan_times: undefined | Date[]
      • userId: undefined | number
      • user_id: undefined | number
      • volunteerId: undefined | number
      • volunteer_id: undefined | number

    Returns ActivityRedemption

Properties

Optional badgeCode

badgeCode: undefined | string

Optional eventActivityId

eventActivityId: undefined | number

Optional id

id: undefined | number

Optional name

name: undefined | string

Optional overrideReason

overrideReason: string | null

Optional scanTime

scanTime: Date

Optional scanTimes

scanTimes: Date[]

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 userId

userId: undefined | number

Optional volunteerId

volunteerId: undefined | number

Methods

toHackerAPIFormat

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

Static create

  • create(__namedParameters: { slug: string | number }, redemption: ActivityRedemption, token?: undefined | string): 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: number }, token?: undefined | string): Promise<null>

  • Creates a new redemption

    Parameters

    • __namedParameters: { slug: string | number }
      • slug: string | number
    • __namedParameters: { id: number }
      • id: number
    • 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 fetchAll

  • fetchAll(__namedParameters: { slug: string | number }, redemption: ActivityRedemption, token?: undefined | string): 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]

Generated using TypeDoc