NSUserAutomatorTask Class Reference

Inherits from
Conforms to
Framework
/System/Library/Frameworks/Foundation.framework
Availability
Available in OS X v10.8 and later.
Declared in
NSUserScriptTask.h

Overview

The NSUserAutomatorTask class is intended to run Automator workflows from your application. It is intended to execute user-supplied workflows, and will execute them outside of the application's sandbox, if any.

The class is not intended to execute scripts built into an application; for that, use one of the NSTask or AMWorkflow classes. If the application is sandboxed, then the script must be in the NSApplicationScriptsDirectory folder. A sandboxed application may read from, but not write to, this folder.

If you simply need to execute scripts without regard to input or output, use NSUserScriptTask, which can execute any of the specific types. If you need specific control over the input to or output from the workflow, use this class.

Tasks

Executing Automator Tasks

Properties

variables

The variables required by the Automator workflow.

@property(copy) NSDictionary *variables
Availability
  • Available in OS X v10.8 and later.
Declared In
NSUserScriptTask.h

Instance Methods

executeWithInput:completionHandler:

Execute the Automator workflow by providing it as securely coded input.

- (void)executeWithInput:(id < NSSecureCoding >)input completionHandler:(NSUserAutomatorTaskCompletionHandler)handler
Parameters
input

The automator task.

handler

The completion handler Block that returns the result or an error. See NSUserAutomatorTaskCompletionHandler.

Discussion

The Automator workflow will execute using the variables property values.

This method should be invoked no more than once for a given instance of the class.

If the script completed normally, the completion handler's error parameter will be nil.

Availability
  • Available in OS X v10.8 and later.
See Also
Declared In
NSUserScriptTask.h

Constants

NSUserAutomatorTaskCompletionHandler

Implement this block to retrieve the output of the Automator workflow executed by executeWithInput:completionHandler:.

typedef void (^NSUserAutomatorTaskCompletionHandler)(id result, NSError *error);
Availability
  • Available in OS X v10.8 and later.
Declared In
NSUserScriptTask.h