Finish Command

Finish requires APL 1.3 or later. Provide an alternate experience for devices running older versions of APL.

Closes the current APL document and exits.

Properties

The Finish command has no properties other than the common command properties. Set the type property to Finish.

Combine Finish with other commands

Running the finish command stops all other processing in APL, including any commands that are still running. For example, to run both SendEvent and Finish on a button press, you must write them in the following order:

{
  "onPress": [
    {
      "type": "SendEvent",
      "arguments": [
        "now stopping"
      ]
    },
    {
      "type": "Finish"
    }
  ]
}

If you write the commands in the reverse order, SendEvent never runs.

The finish command runs in both normal and fast mode.

Was this page helpful?

Last updated: frontmatter-missing