Options
All
  • Public
  • Public/Protected
  • All
Menu

Action

In addition to being able to lookup an action using the find method, a single global action object is created and available in scripts to inquire about the current action and control flow.

Example

// find action
let action = Action.find("Copy");
// queue to action to run after the current action
app.queueAction(action, draft);

Hierarchy

  • Action

Index

Properties

Methods

Properties

name

name: string

The display name of the action as displayed in the action list.

Methods

Static find

  • find(name: string): Action | undefined
  • Search for action matching the name passed and return it if found. Useful to lookup and action and queue it to be run using app.queueAction(action, draft)

    Parameters

    • name: string

      Name of a valid, installed action.

    Returns Action | undefined

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc