finish Action

An action to finish this instance of an Alfred UI, either closing it, or returning context back to Alfred.

{
  "finish": {
    "args": [
      "banana",
      "orange"
    ]
  }
}

Properties

flattenarrayargs
BOOL
Default: false

Recursively flatten any arrays in the args array into a single array.

args
STRING | ARRAY

The arg(s) to output when finishing, which can take {value:self.param} and {value:componentid.param} in addition to arbitrary strings and {var:variablename}.

In the context of a workflow, this will be passed out of the workflow object to connected objects.

variables
OBJECT

Variable key value pairs to output when finishing, which can take {value:self.param} and {value:componentid.param} in addition to arbitrary strings and {var:variablename}.

In the context of a workflow, this will merge the variables into the workflow object stream variables.

Examples

Close UI and output arguments

{
  "type": "button",
  "text": "Close UI and pass along arguments",
  "events": [
    {
      "triggers": "actioned",
      "action": {
        "type": "json",
        "src": {
          "finish": {
            "args": [
              "banana",
              "orange"
            ]
          }
        }
      }
    }
  ]
}