Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Template

A container for building a mail template to be triggered by an action related to an event.

class
extends

{ HackerAPI.Base }

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Template(__namedParameters?: { description: undefined | string; html: undefined | string; id: undefined | number; name: undefined | string; slug: undefined | string; subject: undefined | string; trigger: Trigger }): Template

  • Creates a new mail template. Must be passed to an appropriate handler to actual update the backend api.

    Parameters

    • Default value __namedParameters: { description: undefined | string; html: undefined | string; id: undefined | number; name: undefined | string; slug: undefined | string; subject: undefined | string; trigger: Trigger } = {}
      • description: undefined | string
      • html: undefined | string
      • id: undefined | number
      • name: undefined | string
      • slug: undefined | string
      • subject: undefined | string
      • trigger: Trigger

    Returns Template

Properties

Optional description

description: undefined | string

Optional html

html: undefined | string

Optional id

id: undefined | number

Optional name

name: undefined | string

Optional slug

slug: 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 subject

subject: undefined | string

trigger

trigger: Trigger

Methods

toHackerAPIFormat

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

Static create

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

  • Adds a mail template for the event.

    Parameters

    • __namedParameters: { slug: string | number }
      • slug: string | number
    • mailTemplate: Template

      Template to POST to server

    • Optional token: undefined | string

      Token to use with request

    Returns Promise<{}>

    The response 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 delete

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

  • Deletes a mail template on hackerapi

    Parameters

    • __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 fetch

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

  • Fetches a mail template from hackerapi

    Parameters

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

    Returns Promise<{}>

Static fetchAll

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

  • Gets all the mail templates for the given event from HackerAPI.

    Parameters

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

    Returns Promise<{}>

    The templates

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(template: Template, token?: undefined | string): Promise<{}>

Generated using TypeDoc