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

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

Разработчик

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

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

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

NSAppleEventDescriptor

Экземпляр NSAppleEventDescriptor представляет дескриптор — основа для событий Apple. Этот класс является оберткой для базового типа данных дескриптора события Apple, AEDesc. Приложения Какао Scriptable часто работают с экземплярами NSAppleEventDescriptor, но должен редко должен быть работать непосредственно с AEDesc структура данных.

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

Дескрипторы могут использоваться для создания произвольно сложных контейнеров, так, чтобы одно событие Apple могло представлять оператор сценария такой как tell application "TextEdit" to get word 3 of paragraph 6 of document 3.

В работе с дескрипторами события Apple может быть полезно понять некоторые базовые типы данных. Вы сочтете условия, такие как дескриптор, список дескриптора, запись события Apple и событие Apple определенными в Создании События Apple в Руководстве по программированию Событий Apple. Вы также найдете, что информация о четырех кодах символов раньше идентифицировала информацию в дескрипторе. Типы данных о событии Apple определяются в Ссылке менеджера по корпоративным мероприятиям Apple. Значения многих четырех кодов символов, используемых Apple (и в некоторых случаях снова использованный разработчиками), могут быть найдены в Терминологии AppleScript и Кодах события Apple.

Наиболее распространенная причина создать событие Apple с экземпляром NSAppleEventDescriptor должен предоставить информацию в событии Apple возврата. Наиболее распространенная ситуация, где Вы, возможно, должны были бы извлечь информацию из события Apple (как экземпляр NSAppleEventDescriptor) когда обработчик событий Apple, установленный Вашим приложением, вызывается, как описано в “Установке Обработчика событий Apple” в Как Дескриптор Приложений Какао События Apple. Кроме того, если Вы выполняете сценарий AppleScript с помощью NSAppleScript класс, Вы получаете экземпляр NSAppleEventDescriptor как возвращаемое значение, из которого можно извлечь любую запрошенную информацию.

Когда Вы работаете с экземпляром NSAppleEventDescriptor, можно получить доступ к базовому дескриптору непосредственно, при необходимости, с aeDesc метод. Другие методы, включая descriptorWithDescriptorType:bytes:length: позвольте создать и инициализировать экземпляры NSAppleEventDescriptor не создавая временные экземпляры NSData.

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

Какао в настоящее время не обеспечивает механизм для приложений для прямой отправки необработанных событий Apple (хотя компилируя и выполняя сценарий AppleScript с NSAppleScript может привести к отправляемым событиям Apple). Однако приложения Какао имеют полный доступ к менеджеру по корпоративным мероприятиям Apple К APIs для работы с событиями Apple. Так, например, Вы могли бы использовать экземпляр NSAppleEventDescriptor собрать событие Apple и вызвать функцию менеджера по корпоративным мероприятиям Apple AESend отправить его.

Если необходимо отправить события Apple, или если Вам нужно больше информации о некоторых понятиях события Apple, описанных здесь, см. Руководство по программированию Событий Apple и Ссылку менеджера по корпоративным мероприятиям Apple.

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

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

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

Swift

import Foundation

Objective C

@import Foundation;

Доступность

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

Создание и инициализация дескрипторов
  • appleEventWithEventClass (_: eventID:targetDescriptor:returnID:transactionID:) + appleEventWithEventClass:eventID:targetDescriptor:returnID:transactionID:

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

    Объявление

    Swift

    class func appleEventWithEventClass(_ eventClass: AEEventClass, eventID eventID: AEEventID, targetDescriptor addressDescriptor: NSAppleEventDescriptor?, returnID returnID: AEReturnID, transactionID transactionID: AETransactionID) -> NSAppleEventDescriptor?

    Objective C

    + (NSAppleEventDescriptor *)appleEventWithEventClass:(AEEventClass)eventClass eventID:(AEEventID)eventID targetDescriptor:(NSAppleEventDescriptor *)addressDescriptor returnID:(AEReturnID)returnID transactionID:(AETransactionID)transactionID

    Параметры

    eventClass

    Класс событий, который будет установлен в возвращенном дескрипторе.

    eventID

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

    addressDescriptor

    Указатель на дескриптор, идентифицирующий целевое приложение для события Apple. Передача nil результаты в дескрипторе события Apple, имеющем нет keyAddressAttr атрибут (это допустимо для события Apple, чтобы не иметь никакого целевого атрибута адреса).

    returnID

    Возврат ID, который будет установлен в возвращенном дескрипторе. Если Вы передаете значение kAutoGenerateReturnID, менеджер по корпоративным мероприятиям Apple присваивает создаваемое событие Apple возврат ID, который уникален для текущего сеанса. Если Вы передаете какое-либо другое значение, менеджер по корпоративным мероприятиям Apple присваивает то значение для ID.

    transactionID

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

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

    Дескриптор для события Apple, инициализированного согласно указанным значениям параметров, или nil если происходит ошибка.

    Обсуждение

    Константы такой как kAutoGenerateReturnID и kAnyTransactionID определяются в AE.framework, подплатформа ApplicationServices.framework.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • init (булевская переменная:) + descriptorWithBoolean:

    Создает дескриптор, инициализированный с типом typeBoolean это хранит указанное булево значение.

    Объявление

    Swift

    init?(boolean boolean: Boolean) -> NSAppleEventDescriptor

    Objective C

    + (NSAppleEventDescriptor *)descriptorWithBoolean:(Boolean)boolean

    Параметры

    boolean

    Булево значение, которое будет установлено в возвращенном дескрипторе.

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

    Дескриптор с указанным булевым значением, или nil если происходит ошибка.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • descriptorWithDescriptorType:bytes:length: + descriptorWithDescriptorType:bytes:length:

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

    Объявление

    Objective C

    + (NSAppleEventDescriptor *)descriptorWithDescriptorType:(DescType)descriptorType bytes:(const void *)bytes length:(NSUInteger)byteCount

    Параметры

    descriptorType

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

    bytes

    Данные, как последовательность байтов, чтобы быть установленным в возвращенном дескрипторе.

    byteCount

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

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

    Дескриптор с указанным типом и данными, или nil если происходит ошибка.

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

    Objective C

    @import Foundation;

    Доступность

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

  • descriptorWithDescriptorType:data: + descriptorWithDescriptorType:data:

    Создает дескриптор, инициализированный с указанным типом события, хранящим указанные данные (от экземпляра NSData).

    Объявление

    Objective C

    + (NSAppleEventDescriptor *)descriptorWithDescriptorType:(DescType)descriptorType data:(NSData *)data

    Параметры

    descriptorType

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

    data

    Данные, как экземпляр NSData, быть установленным в возвращенном дескрипторе.

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

    Дескриптор с указанным типом и данными, или nil если происходит ошибка.

    Обсуждение

    Можно использовать этот метод для создания дескриптора, что можно встроить в полное событие Apple вызывающими методами такой как setAttributeDescriptor:forKeyword:, setDescriptor:forKeyword:, и setParamDescriptor:forKeyword:.

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

    Objective C

    @import Foundation;

    Доступность

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

  • init (enumCode:) + descriptorWithEnumCode:

    Создает дескриптор, инициализированный с типом typeEnumerated это хранит указанное значение типа данных перечислителя.

    Объявление

    Swift

    init?(enumCode enumerator: OSType) -> NSAppleEventDescriptor

    Objective C

    + (NSAppleEventDescriptor *)descriptorWithEnumCode:(OSType)enumerator

    Параметры

    enumerator

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

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

    Дескриптор с указанным значением типа данных перечислителя, или nil если происходит ошибка.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • init (int32:) + descriptorWithInt32:

    Создает дескриптор, инициализированный с типом события Apple typeSInt32 это хранит указанное целочисленное значение.

    Объявление

    Swift

    init?(int32 signedInt: Int32) -> NSAppleEventDescriptor

    Objective C

    + (NSAppleEventDescriptor *)descriptorWithInt32:(SInt32)signedInt

    Параметры

    signedInt

    Целочисленное значение, которое будет сохранено в возвращенном дескрипторе.

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

    Дескриптор, содержащий указанное целочисленное значение, или nil если происходит ошибка.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • init (строка:) + descriptorWithString:

    Создает дескриптор, инициализированный с типом typeUnicodeText это хранит текст от указанной строки.

    Объявление

    Swift

    init?(string string: String) -> NSAppleEventDescriptor

    Objective C

    + (NSAppleEventDescriptor *)descriptorWithString:(NSString *)string

    Параметры

    string

    Строка, указывающая текст, который будет сохранен в возвращенном дескрипторе.

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

    Дескриптор, содержащий текст от указанной строки, или nil если происходит ошибка.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • init (typeCode:) + descriptorWithTypeCode:

    Создает дескриптор, инициализированный с типом typeType это хранит указанное значение типа.

    Объявление

    Swift

    init?(typeCode typeCode: OSType) -> NSAppleEventDescriptor

    Objective C

    + (NSAppleEventDescriptor *)descriptorWithTypeCode:(OSType)typeCode

    Параметры

    typeCode

    Значение типа, которое будет установлено в возвращенном дескрипторе.

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

    Дескриптор с указанным типом, или nil если происходит ошибка.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • listDescriptor () + listDescriptor

    Создает и инициализирует пустой дескриптор списка.

    Объявление

    Swift

    class func listDescriptor() -> NSAppleEventDescriptor?

    Objective C

    + (NSAppleEventDescriptor *)listDescriptor

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

    Пустой дескриптор списка, или nil если происходит ошибка.

    Обсуждение

    Дескриптор списка является дескриптором, данные которого состоят из одного или более дескрипторов. Можно добавить элементы к списку путем вызова insertDescriptor:atIndex: или удалите их с removeDescriptorAtIndex:.

    Вызов этого метода эквивалентен выделению экземпляра NSAppleEventDescriptor и вызов initListDescriptor.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • nullDescriptor () + nullDescriptor

    Создает и инициализирует дескриптор без набора значений атрибута или параметра.

    Объявление

    Swift

    class func nullDescriptor() -> NSAppleEventDescriptor?

    Objective C

    + (NSAppleEventDescriptor *)nullDescriptor

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

    Дескриптор без параметра или набора значений атрибута, или nil если происходит ошибка.

    Обсуждение

    Вы обычно не вызываете этот метод как большинство NSAppleEventDescriptor методы экземпляра нельзя безопасно вызвать на возвращенном пустом дескрипторе.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • recordDescriptor () + recordDescriptor

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

    Объявление

    Swift

    class func recordDescriptor() -> NSAppleEventDescriptor?

    Objective C

    + (NSAppleEventDescriptor *)recordDescriptor

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

    Дескриптор события Apple, данные которого должны все же быть установлены, или nil если происходит ошибка.

    Обсуждение

    Запись события Apple является дескриптором, данные которого являются рядом дескрипторов, включенных четырьмя кодами символов. Можно добавить информацию к дескриптору с методами такой как setAttributeDescriptor:forKeyword:, setDescriptor:forKeyword:, и setParamDescriptor:forKeyword:.

    Вызов этого метода эквивалентен выделению экземпляра NSAppleEventDescriptor и вызов initRecordDescriptor.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • init (listDescriptor:) - initListDescriptor

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

    Объявление

    Swift

    convenience init?(listDescriptor listDescriptor: ())

    Objective C

    - (instancetype)initListDescriptor

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

    Пустой дескриптор списка, или nil если происходит ошибка.

    Обсуждение

    Можно добавить элементы к пустому дескриптору списка с insertDescriptor:atIndex:. Индексы списка на основе одни.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

    См. также

    + listDescriptor

  • init (recordDescriptor:) - initRecordDescriptor

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

    Объявление

    Swift

    convenience init?(recordDescriptor recordDescriptor: ())

    Objective C

    - (instancetype)initRecordDescriptor

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

    Инициализированная запись события Apple, или nil если происходит ошибка.

    Обсуждение

    Запись события Apple является дескриптором, данные которого являются рядом дескрипторов, включенных четырьмя кодами символов. Можно добавить информацию к дескриптору с методами такой как setAttributeDescriptor:forKeyword:, setDescriptor:forKeyword:, и setParamDescriptor:forKeyword:.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

    См. также

    + recordDescriptor

  • init (AEDescNoCopy:) - initWithAEDescNoCopy: Определяемый инициализатор

    Инициализирует недавно выделенный экземпляр как дескриптор для указанного Углерода AEDesc структура.

    Объявление

    Swift

    init(AEDescNoCopy aeDesc: UnsafePointer<AEDesc>)

    Objective C

    - (instancetype)initWithAEDescNoCopy:(const AEDesc *)aeDesc

    Параметры

    aeDesc

    Указатель на AEDesc структура для соединения с дескриптором.

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

    Экземпляр NSAppleEventDescriptor это связано со структурой, которой указывают aeDesc, или nil если происходит ошибка.

    Обсуждение

    Инициализированный объект берет на себя ответственность за вызов AEDisposeDesc функция на AEDesc в объектное время освобождения. Это - определяемый инициализатор для этого класса.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • init (descriptorType:bytes:length:) - initWithDescriptorType:bytes:length:

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

    Объявление

    Swift

    convenience init?(descriptorType descriptorType: DescType, bytes bytes: UnsafePointer<Void>, length byteCount: Int)

    Objective C

    - (instancetype)initWithDescriptorType:(DescType)descriptorType bytes:(const void *)bytes length:(NSUInteger)byteCount

    Параметры

    descriptorType

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

    bytes

    Данные, как последовательность байтов, чтобы быть установленным в возвращенном дескрипторе.

    byteCount

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

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

    Экземпляр NSAppleEventDescriptor с указанным типом и данными. Возвраты nil если происходит ошибка.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • init (descriptorType:data:) - initWithDescriptorType:data:

    Инициализирует недавно выделенный экземпляр как дескриптор с указанным типом дескриптора и данными (от экземпляра NSData).

    Объявление

    Swift

    convenience init?(descriptorType descriptorType: DescType, data data: NSData)

    Objective C

    - (instancetype)initWithDescriptorType:(DescType)descriptorType data:(NSData *)data

    Параметры

    descriptorType

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

    data

    Данные, которые будут установлены в инициализированном дескрипторе.

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

    Экземпляр NSAppleEventDescriptor с указанным типом и данными. Возвраты nil если происходит ошибка.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

    См. также

    + descriptorWithDescriptorType:data:

  • init (eventClass:eventID:targetDescriptor:returnID:transactionID:) - initWithEventClass:eventID:targetDescriptor:returnID:transactionID:

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

    Объявление

    Swift

    convenience init?(eventClass eventClass: AEEventClass, eventID eventID: AEEventID, targetDescriptor addressDescriptor: NSAppleEventDescriptor?, returnID returnID: AEReturnID, transactionID transactionID: AETransactionID)

    Objective C

    - (instancetype)initWithEventClass:(AEEventClass)eventClass eventID:(AEEventID)eventID targetDescriptor:(NSAppleEventDescriptor *)addressDescriptor returnID:(AEReturnID)returnID transactionID:(AETransactionID)transactionID

    Параметры

    eventClass

    Класс событий, который будет установлен в возвращенном дескрипторе.

    eventID

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

    addressDescriptor

    Указатель на дескриптор, идентифицирующий целевое приложение для события Apple. Передача nil результаты в дескрипторе события Apple, имеющем нет keyAddressAttr атрибут (это допустимо для события Apple, чтобы не иметь никакого целевого атрибута адреса).

    returnID

    Возврат ID, который будет установлен в возвращенном дескрипторе. Если Вы передаете значение kAutoGenerateReturnID, менеджер по корпоративным мероприятиям Apple присваивает создаваемое событие Apple возврат ID, который уникален для текущего сеанса. Если Вы передаете какое-либо другое значение, менеджер по корпоративным мероприятиям Apple присваивает то значение для ID.

    transactionID

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

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

    Инициализированное событие Apple (экземпляр NSAppleEventDescriptor), или nil если происходит ошибка.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

Получение информации о дескрипторе
  • aeDesc aeDesc Свойство

    AEDesc структура, инкапсулировавшая получателем, если это имеет тот. (только для чтения)

    Объявление

    Swift

    var aeDesc: UnsafePointer<AEDesc> { get }

    Objective C

    @property(readonly) const AEDesc *aeDesc

    Обсуждение

    Если получатель имеет допустимое AEDesc структура, возвращает указатель на него; иначе возвраты nil.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • booleanValue booleanValue Свойство

    Содержание получателя как булево значение, принуждая (к typeBoolean) при необходимости. (только для чтения)

    Объявление

    Swift

    var booleanValue: Boolean { get }

    Objective C

    @property(readonly) Boolean booleanValue

    Обсуждение

    Содержание дескриптора, как булево значение, или false если происходит ошибка.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • coerceToDescriptorType (_:) - coerceToDescriptorType:

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

    Объявление

    Swift

    func coerceToDescriptorType(_ descriptorType: DescType) -> NSAppleEventDescriptor?

    Objective C

    - (NSAppleEventDescriptor *)coerceToDescriptorType:(DescType)descriptorType

    Параметры

    descriptorType

    Тип дескриптора для принуждения получателя к.

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

    Дескриптор указанного типа, или nil если происходит ошибка.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • данные данные Свойство

    Данные получателя. (только для чтения)

    Объявление

    Swift

    @NSCopying var data: NSData { get }

    Objective C

    @property(readonly, copy) NSData *data

    Обсуждение

    Экземпляр NSData содержа данные получателя, или nil если происходит ошибка.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • descriptorType descriptorType Свойство

    Тип дескриптора получателя. (только для чтения)

    Объявление

    Swift

    var descriptorType: DescType { get }

    Objective C

    @property(readonly) DescType descriptorType

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • enumCodeValue enumCodeValue Свойство

    Содержание получателя как тип перечисления, принуждая к typeEnumerated при необходимости.

    Объявление

    Swift

    var enumCodeValue: OSType { get }

    Objective C

    @property(readonly) OSType enumCodeValue

    Обсуждение

    Содержание дескриптора, как тип перечисления, или 0, если происходит ошибка.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • int32Value int32Value Свойство

    Содержание получателя как целое число, принуждая (к typeSInt32) при необходимости. (только для чтения)

    Объявление

    Swift

    var int32Value: Int32 { get }

    Objective C

    @property(readonly) SInt32 int32Value

    Обсуждение

    Содержание дескриптора, как целочисленное значение, или 0, если происходит ошибка.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • numberOfItems numberOfItems Свойство

    Число дескрипторов в списке дескриптора получателя. (только для чтения)

    Объявление

    Swift

    var numberOfItems: Int { get }

    Objective C

    @property(readonly) NSInteger numberOfItems

    Обсуждение

    Число дескрипторов в списке дескриптора получателя (возможно 0); возвраты 0, если происходит ошибка.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • stringValue stringValue Свойство

    Содержание получателя как текстовая строка Unicode, принуждая к typeUnicodeText при необходимости. (только для чтения)

    Объявление

    Swift

    var stringValue: String? { get }

    Objective C

    @property(readonly, copy) NSString *stringValue

    Обсуждение

    Содержание дескриптора, как строка, или nil если происходит ошибка.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • typeCodeValue typeCodeValue Свойство

    Содержание получателя как тип, принуждая к typeType при необходимости. (только для чтения)

    Объявление

    Swift

    var typeCodeValue: OSType { get }

    Objective C

    @property(readonly) OSType typeCodeValue

    Обсуждение

    Содержание дескриптора, как тип, или 0, если происходит ошибка.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

Работа с дескрипторами списка
  • descriptorAtIndex (_:) - descriptorAtIndex:

    Возвращает дескриптор в указанной позиции (на основе одной) в списке дескриптора получения.

    Объявление

    Swift

    func descriptorAtIndex(_ anIndex: Int) -> NSAppleEventDescriptor?

    Objective C

    - (NSAppleEventDescriptor *)descriptorAtIndex:(NSInteger)anIndex

    Параметры

    anIndex

    Дескриптор на основе один перечисляет позицию дескриптора для возврата.

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

    Дескриптор от указанной позиции (на основе одной) в списке дескриптора, или nil если не может быть получен указанный дескриптор.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

    См. также

    – insertDescriptor:atIndex:
    – removeDescriptorAtIndex:

  • insertDescriptor (_: atIndex:) - insertDescriptor:atIndex:

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

    Объявление

    Swift

    func insertDescriptor(_ descriptor: NSAppleEventDescriptor, atIndex anIndex: Int)

    Objective C

    - (void)insertDescriptor:(NSAppleEventDescriptor *)descriptor atIndex:(NSInteger)anIndex

    Параметры

    descriptor

    Дескриптор для вставки в получатель. Указание индекса 0 или количество + 1 причина, добавляющая до конца списка.

    anIndex

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

    Обсуждение

    Поскольку это фактически заменяет дескриптор, если таковые имеются, в указанной позиции, этот метод можно было бы лучше вызвать replaceDescriptor:atIndex:. Получатель должен быть дескриптором списка. Индексы на основе одни. Если ошибка происходит, в настоящее время не обеспечивает индикации.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

    См. также

    – descriptorAtIndex:
    – removeDescriptorAtIndex:

  • removeDescriptorAtIndex (_:) - removeDescriptorAtIndex:

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

    Объявление

    Swift

    func removeDescriptorAtIndex(_ anIndex: Int)

    Objective C

    - (void)removeDescriptorAtIndex:(NSInteger)anIndex

    Параметры

    anIndex

    Позиция на основе одна дескриптора для удаления.

    Обсуждение

    Получатель должен быть дескриптором списка. Индексы на основе одни. Если ошибка происходит, в настоящее время не обеспечивает индикации.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

    См. также

    – descriptorAtIndex:
    – insertDescriptor:atIndex:

Работа с рекордными дескрипторами
  • descriptorForKeyword (_:) - descriptorForKeyword:

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

    Объявление

    Swift

    func descriptorForKeyword(_ keyword: AEKeyword) -> NSAppleEventDescriptor?

    Objective C

    - (NSAppleEventDescriptor *)descriptorForKeyword:(AEKeyword)keyword

    Параметры

    keyword

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

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

    Дескриптор для указанного ключевого слова, или nil если происходит ошибка.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • keywordForDescriptorAtIndex (_:) - keywordForDescriptorAtIndex:

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

    Объявление

    Swift

    func keywordForDescriptorAtIndex(_ anIndex: Int) -> AEKeyword

    Objective C

    - (AEKeyword)keywordForDescriptorAtIndex:(NSInteger)anIndex

    Параметры

    anIndex

    Дескриптор на основе один перечисляет позицию дескриптора для получения ключевого слова для.

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

    Ключевое слово (четыре кода символа) для дескриптора в расположении на основе одном, указанном anIndex, или 0, если происходит ошибка.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • removeDescriptorWithKeyword (_:) - removeDescriptorWithKeyword:

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

    Объявление

    Swift

    func removeDescriptorWithKeyword(_ keyword: AEKeyword)

    Objective C

    - (void)removeDescriptorWithKeyword:(AEKeyword)keyword

    Параметры

    keyword

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

    Обсуждение

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

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • setDescriptor (_: forKeyword:) - setDescriptor:forKeyword:

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

    Объявление

    Swift

    func setDescriptor(_ descriptor: NSAppleEventDescriptor, forKeyword keyword: AEKeyword)

    Objective C

    - (void)setDescriptor:(NSAppleEventDescriptor *)descriptor forKeyword:(AEKeyword)keyword

    Параметры

    descriptor

    Дескриптор для добавления к получателю.

    keyword

    Ключевое слово (четыре кода символа), который идентифицирует дескриптор для добавления. Если дескриптор с тем ключевым словом уже существует в получателе, это заменяется.

    Обсуждение

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

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

Работа с дескрипторами события Apple
  • attributeDescriptorForKeyword (_:) - attributeDescriptorForKeyword:

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

    Объявление

    Swift

    func attributeDescriptorForKeyword(_ keyword: AEKeyword) -> NSAppleEventDescriptor?

    Objective C

    - (NSAppleEventDescriptor *)attributeDescriptorForKeyword:(AEKeyword)keyword

    Параметры

    keyword

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

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

    Дескриптор атрибута для указанного ключевого слова, или nil если происходит ошибка.

    Обсуждение

    Получатель должен быть событием Apple.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • eventClass eventClass Свойство

    Класс событий для получателя. (только для чтения)

    Объявление

    Swift

    var eventClass: AEEventClass { get }

    Objective C

    @property(readonly) AEEventClass eventClass

    Обсуждение

    Класс событий (четыре кода символа) для получателя, или 0, если происходит ошибка.

    Получатель должен быть событием Apple. Событие Apple идентифицируется его классом событий и идентификатором события, парой четырех кодов символов, сохраненных как 32-разрядные целые числа. Например, большинство событий в Стандартном комплекте имеет четыре кода символа 'core' (определенный как константа kAECoreSuite в AE.framework, подплатформа ApplicationServices.framework). Для получения дополнительной информации о классах событий и идентификаторах события, посмотрите Создание События Apple в Руководстве по программированию Событий Apple.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • eventID eventID Свойство

    Идентификатор события для получателя. (только для чтения)

    Объявление

    Swift

    var eventID: AEEventID { get }

    Objective C

    @property(readonly) AEEventID eventID

    Обсуждение

    Идентификатор события (четыре кода символа) для получателя, или 0, если происходит ошибка.

    Получатель должен быть событием Apple. Событие Apple идентифицируется его классом событий и идентификатором события, парой четырех кодов символов, сохраненных как 32-разрядные целые числа. Например, open Событие Apple от Стандартного комплекта имеет четыре кода символа 'odoc' (определенный как константа kAEOpen в AE.framework, подплатформа ApplicationServices.framework).

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • paramDescriptorForKeyword (_:) - paramDescriptorForKeyword:

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

    Объявление

    Swift

    func paramDescriptorForKeyword(_ keyword: AEKeyword) -> NSAppleEventDescriptor?

    Objective C

    - (NSAppleEventDescriptor *)paramDescriptorForKeyword:(AEKeyword)keyword

    Параметры

    keyword

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

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

    Дескриптор для указанного ключевого слова, или nil если происходит ошибка.

    Обсуждение

    Получатель должен быть событием Apple.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • removeParamDescriptorWithKeyword (_:) - removeParamDescriptorWithKeyword:

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

    Объявление

    Swift

    func removeParamDescriptorWithKeyword(_ keyword: AEKeyword)

    Objective C

    - (void)removeParamDescriptorWithKeyword:(AEKeyword)keyword

    Параметры

    keyword

    Ключевое слово (четыре кода символа), который идентифицирует дескриптор параметра для удаления. Если ошибка происходит, в настоящее время не обеспечивает индикации.

    Обсуждение

    Получатель должен быть событием Apple или записью события Apple, оба из которых могут содержать параметры.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • возвращенный возвращенный Свойство

    Возврат получателя ID (ID для события Apple ответа). (только для чтения)

    Объявление

    Swift

    var returnID: AEReturnID { get }

    Objective C

    @property(readonly) AEReturnID returnID

    Обсуждение

    ID возврата получателя (целочисленное значение), или 0, если происходит ошибка.

    Получатель должен быть событием Apple.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • setAttributeDescriptor (_: forKeyword:) - setAttributeDescriptor:forKeyword:

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

    Объявление

    Swift

    func setAttributeDescriptor(_ descriptor: NSAppleEventDescriptor, forKeyword keyword: AEKeyword)

    Objective C

    - (void)setAttributeDescriptor:(NSAppleEventDescriptor *)descriptor forKeyword:(AEKeyword)keyword

    Параметры

    descriptor

    Дескриптор атрибута для добавления к получателю.

    keyword

    Ключевое слово (четыре кода символа), который идентифицирует дескриптор атрибута для добавления. Если дескриптор с тем ключевым словом уже существует в получателе, это заменяется.

    Обсуждение

    Получатель должен быть событием Apple. Если ошибка происходит, в настоящее время не обеспечивает индикации.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • setParamDescriptor (_: forKeyword:) - setParamDescriptor:forKeyword:

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

    Объявление

    Swift

    func setParamDescriptor(_ descriptor: NSAppleEventDescriptor, forKeyword keyword: AEKeyword)

    Objective C

    - (void)setParamDescriptor:(NSAppleEventDescriptor *)descriptor forKeyword:(AEKeyword)keyword

    Параметры

    descriptor

    Дескриптор параметра для добавления к получателю.

    keyword

    Ключевое слово (четыре кода символа), который идентифицирует дескриптор параметра для добавления. Если дескриптор с тем ключевым словом уже существует в получателе, это заменяется.

    Обсуждение

    Получатель должен быть событием Apple или записью события Apple, оба из которых могут содержать параметры.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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

  • transactionID transactionID Свойство

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

    Объявление

    Swift

    var transactionID: AETransactionID { get }

    Objective C

    @property(readonly) AETransactionID transactionID

    Обсуждение

    Идентификатор операции получателя (целочисленное значение), или 0, если происходит ошибка.

    Получатель должен быть событием Apple. Если ошибка происходит, в настоящее время не обеспечивает индикации. Для получения дополнительной информации о транзакциях см. описание для appleEventWithEventClass:eventID:targetDescriptor:returnID:transactionID:.

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

    Objective C

    @import Foundation;

    Swift

    import Foundation

    Доступность

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