If AppleScripts run using the AppleScript object return values, they will be converted to JavaScript object and stored in this array. See AppleScript docs for details.
If Callback URL or Run Shortcut action steps using the "Wait for response" option have been run in steps before the script step in an action, and the target app returned to Drafts using an x-success callback, this object will contain an array of objects with the parsed query parameters included in those responses, in the order they were received.
If HTML Preview makes calls to Drafts.send(key, value)
those values are stored in this object by key
.
Used only when calling a Drafts action from another app via x-callback-url with a /runAction
URL. Any parameters set via this method will be included as query args when calling the provided x-success
parameter. As an example, the below:
context.addSuccessParameter("a", "1");
context.addSuccessParameter("b", "2");
Would result in the parameters ?a=1&b=2
being added to the x-success
callback.
The name for the parameter
A string value for the parameter. Do not URL encode this value, it will be encoded when added to the callback URL.
Tell the context to cancel the action at the end of the script execution. If called, at the end of the script the action will be stopped. No subsequent action steps in the action will run, and the action still stop silently - no notification banners, sounds, etc. If a message is included it will be added to the action log to explain the cancellation.
A single global "context" object is available to scripts to control flow of the currently running action.
It is important to understand that
cancel()
andfail()
will not immediately stop script, just stop any further action steps from being performed.Example
Control Flow
Retreive values