Class Trigger

Data container for mail triggers

class
extends: { HackerAPI.Base }

Hierarchy

Base
- Trigger

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Trigger(__namedParameters?: { recordId: undefined | number; recordType: undefined | Record; record_id: undefined | number; record_type: undefined | Record; triggerType: undefined | string; trigger_type: undefined | string }): Trigger

Overrides Base.constructor
- Defined in email/trigger/trigger.ts:95
Creates a new instance

constructor

Parameters
- Default value __namedParameters: { recordId: undefined | number; recordType: undefined | Record; record_id: undefined | number; record_type: undefined | Record; triggerType: undefined | string; trigger_type: undefined | string } = {}
  - recordId: undefined | number
  - recordType: undefined | Record
  - record_id: undefined | number
  - record_type: undefined | Record
  - triggerType: undefined | string
  - trigger_type: undefined | string
Returns Trigger

Properties

Optional recordId

recordId: undefined | number

Optional recordType

recordType: Record

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 triggerType

triggerType: undefined | string

Accessors

Static ON_CLAIM_CREATE

get ON_CLAIM_CREATE(): string

- Defined in email/trigger/trigger.ts:30
Trigger type for claim creation

Returns string

Static ON_CLAIM_DELETE

get ON_CLAIM_DELETE(): string

- Defined in email/trigger/trigger.ts:46
Trigger type for claim delete

Returns string

Static ON_CLAIM_UPDATE

get ON_CLAIM_UPDATE(): string

- Defined in email/trigger/trigger.ts:38
Trigger type for claim update

Returns string

Static ON_EMAIL_UPDATE

get ON_EMAIL_UPDATE(): string

- Defined in email/trigger/trigger.ts:54
Trigger type for email update

Returns string

Static ON_FILE_CREATE

get ON_FILE_CREATE(): string

- Defined in email/trigger/trigger.ts:62
Trigger type for file creation

Returns string

Static ON_MAILING_LIST_SIGNUP

get ON_MAILING_LIST_SIGNUP(): string

- Defined in email/trigger/trigger.ts:22
Trigger type for mailing list signups

Returns string

Static ON_USER_CREATE

get ON_USER_CREATE(): string

- Defined in email/trigger/trigger.ts:70
Trigger type for user creation

Returns string

Static ON_USER_DELETE

get ON_USER_DELETE(): string

- Defined in email/trigger/trigger.ts:86
Trigger type for user deletion

Returns string

Static ON_USER_UPDATE

get ON_USER_UPDATE(): string

- Defined in email/trigger/trigger.ts:78
Trigger type for user update

Returns string

Static Record

get Record(): Record

- Defined in email/trigger/trigger.ts:93
Returns Record

Methods

toHackerAPIFormat

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

Inherited from Base.toHackerAPIFormat
- Defined in base/base.ts:88
Converts an object to hackerapi object notation

Parameters
- Optional method: undefined | string
Returns {}
- [key: string]: JSONObject

Static dateHandler

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

Inherited from Base.dateHandler
- Defined in base/base.ts:29
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[]

Inherited from Base.dateTimeHandler
- Defined in base/base.ts:42
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)[]

Inherited from Base.doNotSendHandler
- Defined in base/base.ts:56
Does not send the field to hackerapi

Parameters
- key: string
- _: any
Returns (undefined | string)[]

key: [0], value: [1]

Static renameHandler

renameHandler(renamedKey: string): (Anonymous function)

Inherited from Base.renameHandler
- Defined in base/base.ts:69
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