AMAction

AMAction является абстрактным классом, определяющим интерфейсные и общие характеристики действий Automator. Automator является приложением Apple, позволяющим пользователям создавать и выполняться, потоки операций, состоящие из последовательности дискретных модулей, вызвали действия. Действие выполняет определенную задачу, такую как копирование файла или обрезка изображения, и передает его вывод Automator для предоставления следующему действию в потоке операций. Действия в настоящее время реализуются как загружаемые пакеты, принадлежавшие объектам AMBundleAction класс, подкласс AMAction.

Критически важный метод, объявленный AMAction, runWithInput:error:. Когда Automator выполняет поток операций, он отправляет это сообщение в каждый объект действия в потоке операций (в последовательности потока операций), в большинстве случаев передающий в выводе предыдущего действия, как введено. Объект действия выполняет свою задачу в этом методе и концах путем возврата выходного объекта для следующего действия в потоке операций.

Разделение на подклассы примечаний

Разделение на подклассы AMAction не рекомендуется. Для большинства ситуаций, требующих улучшения к платформе Automator, достаточно разделить на подклассы AMBundleAction.

Наследование

NSObject
AMAction
AMBundleAction

NSObject
AMAction
AMBundleAction

Соответствует

AnyObject
CVarArgType
Equatable
Hashable
NSObjectProtocol
Печатаемый
NSObject

Оператор импорта

Swift

import Automator

Objective C

@import Automator;

Доступность

Доступный в OS X v10.4 и позже.

Инициализация и кодирование

определение - определение (OS X v10.4)

Возвращает определение получателя.

Оператор осуждения

Удаленный по причинам производительности. Нет никакой замены.

Объявление

Objective C

- (NSMutableDictionary *)definition

Возвращаемое значение

Непостоянный словарь, содержащий текущие параметры действия, а также другой информации.

Обсуждение

Если Ваше действие имеет нестойкие данные, оно может переопределить этот метод, чтобы добавить те данные к определению, предоставленному суперклассом и возвратить его.

Специальные замечания

Этот метод был удален для обеспечения повышений производительности в конкретной реализации. Нет никакой замены.

Оператор импорта

Objective C

@import Automator;

Доступность

Доступный в OS X v10.4 и позже.
Осуждаемый в OS X v10.4.
Не доступный 64-разрядным приложениям.

См. также

– initWithDefinition:fromArchive:


    
    init (definition:fromArchive:)
    - initWithDefinition:fromArchive:

Инициализирует получатель с указанным определением.

Объявление

Swift

init!(definition dict: [NSObject : AnyObject]!, fromArchive archived: Bool)

Objective C

- (instancetype)initWithDefinition:(NSDictionary *)dict fromArchive:(BOOL)archived

Параметры

`dict`	Описывает действие, включая любые пользовательские свойства определения.
`archived`	Если получатель разархивирован, `YEStrue`, иначе `NOfalse`.

Возвращаемое значение

Инициализированное действие.

Обсуждение

Это - основной инициализатор для всех классов Automator. Приложение Automator отправляет это сообщение в экземпляры AMAction и когда это загружает пакеты действий и когда это разархивировало их.

Объект AMAction, который инстанцируют, должен выполнить любые инициализации, необходимы после вызова superреализация этого метода. Это может тогда исследовать значения в dict, особенно, если получатель был заархивирован с пользовательскими свойствами определения.

Оператор импорта

Objective C

@import Automator;

Swift

import Automator

Доступность

Доступный в OS X v10.4 и позже.

См. также

– определение
– writeToDictionary:


    
    init (contentsOfURL:error:)
    - initWithContentsOfURL:error:

Загружает действие Automator из файла URL.

Объявление

Swift

init!(contentsOfURL fileURL: NSURL!, error outError: NSErrorPointer)

Objective C

- (instancetype)initWithContentsOfURL:(NSURL *)fileURL error:(NSError **)outError

Параметры


      fileURL

URL, указывающий расположение файла действия.


      outError

Если никакое действие не найдено или если ошибка происходит в инициализации, или выполнение его, по возврату содержит экземпляр NSError это описывает проблему. Для ключей и ошибочных констант, используемых с ошибками действия, см. Ссылку Констант Automator.

Возвращаемое значение

Инициализированное действие.

Обсуждение

Этот метод обычно вызывается приложениями, использующими AMWorkflow класс для встраивания потоков операций Automator. Это используется для разрешения создания действий для потока операций.

Оператор импорта

Objective C

@import Automator;

Swift

import Automator

Доступность

Доступный в OS X v10.5 и позже.


    
    writeToDictionary (_:)
    - writeToDictionary:

Исследует параметры и другую конфигурационную информацию, указанную в переданном словаре, и добавляет его собственную информацию к нему в подходящих случаях.

Объявление

Swift

func writeToDictionary(_ dictionary: NSMutableDictionary!)

Objective C

- (void)writeToDictionary:(NSMutableDictionary *)dictionary

Параметры


      dictionary

Возможно содержит параметр и другую конфигурационную информацию о получателе.

Обсуждение

Automator отправляет это сообщение в объект действия до архивации его. В его реализации этого метода объект действия должен сначала вызвать реализацию суперкласса.

Оператор импорта

Objective C

@import Automator;

Swift

import Automator

Доступность

Доступный в OS X v10.4 и позже.

См. также

– initWithDefinition:fromArchive:

Управление действием


    
    didFinishRunningWithError:
    - didFinishRunningWithError:

(OS X v10.5)

Отправленный получателем в себя, когда это закончило работать асинхронно.

Объявление

Objective C

- (void)didFinishRunningWithError:(NSDictionary *)errorInfo

Параметры


      errorInfo

Если ошибка, произошедшая во время асинхронного выполнения действия, по возврату, содержит экземпляр NSError это описывает проблему.

Обсуждение

Переопределяющее действие runAsynchronouslyWithInput: должен вызвать didFinishRunningWithError: на завершении, так, чтобы Automator мог продолжить выполнять поток операций, из которого действие является частью.

Специальные замечания

Этот метод осуждается. Использовать finishRunningWithError: вместо этого.

Оператор импорта

Objective C

@import Automator;

Доступность

Доступный в OS X v10.5 и позже.

Осуждаемый в OS X v10.5.

См. также

– willFinishRunning

finishRunningWithError (_:) - finishRunningWithError:

Заставляет действие прекращать работать и возвращать ошибку, которую, в свою очередь, заставляет поток операций останавливать.

Объявление

Swift

func finishRunningWithError(_ error: NSError!)

Objective C

- (void)finishRunningWithError:(NSError *)error

Параметры

error

Ошибка, которая будет возвращена в Automator.

Обсуждение

Этот метод предназначается, чтобы быть вызванным любым переопределяющим действием runAsynchronouslyWithInput: для совершения асинхронных вызовов. Обратите внимание на то, что, когда finishRunningWithError: вызывается, это сразу вызывает willFinishRunning.

Оператор импорта

Objective C

@import Automator;

Swift

import Automator

Доступность

Доступный в OS X v10.7 и позже.
сброс () - сброс

Сбрасывает получатель к его начальному состоянию.

Объявление

Swift

func reset()

Objective C

- (void)reset

Обсуждение

Сброс заставляет действие выпускать свой вывод, сгенерированный от текущего выполнения потока операций.

Оператор импорта

Objective C

@import Automator;

Swift

import Automator

Доступность

Доступный в OS X v10.4 и позже.

См. также

– остановиться


    
    runAsynchronouslyWithInput (_:)
    - runAsynchronouslyWithInput:

Automator причин для ожидания уведомления, что получатель завершил выполнение, позволяющее получателю выполнять асинхронную работу.

Объявление

Swift

func runAsynchronouslyWithInput(_ input: AnyObject!)

Objective C

- (void)runAsynchronouslyWithInput:(id)input

Параметры


      input

Ввод для действия. Должен содержать один или несколько объектов, совместимых с одним из типов, указанных в действии AMAccepts свойство.

Обсуждение

Этот метод предназначается, чтобы быть переопределенным только действиями, которые должны выполнить асинхронные вызовы. После runAsynchronouslyWithInput: вызывается, Automator не продолжает, пока действие не вызывает finishRunningWithError:. Таким образом в Вашем переопределении этого метода, можно выполнить асинхронный вызов, ожидать, чтобы быть уведомленными относительно его завершения, затем вызвать finishRunningWithError: сигнализировать к Automator, что завершилось действие.

Для действий, которые не должны выполнять асинхронные вызовы, предпочтительный метод runWithInput:fromAction:error:.

Оператор импорта

Objective C

@import Automator;

Swift

import Automator

Доступность

Доступный в OS X v10.5 и позже.


    
    runWithInput (_: ошибка:)
    - runWithInput:error:

Запрашивает получатель выполнить свою задачу с помощью указанного ввода.

Объявление

Swift

func runWithInput(_ input: AnyObject!, error error: NSErrorPointer) -> AnyObject!

Objective C

- (id)runWithInput:(id)input error:(NSError **)error

Параметры


      input

Ввод для действия получения. Должен содержать один или несколько объектов, совместимых с одним из типов, указанных в действии AMAccepts свойство.


      error

Если ошибка происходит, действие возвращается NSError объект в этом параметре. Для выполнения действий код AppleScript следующие ключи могут быть указаны в userInfo свойство NSError, и их будут соблюдать.

OSAScriptErrorNumber (строковая константа) — значение для этого ключа является экземпляром NSNumber чье целочисленное значение указывает код ошибки. Посмотрите заголовочный файл MacErrors.h в платформе Ядра Углерода для списка допустимых кодов ошибки, особенно раздел по ошибкам OSA.
OSAScriptErrorMessage (строковая константа) — значение для этого ключа является экземпляром NSString описание ошибки.

Возвращаемое значение

NSArray объект, содержащий один или несколько объектов типа данных, совместимого с типом, указанным в действии получения AMProvides свойство. Если получатель не изменяет данные, переданные в input, это должно возвратить его неизменный. Если получатель не имеет никаких данных для обеспечения, это должно возвратить пустое NSArray объект.

Обсуждение

Объекты ввода и вывода для действий обычно являются экземплярами NSArray. Если получатель встречается с проблемами, он должен возвратиться косвенно NSError объект, описывающий ошибку.

Этот метод предназначается, чтобы быть переопределенным.

Оператор импорта

Objective C

@import Automator;

Swift

import Automator

Доступность

Доступный в OS X v10.7 и позже.

См. также

– сброс
– runAsynchronouslyWithInput:
– остановиться


    
    runWithInput:fromAction:error:
    - runWithInput:fromAction:error:

(OS X v10.4)

Запрашивает получатель выполнить свою задачу с помощью указанного ввода от указанного действия.

Объявление

Objective C

- (id)runWithInput:(id)input fromAction:(AMAction *)anAction error:(NSDictionary **)errorInfo

Параметры

`input`	Ввод для действия получения. Должен содержать один или несколько объектов, совместимых с одним из типов, указанных в действии `AMAccepts` свойство. По умолчанию действия могут только принять и обеспечить следующие типы. Однако путем переопределения этого метода, можно изменить типы, которые может использовать действие: Действия Objective C: Принимает и обеспечивает, типы должны наследоваться от com.apple.cocoa.string, com.apple.cocoa.path, com.apple.cocoa.url, или, запускающийся в версии 10.5 (v10.5) OS X, com.apple.cocoa.data. Действия сценария оболочки: Принимает и обеспечивает, типы должны наследоваться от com.apple.cocoa.string или, запускающийся в OS X v10.5, com.apple.cocoa.data. Действия AppleScript: Принимает и обеспечивает, типы должны наследоваться от com.apple.applescript.object.
`anAction`	Действие то, от который `input` объект был получен.
`errorInfo`	Если ошибка происходит, действие возвращает ошибочный словарь в этом параметре. Ключи и значения для этого словаря: `OSAScriptErrorNumber` (строковая константа) — значение для этого ключа является экземпляром `NSNumber` чье целочисленное значение указывает код ошибки. Посмотрите заголовочный файл `MacErrors.h` в платформе Ядра Углерода для списка допустимых кодов ошибки, особенно раздел по ошибкам OSA. `OSAScriptErrorMessage` (строковая константа) — значение для этого ключа является экземпляром `NSString` описание ошибки. Для примера того, как создать такой словарь, см. “Реализацию runWithInput:fromAction:error”: в “Реализации Действия Objective C» в Руководстве по программированию Automator.

Возвращаемое значение

Объект, содержащий один или несколько объектов типа данных, совместимого с типом, указанным в действии получения AMProvides свойство. Если получатель не изменяет данные, переданные в input, это должно возвратить его неизменный.

Обсуждение

Объекты ввода и вывода для действий обычно являются экземплярами NSArray. Если получатель встречается с проблемами, он должен возвратить косвенно ошибочный словарь, описывающий ошибку.

Этот метод предназначается, чтобы быть переопределенным. Действия AppleScript, однако, обычно не должны будут переопределять этот метод, потому что та же функциональность предоставлена сценарием AppleScript.

Оператор импорта

Objective C

@import Automator;

Доступность

Доступный в OS X v10.4 и позже.

Осуждаемый в OS X v10.4.

См. также

– сброс
– runAsynchronouslyWithInput:
– остановиться

остановитесь () - остановиться

Мешает получателю работать.

Объявление

Swift

func stop()

Objective C

- (void)stop

Обсуждение

Вывод, полученный действием во время выполнения текущего потока операций, все еще доступен для Automator.

Оператор импорта

Objective C

@import Automator;

Swift

import Automator

Доступность

Доступный в OS X v10.4 и позже.

См. также

– сброс
willFinishRunning () - willFinishRunning

Вызванный Automator, когда получатель по существу завершил свою фазу выполнения.

Объявление

Swift

func willFinishRunning()

Objective C

- (void)willFinishRunning

Обсуждение

Этот метод предназначается, чтобы быть переопределенным только действиями, которые должны выполнить асинхронные вызовы. Действие может использовать этот метод для выполнения операций очистки, таких как закрытие окон и освобождение памяти.

Оператор импорта

Objective C

@import Automator;

Swift

import Automator

Доступность

Доступный в OS X v10.5 и позже.

Инициализация и синхронизация пользовательского интерфейса действия

активированный () - активированный

Вызванный, когда окно потока операций Automator, которому принадлежит получатель, становится главным окном. Это позволяет получателю синхронизировать свою информацию с настройками в другом приложении.

Объявление

Swift

func activated()

Objective C

- (void)activated

Обсуждение

Обязательно вызовите реализацию суперкласса этого метода как последняя вещь в Вашей реализации.

Оператор импорта

Objective C

@import Automator;

Swift

import Automator

Доступность

Доступный в OS X v10.4 и позже.

См. также

– открытый
открытый () - открытый

Вызванный, когда получатель сначала добавляется к потоку операций, позволяя ему инициализировать его пользовательский интерфейс.

Объявление

Swift

func opened()

Objective C

- (void)opened

Обсуждение

Необходимо выполнить все инициализации пользовательского интерфейса действия в этом методе а не в awakeFromNib. Обязательно вызовите реализацию суперкласса этого метода как последний шаг Вашей реализации.

Оператор импорта

Objective C

@import Automator;

Swift

import Automator

Доступность

Доступный в OS X v10.4 и позже.

См. также

– активированный

Выполнение журналирования


    
    logMessageWithLevel:format:
    - logMessageWithLevel:format:

Выводит на экран сообщение в области журнала Отомэтора. Обратите внимание на то, что это сообщение видимо пользователю.

Объявление

Objective C

- (void)logMessageWithLevel:(AMLogLevel)level format:(NSString *)format, ...

Параметры

`level`	Уровень журналирования для выполнения. Опции включают `AMLogLevelDebug`, `AMLogLevelInfo`, `AMLogLevelWarn`, и `AMLogLevelError`.
`format`	Строка формата. Посмотрите Строковые Объекты Форматирования для примеров того, как использовать этот метод и Спецификаторы Формата строки для списка спецификаторов формата.
`...`	Список разделенных запятой значений параметров для замены в `format`.

Обсуждение

Используйте этот метод, если Вы хотите предоставить обратную связь пользователю в области журнала Отомэтора, когда работает Ваше действие.

Оператор импорта

Objective C

@import Automator;

Доступность

Доступный в OS X v10.7 и позже.

Обновление параметров действия

parametersUpdated () - parametersUpdated

Запрашивает получатель обновить свой пользовательский интерфейс от его изменившихся сохраненных параметров.

Объявление

Swift

func parametersUpdated()

Objective C

- (void)parametersUpdated

Оператор импорта

Objective C

@import Automator;

Swift

import Automator

Доступность

Доступный в OS X v10.4 и позже.

См. также

– updateParameters
updateParameters () - updateParameters

Запрашивает получатель обновить свой сохраненный набор параметров от настроек в пользовательском интерфейсе действия.

Объявление

Swift

func updateParameters()

Objective C

- (void)updateParameters

Обсуждение

Это сообщение отправляется непосредственно перед тем, как действие сохраняется, копируется или выполняется. Предпочтительно, настройки действия не должны исключительно находиться в средствах управления его представления, но если они делают, действие может выбрать и сохранить их в этом методе.

Оператор импорта

Objective C

@import Automator;

Swift

import Automator

Доступность

Доступный в OS X v10.4 и позже.

См. также

– parametersUpdated

Получение информации о действии

закрытый () - закрытый

Вызванный Automator, когда действие получения удалено из потока операций, позволив ему выполнить операции очистки.

Объявление

Swift

func closed()

Objective C

- (void)closed

Обсуждение

Этот метод предназначается, чтобы быть переопределенным, так, чтобы Ваше действие могло выполнить свои определенные операции очистки.

Оператор импорта

Objective C

@import Automator;

Swift

import Automator

Доступность

Доступный в OS X v10.5 и позже.
ignoresInput ignoresInput Свойство

Проигнорировано булево значение, указывающее, реагирует ли действие на свой ввод или ввод. (только для чтения)

Объявление

Swift

var ignoresInput: Bool { get }

Objective C

@property(readonly) BOOL ignoresInput

Обсуждение

YEStrue если действие реагирует на свой ввод, иначе NOfalse.

Много действий реагируют на свой ввод, но действие может просто передать свой ввод или, редко, проигнорировать его.

Оператор импорта

Objective C

@import Automator;

Swift

import Automator

Доступность

Доступный в OS X v10.5 и позже.
имя имя Свойство

Имя действия. (только для чтения)

Объявление

Swift

var name: String! { get }

Objective C

@property(readonly, strong) NSString *name

Оператор импорта

Objective C

@import Automator;

Swift

import Automator

Доступность

Доступный в OS X v10.5 и позже.
вывод вывод Свойство

Вывод действия.

Объявление

Swift

var output: AnyObject!

Objective C

@property(strong) id output

Возвращаемое значение

Вывод действия получения, или nil если вызвано, прежде чем действие выполняется.

Обсуждение

nil если вызвано, прежде чем действие выполняется.

Этот метод используется в сочетании с AMWorkflow класс, предоставляющий доступ к действиям в потоке операций. В потоке операций, например, Вы могли бы многократно проверить вывод каждого действия. Или на завершении потока операций Вы могли бы исследовать вывод последнего действия, для определения вывода потока операций.

Этот параметр может также использоваться при выполнении действия асинхронно. Вызвать setOutput для указания вывода, действие производит.

Оператор импорта

Objective C

@import Automator;

Swift

import Automator

Доступность

Доступный в OS X v10.5 и позже.
progressValue progressValue Свойство

Значение плавающее между 0 и 1, который указывает, как далеко вдоль действия при обработке.

Объявление

Swift

var progressValue: CGFloat

Objective C

@property CGFloat progressValue

Обсуждение

Установка этого значения вызывает индикатор хода выполнения действия Отомэтора (выведенный на экран, когда поток операций работает) обновить для обеспечения пользователя индикацией относительно прогресса.

Оператор импорта

Objective C

@import Automator;

Swift

import Automator

Доступность

Доступный в OS X v10.6 и позже.
selectedInputType selectedInputType Свойство

Тип ввода, в формате UTI, ввода получен действием.

Объявление

Swift

var selectedInputType: String!

Objective C

@property(strong) NSString *selectedInputType

Обсуждение

Получение этого значения обеспечивает тип ввода, который действие сконфигурировано для принятия. Например, Ваше действие может иметь возможность принять файлы и папки или документы, в зависимости от того, как это сконфигурировано и какое действие предшествует ему в потоке операций.

Входные типы поддержки действия указаны в действии info.plist файл. По умолчанию это свойство значения по умолчанию для первого ввода вводит info.plist файл.

Через его интерфейс банка действия могла быть сконфигурирована, чтобы позволить пользователю указывать тип ввода, который должно принять действие. Например, действие Адресной книги может позволить пользователю конфигурировать, принимает ли действие людей или группы. В случаях как это, устанавливает это значение свойства для явного указания входного типа, который принимает действие. Установка этого значения для точного отражения надлежащего типа ввода помогает Automator определить, совместим ли ввод, который получает действие, или может быть сделан совместимым с действием.

Оператор импорта

Objective C

@import Automator;

Swift

import Automator

Доступность

Доступный в OS X v10.6 и позже.
selectedOutputType selectedOutputType Свойство

Тип вывода, в формате UTI, вывода, который будет произведен действием.

Объявление

Swift

var selectedOutputType: String!

Objective C

@property(strong) NSString *selectedOutputType

Обсуждение

Получение этого значения обеспечивает тип вывода, который действие сконфигурировано для создания. Например, Ваше действие может иметь возможность к выходным файлам и папкам или документам, в зависимости от того, как это сконфигурировано или с чем это встречается при обработке.

Выходные типы поддержки действия указаны в действии info.plist файл. По умолчанию это свойство значения по умолчанию к первому выводу вводит info.plist файл.

Установите это значение для явного указания выходного типа, который производит действие. Установка этого значения для точного отражения надлежащего вывода помогает Automator определить, совместим ли вывод, или может быть сделан совместимым со следующим действием в потоке операций.

Оператор импорта

Objective C

@import Automator;

Swift

import Automator

Доступность

Доступный в OS X v10.6 и позже.
остановленный остановленный Свойство

Указывает, щелкнул ли пользователь по кнопке остановки по родительскому потоку операций. (только для чтения)

Объявление

Swift

var stopped: Bool { get }

Objective C

@property(getter=isStopped, readonly) BOOL stopped

Обсуждение

Возвраты YEStrue если пользователь щелкнул по кнопке остановки, или NOfalse если все еще работает поток операций. На это свойство нужно сослаться во время долгих процессов действия, таких как цикл, чтобы определить, выйти ли из работы и остановить действие.

Оператор импорта

Objective C

@import Automator;

Swift

import Automator

Доступность

Доступный в OS X v10.10 и позже.

AMAction

Разделение на подклассы примечаний

Инициализация и кодирование

Оператор осуждения

Объявление

Возвращаемое значение

Обсуждение

Специальные замечания

Оператор импорта

Доступность

См. также

Объявление

Параметры

Возвращаемое значение

Обсуждение

Оператор импорта

Доступность

См. также

Объявление

Параметры

Возвращаемое значение

Обсуждение

Оператор импорта

Доступность

Объявление

Параметры

Обсуждение

Оператор импорта

Доступность

См. также

Управление действием

Объявление

Параметры

Обсуждение

Специальные замечания

Оператор импорта

Доступность

См. также

Объявление

Параметры

Обсуждение

Оператор импорта

Доступность

Объявление

Обсуждение

Оператор импорта

Доступность

См. также

Объявление

Параметры

Обсуждение

Оператор импорта

Доступность

Объявление

Параметры

Возвращаемое значение

Обсуждение

Оператор импорта

Доступность

См. также

Объявление

Параметры

Возвращаемое значение

Обсуждение

Оператор импорта

Доступность

См. также

Объявление

Обсуждение

Оператор импорта

Доступность

См. также

Объявление

Обсуждение

Оператор импорта

Доступность

Инициализация и синхронизация пользовательского интерфейса действия

Объявление

Обсуждение

Оператор импорта