Spec-Zone.ru › Hammerspoon

hs.axuielement.observer

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

Обзор API

  • Константы - Полезные значения, которые нельзя изменить
    • notifications
  • Конструкторы - Вызовы API, которые возвращают объект, обычно тот, что предлагает методы API
    • new
  • Методы - Вызовы API, которые могут быть выполнены только на объекте, возвращенном конструктором
    • addWatcher
    • callback
    • isRunning
    • removeWatcher
    • start
    • stop
    • watching

Документация API

Константы

notifications
Подпись hs.axuielement.observer.notifications[]
Тип Константа
Описание

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

Примечания
  • Уведомления зависят от приложения и могут быть любыми строками, выбранными разработчиками приложения; этот список предоставляет рекомендуемые имена уведомлений, найденные в заголовках фреймворка macOS, но он не является исчерпывающим, и приложение или элемент не обязаны их предоставлять.
Источник extensions/axuielement/observer.m строка 402

Конструкторы

new
Подпись hs.axuielement.observer.new(pid) -> observerObject
Тип Конструктор
Описание

Создаёт новый объект наблюдателя для приложения с указанным идентификатором процесса.

Параметры
  • pid - идентификатор процесса приложения.
Возвращаемое значение
  • новый объект observer; генерирует ошибку, если pid не существует или объект не может быть создан.
Примечания
  • Если у вас уже есть объект hs.application для приложения, вы можете получить его идентификатор процесса с помощью hs.application:pid()
  • Если у вас уже есть объект hs.axuielement из приложения, которое вы хотите наблюдать (он не обязательно должен быть объектом приложения axuielement, а просто объектом, принадлежащим приложению), вы можете получить идентификатор процесса с помощью hs.axuielement:pid().
Источник extensions/axuielement/observer.m строка 117

Методы

addWatcher
Подпись hs.axuielement.observer:addWatcher(element, notification) -> observerObject
Тип Метод
Описание

Регистрирует указанное уведомление для указанного элемента доступности в наблюдателе.

Параметры
  • element - объект hs.axuielement, представляющий элемент доступности приложения, для которого был создан наблюдатель.
  • notification - строка, определяющая уведомление.
Возвращаемое значение
  • объект observer; генерирует ошибку, если наблюдатель не может быть зарегистрирован
Примечания
  • несколько уведомлений для одного и того же элемента доступности могут быть зарегистрированы путём вызова этого метода несколько раз с тем же элементом, но различными строками уведомлений.
  • если указанный элемент и строка уведомления уже зарегистрированы, этот метод ничего не делает.
  • строка уведомления зависит от приложения и может быть любой строкой, выбранной разработчиками приложения; некоторые распространённые из них содержатся в hs.axuielement.observer.notifications, но список не исчерпывающий, и приложение или элемент не обязаны их предоставлять.
Источник extensions/axuielement/observer.m строка 263
callback
Подпись hs.axuielement.observer:callback([fn]) -> observerObject | fn | nil
Тип Метод
Описание

Получить или установить обратный вызов для наблюдателя.

Параметры
  • fn - функция или явное nil для удаления, определяющая функцию обратного вызова, которую вызовет наблюдатель, когда назначенные элементы генерируют уведомления.
Возвращаемое значение
  • Если аргумент предоставлен, объект observer; в противном случае текущее значение.
Примечания
  • обратный вызов должен ожидать 4 аргумента и не возвращать ничего. Аргументы, передаваемые в обратный вызов, будут следующими:
    • сам объект observer
    • объект hs.axuielement для элемента доступности, который сгенерировал уведомление
    • строка, определяющая конкретное уведомление, которое было получено
    • таблица, содержащая пары ключ-значение с дополнительной информацией об уведомлении, если элемент и тип уведомления её предоставляют. Обычно это будет пустая таблица, указывающая, что дополнительная информация не предоставлялась.
Источник extensions/axuielement/observer.m строка 221
isRunning
Подпись hs.axuielement.observer:isRunning() -> boolean
Тип Метод
Описание

Возвращает true или false, указывая, наблюдает ли наблюдатель в настоящее время за уведомлениями и генерирует ли обратные вызовы.

Параметры
  • Нет
Возвращаемое значение
  • булево значение, указывающее, активен ли наблюдатель в настоящее время.
Источник extensions/axuielement/observer.m строка 202
removeWatcher
Подпись hs.axuielement.observer:removeWatcher(element, notification) -> observerObject
Тип Метод
Описание

Удаляет указанное уведомление для указанного элемента доступности из наблюдателя.

Параметры
  • element - объект hs.axuielement, представляющий элемент доступности приложения, для которого был создан наблюдатель.
  • notification - строка, определяющая уведомление.
Возвращаемое значение
  • объект observer; генерирует ошибку, если наблюдатель не может быть удален
Примечания
  • если указанный элемент и строка уведомления в настоящее время не зарегистрированы в наблюдателе, этот метод ничего не делает.
Источник extensions/axuielement/observer.m строка 308
start
Подпись hs.axuielement.observer:start() -> observerObject
Тип Метод
Описание

Начать наблюдение за приложением и вызывать обратные вызовы для назначенных элементов и уведомлений.

Параметры
  • Нет
Возвращаемое значение
  • объект observer
Примечания
  • Этот метод ничего не делает, если наблюдатель уже запущен
Источник extensions/axuielement/observer.m строка 148
stop
Подпись hs.axuielement.observer:stop() -> observerObject
Тип Метод
Описание

Остановить наблюдение за приложением; дальнейшие обратные вызовы не будут генерироваться.

Параметры
  • Нет
Возвращаемое значение
  • объект observer
Примечания
  • Этот метод ничего не делает, если наблюдатель в настоящее время не запущен
Источник extensions/axuielement/observer.m строка 175
watching
Подпись hs.axuielement.observer:watching([element]) -> table
Тип Метод
Описание

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

Параметры
  • element - необязательный hs.axuielement для возврата списка зарегистрированных уведомлений.
Возвращаемое значение
  • таблица, содержащая текущие зарегистрированные уведомления
Примечания
  • Если элемент указан, возвращаемая таблица будет содержать список строк, определяющих конкретные уведомления, за которыми наблюдатель следит для этого элемента.
  • Если аргумент не указан, таблица будет содержать пары ключ-значение, где каждый ключ будет hs.axuielement, за которым ведётся наблюдение, а соответствующее значение — таблица, содержащая список строк, определяющих конкретные уведомления, за которыми наблюдатель следит для этого элемента.
Источник extensions/axuielement/observer.m строка 348

© 2014–2017 Hammerspoon contributors
Licensed under the MIT License.
https://www.hammerspoon.org/docs/hs.axuielement.observer.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API