Class Trigger

constructor

• new Trigger(o): Trigger

• Trigger constructor

  Parameters

  • o: TriggerCfg

  Returns Trigger

action

Optional channel

configuration

Optional description

Optional id

Optional min_role

Optional name

Optional run

Optional table_id

Optional table_name

when_trigger

toJson

• get toJson(): any

• Get JSON from Trigger

  Returns any

Static abbreviated_actions

• get abbreviated_actions(): {
      disableInWorkflow: boolean;
      hasConfig: boolean;
      name: string;
      namespace: any;
      requireRow: boolean;
  }[]

• Returns {
      disableInWorkflow: boolean;
      hasConfig: boolean;
      name: string;
      namespace: any;
      requireRow: boolean;
  }[]

Static when_options

• get when_options(): string[]

• Trigger when options

  Returns string[]

clone

• clone(): Promise<Trigger>

• Clone page

  Returns Promise<Trigger>

delete

• delete(): Promise<void>

• Delete current trigger

  Returns Promise<void>

getTags

• getTags(): Promise<AbstractTag[]>

• Returns Promise<AbstractTag[]>

runWithoutRow

• runWithoutRow(runargs?): Promise<any>

• Run trigger without row

  Parameters

  • runargs: any = {}

  Returns Promise<any>

Static action_options

• action_options(__namedParameters): any[]

• Parameters

  • __namedParameters: {
        apiNeverTriggers?: boolean;
        builtInLabel?: string;
        builtIns?: string[];
        forWorkflow?: boolean;
        noMultiStep?: boolean;
        notRequireRow?: boolean;
        tableTriggers?: number;
        workflow?: boolean;
    }

    • Optional apiNeverTriggers?: boolean

    • Optional builtInLabel?: string

    • Optional builtIns?: string[]

    • Optional forWorkflow?: boolean

    • Optional noMultiStep?: boolean

    • Optional notRequireRow?: boolean

    • Optional tableTriggers?: number

    • Optional workflow?: boolean

  Returns any[]

Static create

• create(f): Promise<Trigger>

• Create trigger

  Parameters

  • f: TriggerCfg

  Returns Promise<Trigger>

Static emitEvent

• emitEvent(eventType, channel?, userPW?, payload?): void

• Emit an event: run associated triggers

  Parameters

  • eventType: string

  • channel: null | string = null

  • Optional userPW: {} = {}

  • Optional payload: any

  Returns void

Static find

• find(where?): Trigger[]

• Find triggers in State cache

  Parameters

  • Optional where: Where

    condition

  Returns Trigger[]

Static findAllWithTableName

• findAllWithTableName(): Promise<Trigger[]>

• Find all triggers

  Returns Promise<Trigger[]>

Static findDB

• findDB(where?, selectopts?): Promise<Trigger[]>

• Find triggers in DB

  Parameters

  • Optional where: Where

  • Optional selectopts: SelectOptions

  Returns Promise<Trigger[]>

Static findOne

• findOne(where): any

• Find one trigger in State cache

  Parameters

  • where: Where

  Returns any

Static getAllTableTriggers

• getAllTableTriggers(table): Trigger[]

• get triggers for a table with all when options

  Parameters

  • table: AbstractTable

  Returns Trigger[]

Static getTableTriggers

• getTableTriggers(when_trigger, table, user?): Trigger[]

• get triggers

  Parameters

  • when_trigger: string

  • table: AbstractTable

  • Optional user: Row

  Returns Trigger[]

Static hasTableTriggers

• hasTableTriggers(when_trigger, table): boolean

• get triggers

  Parameters

  • when_trigger: string

  • table: AbstractTable

  Returns boolean

Static runTableTriggers

• runTableTriggers(when_trigger, table, row, resultCollector?, user?, extraArgs?): Promise<void>

• Run table triggers

  Parameters

  • when_trigger: string

  • table: AbstractTable

  • row: Row

  • Optional resultCollector: any

  • Optional user: Row

  • Optional extraArgs: any

  Returns Promise<void>

Static sendEventToServer

• sendEventToServer(eventType, channel?, user?, payload?): Promise<void>

• Parameters

  • eventType: string

  • channel: null | string = null

  • user: {} = {}

  • Optional payload: any

  Returns Promise<void>

Static setRunFunctions

• setRunFunctions(triggers, table, user?): void

• Parameters

  • triggers: Trigger[]

  • table: AbstractTable

  • Optional user: Row

  Returns void

Static state_refresh

• state_refresh(): Promise<void>

• Returns Promise<void>

Static trigger_actions

• trigger_actions(__namedParameters): string[]

• Parameters

  • __namedParameters: {
        apiNeverTriggers?: boolean;
        noWorkflows?: boolean;
        tableTriggers?: number;
    }

    • Optional apiNeverTriggers?: boolean

    • Optional noWorkflows?: boolean

    • Optional tableTriggers?: number

  Returns string[]

Static update

• update(id, row): Promise<void>

• Update trigger

  Parameters

  • id: number

  • row: Row

  Returns Promise<void>