Class Trigger

constructor

• new Trigger(o: TriggerCfg): Trigger

  Trigger constructor

  Parameters

  • o: TriggerCfg

  Returns Trigger

action

Optionalchannel

configuration

Optionaldescription

Optionalid

Optionalmin_role

Optionalname

Optionalrun

Optionaltable_id

Optionaltable_name

Optionalupdated_at

when_trigger

toJson

• get toJson(): any

  Get JSON from Trigger

  Returns any

Staticabbreviated_actions

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

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

Staticwhen_options

• get when_options(): string[]

  Trigger when options

  Returns string[]

authorize

• authorize(
      user: any,
      opts: { action: "get" | "post"; body?: Row; req: any; state?: Row },
  ): Promise<boolean>

  Checks plugin authorize_trigger hooks. Combine with the caller's own role/min_role check, e.g. role <= trigger.min_role || (await trigger.authorize(...)).

  Parameters

  • user: any

    the acting user (or undefined/public)

  • opts: { action: "get" | "post"; body?: Row; req: any; state?: Row }

    • action: "get" | "post"

      "get" or "post"

    • Optionalbody?: Row

      POST body, for action "post"

    • req: any

      the request object, forwarded to hooks

    • Optionalstate?: Row

      query/state, for action "get"

  Returns Promise<boolean>

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[]>

haltOnOnlyIf

• haltOnOnlyIf(row: Row, user?: Row): boolean

  Check if the trigger should halt based on the _only_if condition.

  Parameters

  • row: Row

    The current (new) row data, potentially merged with extra trigger arguments.

  • Optionaluser: Row

    The user data.

  Returns boolean

  • Returns true if the _only_if condition exists and evaluates to falsy.

runWithoutRow

• runWithoutRow(runargs?: any): Promise<any>

  Run trigger without row

  Parameters

  • runargs: any = {}

  Returns Promise<any>

Staticaction_explainers

• action_explainers(): Record<string, string>

  Returns Record<string, string>

Staticaction_options

• action_options(
      __namedParameters: {
          allTriggers?: boolean;
          apiNeverTriggers?: boolean;
          builtInLabel?: string;
          builtIns?: string[];
          forBuilder?: boolean;
          forWorkflow?: boolean;
          noMultiStep?: boolean;
          notRequireRow?: boolean;
          tableTriggers?: number;
          workflow?: boolean;
      },
  ): any[]

  Parameters

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

  Returns any[]

StaticactionsNotRequiringRow

• actionsNotRequiringRow(): string[]

  Returns string[]

Staticcreate

• create(f: TriggerCfg): Promise<Trigger>

  Create trigger

  Parameters

  • f: TriggerCfg

  Returns Promise<Trigger>

StaticemitEvent

• emitEvent(
      eventType: string,
      channel?: string | null,
      userPW?: object | User,
      payload?: any,
  ): void

  Emit an event: run associated triggers

  Parameters

  • eventType: string
  • channel: string | null = null
  • OptionaluserPW: object | User = {}
  • Optionalpayload: any

  Returns void

Staticfind

• find(where?: Where): Trigger[]

  Find triggers in State cache

  Parameters

  • Optionalwhere: Where

    condition

  Returns Trigger[]

StaticfindAllWithTableName

• findAllWithTableName(): Promise<Trigger[]>

  Find all triggers

  Returns Promise<Trigger[]>

StaticfindDB

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

  Find triggers in DB

  Parameters

  • Optionalwhere: Where
  • Optionalselectopts: SelectOptions

  Returns Promise<Trigger[]>

StaticfindOne

• findOne(where: Where): Trigger | undefined

  Find one trigger in State cache

  Parameters

  • where: Where

  Returns Trigger | undefined

StaticgetAllTableTriggers

• getAllTableTriggers(table: Table): Trigger[]

  get triggers for a table with all when options

  Parameters

  • table: Table

  Returns Trigger[]

StaticgetTableTriggers

• getTableTriggers(
      when_trigger: string,
      table: Table | null,
      user?: Row,
  ): Trigger[]

  get triggers

  Parameters

  • when_trigger: string
  • table: Table | null
  • Optionaluser: Row

  Returns Trigger[]

StatichasTableTriggers

• hasTableTriggers(when_trigger: string, table: Table): boolean

  get triggers

  Parameters

  • when_trigger: string
  • table: Table

  Returns boolean

StaticrunTableTriggers

• runTableTriggers(
      when_trigger: string,
      table: Table | null,
      row: Row,
      resultCollector?: any,
      user?: Row,
      extraArgs?: any,
  ): Promise<void>

  Run table triggers

  Parameters

  • when_trigger: string
  • table: Table | null
  • row: Row
  • OptionalresultCollector: any
  • Optionaluser: Row
  • OptionalextraArgs: any

  Returns Promise<void>

StaticsendEventToServer

• sendEventToServer(
      eventType: string,
      channel?: string | null,
      user?: {},
      payload?: any,
  ): Promise<void>

  Parameters

  • eventType: string
  • channel: string | null = null
  • user: {} = {}
  • Optionalpayload: any

  Returns Promise<void>

StaticsetRunFunctions

• setRunFunctions(triggers: Trigger[], table: Table | null, user?: Row): void

  Parameters

  • triggers: Trigger[]
  • table: Table | null
  • Optionaluser: Row

  Returns void

Staticstate_refresh

• state_refresh(): Promise<void>

  Returns Promise<void>

Statictrigger_actions

• trigger_actions(
      __namedParameters: {
          allTriggers?: boolean;
          apiNeverTriggers?: boolean;
          noWorkflows?: boolean;
          onlyWorkflows?: boolean;
          tableTriggers?: number;
      },
  ): string[]

  Parameters

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

  Returns string[]

Staticupdate

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

  Update trigger

  Parameters

  • id: number
  • row: Row

  Returns Promise<void>