Spec-Zone .ru
спецификации, руководства, описания, API

Библиотека разработчика Mac

Разработчик

Ссылка платформы основы ссылка класса NSScriptCommandDescription

Опции
Развертывание Target:

На этой странице
Язык:

NSScriptCommandDescription

Экземпляр NSScriptCommandDescription описывает команду сценария что Какао поддержка приложений.

scriptable приложение предоставляет scriptability информацию, описывающую команды и возражающую, что сценаристы могут использовать в сценариях, предназначающихся для приложения. Информация сценариев приложения собрана автоматически экземпляром NSScriptSuiteRegistry, который создает NSScriptCommandDescription для каждой команды это находит, кэширует эти объекты в памяти и устанавливает обработчик команды для каждой команды.

Экземпляр команды сценария хранит имя, класс, типы аргумента и тип возврата команды. Например, команды в Базовом комплекте AppleScript включают clone, count, create, delete, exists, и move.

Открытые методы NSScriptCommandDescription используются прежде всего встроенной поддержкой сценариев Какао в ответе на события Apple, предназначающиеся для приложения. Несмотря на то, что можно разделить на подклассы NSScriptCommandDescription класс, маловероятно, что Вам было бы нужно для этого или создать экземпляры его.

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

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

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

Swift

import Foundation

Objective C

@import Foundation;

Доступность

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

Инициализация описания команды сценария
  • init (suiteName:commandName:dictionary:) - initWithSuiteName:commandName:dictionary: Определяемый инициализатор

    Инициализирует и возвращает недавно выделенный экземпляр NSScriptCommandDescription.

    Объявление

    Swift

    init?(suiteName suiteName: String, commandName commandName: String, dictionary commandDeclaration: [NSObject : AnyObject]?)

    Objective C

    - (instancetype)initWithSuiteName:(NSString *)suiteName commandName:(NSString *)commandName dictionary:(NSDictionary *)commandDeclaration

    Параметры

    suiteName

    Имя комплекта (в scriptability информации приложения), которому принадлежит команда. Например, "AppName Suite".

    commandName

    Имя команды сценария, которую описывает этот экземпляр.

    commandDeclaration

    Словарь объявления команды вида, который допустим в файлах списка свойств комплекта сценария. Этот словарь предоставляет информацию о команде, такой как ее имена параметра и типы и тип возврата (если таковые имеются).

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

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

    Обсуждение

    Этот метод регистры self с глобальным экземпляром приложения NSScriptSuiteRegistry и также регистры все аргументы команды с реестром.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

Получение основной информации о команде
  • appleEventClassCode - appleEventClassCode

    Возвращает четыре кода символа для класса событий Apple команды получателя.

    Объявление

    Swift

    var appleEventClassCode: FourCharCode { get }

    Objective C

    @property(readonly) FourCharCode appleEventClassCode

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

    Код события Apple связался с командой получателя. Это - основной код, используемый для идентификации команды в событиях Apple.

    Обсуждение

    В событии Apple, указывающем команду сценария, два, четыре кодов символов — класс событий и идентификатор события — вместе идентифицируют команду. Вы используете этот метод для получения класса событий. Вы используете appleEventCode получить идентификатор события.

    Например, команды в Базовом комплекте AppleScript, такой как clone, count, и create, имейте код класса событий 'core'. Этот код и код идентификатора события, возвращенный appleEventCode вместе укажите необходимую информацию для идентификации и диспетчеризации события Apple.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • appleEventCode - appleEventCode

    Возвращает четыре кода символа для идентификатора события Apple команды получателя.

    Объявление

    Swift

    var appleEventCode: FourCharCode { get }

    Objective C

    @property(readonly) FourCharCode appleEventCode

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

    Код для идентификатора события команды получателя.

    Обсуждение

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

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

    См. также

    – appleEventCodeForArgumentWithName:
    – appleEventCodeForReturnType

  • commandClassName - commandClassName

    Возвращает имя класса, который инстанцируют для обработки команды.

    Объявление

    Swift

    var commandClassName: String { get }

    Objective C

    @property(readonly, copy) NSString *commandClassName

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

    Имя класса Objective C (например, "NSGetCommand"). Это всегда NSScriptCommand или подкласс.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

    См. также

    – commandName

  • commandName - commandName

    Возвращает имя команды.

    Объявление

    Swift

    var commandName: String { get }

    Objective C

    @property(readonly, copy) NSString *commandName

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

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

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

    См. также

    – commandClassName

  • suiteName - suiteName

    Возвращает имя комплекта, содержащего команду, описанную получателем.

    Объявление

    Swift

    var suiteName: String { get }

    Objective C

    @property(readonly, copy) NSString *suiteName

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

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

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

    См. также

    – appleEventCode

Получение информации аргумента команды
  • appleEventCodeForArgumentWithName (_:) - appleEventCodeForArgumentWithName:

    Возвращает код события Apple для указанного аргумента команды получателя.

    Объявление

    Swift

    func appleEventCodeForArgumentWithName(_ argumentName: String) -> FourCharCode

    Objective C

    - (FourCharCode)appleEventCodeForArgumentWithName:(NSString *)argumentName

    Параметры

    argumentName

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

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

    Код для указанного параметра.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

    См. также

    – argumentNames

  • argumentNames - argumentNames

    Возвращает имена (или ключи) для всех параметров команды получателя.

    Объявление

    Swift

    var argumentNames: [AnyObject] { get }

    Objective C

    @property(readonly, copy) NSArray *argumentNames

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

    Массив имен параметра. Если нет никаких параметров за команду, возвращает пустой массив.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • isOptionalArgumentWithName (_:) - isOptionalArgumentWithName:

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

    Объявление

    Swift

    func isOptionalArgumentWithName(_ argumentName: String) -> Bool

    Objective C

    - (BOOL)isOptionalArgumentWithName:(NSString *)argumentName

    Параметры

    argumentName

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

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

    YEStrue если указанный параметр существует и является дополнительным; иначе, NOfalse.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

    См. также

    – argumentNames

  • typeForArgumentWithName (_:) - typeForArgumentWithName:

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

    Объявление

    Swift

    func typeForArgumentWithName(_ argumentName: String) -> String?

    Objective C

    - (NSString *)typeForArgumentWithName:(NSString *)argumentName

    Параметры

    argumentName

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

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

    Тип указанного аргумента команды. Возвраты nil если нет такого параметра.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

Получение информации типа возврата команды
  • appleEventCodeForReturnType - appleEventCodeForReturnType

    Возвращает код события Apple, идентифицирующий тип возврата команды.

    Объявление

    Swift

    var appleEventCodeForReturnType: FourCharCode { get }

    Objective C

    @property(readonly) FourCharCode appleEventCodeForReturnType

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

    Код события для типа возврата команды.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

    См. также

    – appleEventCodeForArgumentWithName:
    – returnType

  • returnType - returnType

    Возвращает тип возврата команды.

    Объявление

    Swift

    var returnType: String? { get }

    Objective C

    @property(readonly, copy) NSString *returnType

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

    Команда получателя возвращает тип; например, "NSNumber" или "NSDictionary").

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

    См. также

    – appleEventCodeForReturnType

Создание команд
  • createCommandInstance () - createCommandInstance

    Создает и возвращает экземпляр объекта команды, описанного получателем.

    Объявление

    Swift

    func createCommandInstance() -> NSScriptCommand

    Objective C

    - (NSScriptCommand *)createCommandInstance

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

    Объект команды, от которого инстанцируют NSScriptCommand или подкласс.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • createCommandInstanceWithZone (_:) - createCommandInstanceWithZone:

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

    Объявление

    Swift

    func createCommandInstanceWithZone(_ zone: NSZone) -> NSScriptCommand

    Objective C

    - (NSScriptCommand *)createCommandInstanceWithZone:(NSZone *)zone

    Параметры

    zone

    Зона памяти, от которой можно выделить команду.

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

    Объект команды, от которого инстанцируют NSScriptCommand или подкласс.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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