hs.notify

Удобный массив возможных типов активации уведомления и их обратных для справки.

• Счет начинается с нуля. (реализовано в Objective-C)

Строковое представление стандартного звука уведомления. Используйте hs.notify:soundName() или задайте атрибут soundName в hs:notify.new(), равным этой константе, если хотите использовать стандартный звук.

Таблица, содержащая зарегистрированные функции обратного вызова и их теги.

• Эту таблицу не следует изменять напрямую. Используйте функции hs.notify.register(tag, fn) и hs.notify.unregister(id).
• Эта таблица имеет метаметод __tostring, поэтому вы можете увидеть список зарегистрированных тегов функций в консоли, набрав hs.notify.registry
• См. hs.notify.warnAboutMissingFunctionTag для определения поведения, когда уведомление пытается выполнить обратный вызов к тегу функции, который отсутствует в этой таблице. Такое случается чаще всего при взаимодействии с уведомлениями после перезагрузки Hammerspoon.

Значение, указывающее, должно ли отсутствие тега функции уведомления вызывать предупреждение. По умолчанию равно true.

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

• Нет

• Таблица, содержащая объекты данных пользователей уведомлений Hammerspoon, которые в настоящее время находятся в центре уведомлений.

• В массив войдут только уведомления, которые были отображены, но не были удалены, либо пользователем, нажав на hs.notify:otherButtonTitle, или через автоматическое скрытие (подробнее см. hs.notify:autoWithdraw).

• Вы можете использовать эту функцию вместе с hs.notify:getFunctionTag, чтобы повторно зарегистрировать необходимые функции обратного вызова с помощью hs.notify.register при перезапуске Hammerspoon.

• Поскольку уведомления, которые пользователь закрыл (или отменил), не вызывают обратный вызов, вы можете проверить эту таблицу с таймером, чтобы увидеть, закрыл ли пользователь уведомление, например:

myNotification = hs.notify.new():send()
clearCheck = hs.timer.doEvery(10, function()
    if not hs.fnutils.contains(hs.notify.deliveredNotifications(), myNotification) then
        if myNotification:activationType() == hs.notify.activationTypes.none then
            print("You dismissed me!")
        else
            print("A regular action occurred, so callback (if any) was invoked")
        end
        clearCheck:stop() -- either way, no need to keep polling
        clearCheck = nil
    end
end)

Регистрирует функцию обратного вызова с заданным тегом для уведомления. Функция обратного вызова будет вызвана, когда пользователь нажмёт или взаимодействует с уведомлением.

• tag — строковый тег для идентификации зарегистрированной функции обратного вызова. Используйте его в качестве тега функции в hs.notify.new и hs.notify.show
• fn — функция, которая должна быть вызвана при взаимодействии с уведомлением с этим тегом.

• Числовой идентификатор, представляющий запись в hs.notify.registry для этой функции. Это число можно использовать с hs.notify.unregister, чтобы позже отменить регистрацию функции, если нужно.

• Если функция уже зарегистрирована с указанным тегом, она заменяется новой.

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

• Нет

• Таблица, содержащая объекты данных пользователей для всех запланированных уведомлений Hammerspoon, которые должны быть доставлены.

• После доставки уведомление перемещается в hs.notify.deliveredNotifications или удаляется в зависимости от действий пользователя.

• Вы можете использовать эту функцию вместе с hs.notify:getFunctionTag, чтобы повторно зарегистрировать необходимые функции обратного вызова с помощью hs.notify.register при перезапуске Hammerspoon.

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

• id - числовой идентификатор, предоставленный hs.notify.register
• tag - строковый тег, представляющий функцию обратного вызова, которую нужно удалить

• None

Отменяет регистрацию всех функций, зарегистрированных в качестве обратных вызовов.

• None

• None

• Это не удаляет уведомления из центра уведомлений пользователя, а только удаляет их функцию обратного вызова при взаимодействии с ними пользователем. Чтобы удалить все уведомления, см. hs.notify.withdrawAll и hs.notify.withdrawAllScheduled

Удаляет все доставленные уведомления из Hammerspoon

• None

• None

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

Удаляет все запланированные уведомления из Hammerspoon

• None

• None

Создает новый объект уведомления

• fn - Необязательная функция или тег функции, которая будет вызвана, когда пользователь взаимодействует с уведомлениями. Объект уведомления будет передан в качестве аргумента функции. Если вы опустите этот параметр или укажете nil, то к уведомлению не будет прикреплен никакой обратный вызов.
• attributes - Необязательная таблица для применения атрибутов к уведомлению.
  • Возможные ключи:
  • alwaysPresent - см. hs.notify:alwaysPresent
  • autoWithdraw - см. hs.notify:autoWithdraw
  • contentImage - см. hs.notify:contentImage
  • informativeText - см. hs.notify:informativeText
  • soundName - см. hs.notify:soundName
  • subTitle - см. hs.notify:subTitle
  • title - см. hs.notify:title
  • setIdImage - см. hs.notify:setIdImage — обратите внимание, что граница будет автоматически установлена в false, если она задана как атрибут в этой таблице.
  • Следующие параметры также можно задать, но они будут иметь видимый эффект только в том случае, если пользователь настроил стиль уведомлений Hammerspoon на «Предупреждение» во вкладке «Центр уведомлений» в «Системных настройках»:
  • actionButtonTitle - см. hs.notify:actionButtonTitle
  • hasActionButton - см. hs.notify:hasActionButton
  • otherButtonTitle - см. hs.notify:otherButtonTitle
  • additionalActions - см. hs.notify:additionalActions
  • hasReplyButton - см. hs.notify:hasReplyButton
  • responsePlaceholder - см. hs.notify:responsePlaceholder
  • alwaysShowAdditionalActions - см. hs.notify:alwaysShowAdditionalActions
  • withdrawAfter - см. hs.notify:withdrawAfter

• Объект уведомления

• Тег функции — это строковый ключ, соответствующий функции, хранящейся в таблице hs.notify.registry с функцией hs.notify.register().
• Если для уведомления не установлен атрибут title, то OS X его не отобразит, поэтому по умолчанию он будет установлен в «Уведомление». Вы можете использовать ключ title в таблице атрибутов или вызвать hs.notify:title() перед отображением уведомления, чтобы изменить это.

Упрощённый конструктор для создания и отображения простых уведомлений

• title - заголовок уведомления
• subTitle - подзаголовок или вторая строка уведомления
• information - основное текстовое тело уведомления
• tag - тег функции, соответствующий функции, зарегистрированной с помощью hs.notify.register

• объект уведомления

• Все три текстовых параметра обязательны, хотя они могут быть пустыми строками
• Эта функция на самом деле является сокращением для hs.notify.new(...):send()
• Уведомления, созданные с помощью этой функции, унаследуют значение по умолчанию withdrawAfter, которое составляет 5 секунд. Для создания постоянных уведомлений следует использовать hs.notify.new() с атрибутом withdrawAfter равным 0.

Получение или установка метки кнопки действия уведомления

• buttonTitle - Необязательная строка, содержащая заголовок кнопки действия уведомления. Если параметр не указан, возвращается текущее значение.

• Объект уведомления, если buttonTitle присутствует; в противном случае текущее значение.

• Эффект этого метода проявляется только в том случае, если пользователь установил уведомления Hammerspoon на Alert в панели «Центр уведомлений» в «Системных настройках»
• Это значение игнорируется, если hs.notify:hasReplyButton имеет значение true.

Возвращает, как пользователь активировал уведомление.

• None

• целое значение, соответствующее тому, как пользователь активировал уведомление. Для получения дополнительной информации см. таблицу hs.notify.activationTypes[].

Возвращает дату и время доставки уведомления

• None

• Число, содержащее дату/время доставки уведомления, в секундах с эпохи (т. е. 1970-01-01 00:00:00 +0000)

• Вы можете преобразовать значения времени эпохи в удобочитаемую строку или таблицу элементов даты с помощью функции os.date().

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

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

• объект уведомления, если аргумент присутствует; в противном случае текущее значение

• Дополнительные элементы будут перечислены в всплывающем меню, когда пользователь нажимает и удерживает кнопку мыши на кнопке действия предупреждения.
• Если пользователь выбирает одно из дополнительных действий, hs.notify:activationType будет равно hs.notify.activationTypes.additionalActionClicked
• См. также hs.notify:additionalActivationAction

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

• Нет

• Если для уведомления назначены дополнительные действия с помощью hs.notify:additionalActions и пользователь выбирает одно, возвращает строку, содержащую выбранное действие; в противном случае возвращает nil.

• Если пользователь выбирает одно из дополнительных действий, hs.notify:activationType будет равно hs.notify.activationTypes.additionalActionClicked
• См. также hs.notify:additionalActions

Получить или установить, должно ли уведомление отображаться даже если это переопределяет процесс принятия решений Центра уведомлений.

• alwaysPresent - необязательный булевый параметр, указывающий, должно ли уведомление переопределять решение Центра уведомлений о том, отображать уведомление или нет. По умолчанию значение true. Если параметр не указан, возвращается текущее значение.

• объект уведомления, если всегдаОтображать указан; в противном случае текущее значение.

• Это не влияет на возвращаемое значение hs.notify:presented() — оно всё равно будет отражать решение Центра уведомлений.

• Примеры причин, по которым Центр уведомлений пользователя может отказаться от отображения уведомления: Hammerspoon — активное приложение, подключение к проектору или включён режим «Не беспокоить».

• Если уведомление не было создано этим модулем, этот метод вернёт nil.

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

• state - необязательный булевый параметр, по умолчанию false, указывающий, должно ли уведомление всегда отображать альтернативное меню действий.

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

• Этот метод не имеет эффекта, если пользователь не установил в настройках Центра уведомлений Hammerspoon на Alert в окне Центра уведомлений.
• hs.notify:additionalActions также должен использоваться для того, чтобы этот метод имел какой-либо эффект.
• ПРЕДУПРЕЖДЕНИЕ: Этот метод использует закрытый API. Он может сломаться в любое время. Пожалуйста, откройте вопрос, если это произошло.

Получить или установить, должно ли уведомление автоматически закрываться после активации.

• shouldWithdraw - необязательный булевый параметр, указывающий, должно ли уведомление автоматически закрываться. По умолчанию значение true. Если параметр не указан, возвращается текущее значение.

• объект уведомления, если shouldWithdraw указан; в противном случае текущее значение.

• Этот метод не имеет эффекта, если пользователь в настройках Центра уведомлений Hammerspoon установил значение Alert: нажатие на кнопку действия или другую кнопку автоматически удалит уведомление.

• Если уведомление было создано до последней перезагрузки (или перезапуска) Hammerspoon и на него нажали до того, как hs.notify был загружен в память, это значение не будет учтено, поскольку первоначальный делегат приложения не знает об этом параметре и настроен на автоматическое закрытие всех уведомлений, на которые реагируют.

• Если уведомление не было создано этим модулем, этот метод вернёт nil.

Получить или установить изображение содержимого уведомления.

• image - необязательный параметр hs.image, содержащий изображение для отображения. По умолчанию значение nil. Если параметр не указан, возвращается текущее значение.

• объект уведомления, если image указан; в противном случае текущее значение.

• См. hs.image для получения подробной информации о том, как указать или определить изображение
• Этот метод поддерживается только в OS X 10.9 и более поздних версиях. В консоли будет отображено предупреждение, и метод будет считаться бесполезным, если он используется на неподдерживаемой системе.

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

• Нет

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

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

• Нет

• Тег функции этого уведомления в виде строки.

• Этот тег должен соответствовать функции в hs.notify.registry и может использоваться для замены с помощью hs.notify.register(...) или удаления с помощью hs.notify.unregister(...)

• Если уведомление не было создано этим модулем, этот метод вернёт nil.

Получить или установить наличие кнопки действия в уведомлении.

• hasButton - необязательный булевый параметр, указывающий, должно ли быть присутствие кнопки действия. Если параметр не указан, возвращается текущее значение.

• объект уведомления, если hasButton указан; в противном случае текущее значение.

• Эффект этого метода применяется только в том случае, если пользователь в настройках Центра уведомлений Hammerspoon установил значение Alert.

Получить или установить, отображается ли в уведомлении кнопка «Ответить» для дополнительного ввода пользователя.

• state — необязательный булевый параметр, по умолчанию false, указывающий, должно ли уведомление содержать кнопку «Ответить» для дополнительного ввода пользователя.

• Объект уведомления, если аргумент предоставлен; в противном случае текущее значение

• Этот метод не оказывает никакого эффекта, если пользователь не установил в Hammerspoon уведомления на Alert в панели «Центр уведомлений» в настройках системы.
• hs.notify:hasActionButton также должно быть true, иначе кнопка «Ответить» не будет отображаться.
• Если это значение установлено в true, кнопка действия будет «Ответить», даже если вы установили другую с помощью hs.notify:actionButtonTitle.

Получить или установить информативный текст уведомления

• informativeText — необязательная строка, содержащая информативный текст, который нужно установить для объекта уведомления. Может быть пустой строкой. Если nil передается, любой существующий информативный текст будет удален. Если параметр не указан, возвращается текущее значение.

• Объект уведомления, если informativeText указан; в противном случае текущее значение.

Получить или установить метку другой кнопки уведомления

• buttonTitle — необязательная строка, содержащая заголовок для другой кнопки уведомления. Если параметр не указан, возвращается текущее значение.

• Объект уведомления, если buttonTitle указан; в противном случае текущее значение.

• Действие этого метода применимо только в том случае, если пользователь установил в Hammerspoon уведомления на Alert в панели «Центр уведомлений» в настройках системы
• Из-за ограничений OSX невозможно получить обратный вызов для этой кнопки.

Возвращает, решил ли Центр уведомлений пользователя отобразить уведомление

• Нет

• Булево значение, указывающее, решил ли Центр уведомлений пользователя отобразить уведомление

• Примеры причин, по которым Центр уведомлений пользователя может выбрать не отображать уведомление: Hammerspoon является фокусированным приложением, прикрепленным к проектору или пользователь установил «Не беспокоить».

Получить ввод пользователя из уведомления типа «всплывающее окно» с кнопкой «Ответить».

• Нет

• Если уведомление имеет кнопку «Ответить» и пользователь нажимает на нее, возвращает строку, содержащую ввод пользователя (может быть пустой строкой); в противном случае возвращает nil.

• hs.notify:activationType будет равно hs.notify.activationTypes.replied, если пользователь нажал на кнопку «Ответить», а затем на «Отправить».
• См. также hs.notify:hasReplyButton

Установить строку-заполнитель для уведомлений типа «всплывающее окно» с кнопкой «Ответить».

• string — необязательная строка, определяющая текст-заполнитель, отображаемый в поле ответа перед тем, как пользователь что-либо введет в уведомлении типа «всплывающее окно» с кнопкой «Ответить».

• Объект уведомления, если аргумент предоставлен; в противном случае текущее значение

• В macOS 10.13 этот текст отображается настолько светлым, что практически нечитаем; пока не найдено решения.
• См. также hs.notify:hasReplyButton

Планирует доставку уведомления в будущем.

• date — дата доставки уведомления в Центр уведомлений пользователя, заданная как количество секунд с 1970-01-01 00:00:00Z или как строка в формате rfc3339: "YYYY-MM-DD[T]HH:MM:SS[Z]".

• Объект уведомления

• См. также hs.notify:send()
• hs.settings.dateFormat указывает строку формата Lua, которая может использоваться с os.date() для корректного отображения даты и времени в виде строки для использования с этим методом.

Немедленно отправляет уведомление в Центр уведомлений пользователя.

• Нет

• Объект уведомления

• См. также hs.notify:schedule()
• Если уведомление было изменено, оно будет повторно отправлено.
• Вы можете вызывать этот метод несколько раз, если хотите повторить одно и то же уведомление.

Установить идентификационную картинку уведомления (заменить значок Hammerspoon пользовательской картинкой)

• image — объект hs.image, строка, содержащая путь к изображению, или строка, определяющая ASCIImage
• withBorder — необязательный булевый параметр для добавления рамки к изображению уведомления. По умолчанию false

• Объект уведомления

• См. hs.image для получения информации о том, как указать или определить изображение
• ПРЕДУПРЕЖДЕНИЕ: Этот метод использует закрытый API. Он может сломаться в любое время. Пожалуйста, создайте вопрос, если это произойдет

Получить или установить звук для уведомления

• soundName — необязательная строка, содержащая имя звука, который нужно воспроизвести с уведомлением. Если nil, звук не будет воспроизводиться. По умолчанию nil. Если параметр не указан, возвращается текущее значение.

• Объект уведомления, если soundName указан; в противном случае текущее значение.

• Звуки сначала будут сопоставлены с именами системных звуков. Если не удастся найти совпадения, они будут затем ищутсся в следующих путях, в указанном порядке:
• ~/Library/Sounds
• /Library/Sounds
• /Network/Sounds
• /System/Library/Sounds

Получить или установить подзаголовок уведомления

• subtitleText - Необязательная строка, содержащая подзаголовок, который нужно установить для объекта уведомления. Может быть пустой строкой. Если nil передано, любой существующий подзаголовок будет удален. Если параметр не предоставлен, возвращается текущее значение.

• Объект уведомления, если subtitleText присутствует; в противном случае текущее значение.

Получить или установить заголовок уведомления

• titleText - Необязательная строка, содержащая заголовок, который нужно установить для объекта уведомления. Значение по умолчанию - "Уведомление". Если nil передано, то заголовок устанавливается в пустую строку. Если параметр не предоставлен, возвращается текущее значение.

• Объект уведомления, если titleText присутствует; в противном случае текущее значение.

Выводит доставленное уведомление из Центра уведомлений.

• Никаких

• Объект уведомления
• Этот метод позволяет вам разблокировать отправленное уведомление, чтобы его можно было изменить и повторно отправить.
• если уведомление не было создано этим модулем, оно всё равно будет выведено, если это возможно

Получить или установить количество секунд, по истечении которых уведомление автоматически удаляется.

• seconds - Необязательное число, по умолчанию 5, секунд, по истечении которых уведомление удаляется автоматически. Значение 0 не приведет к автоматическому удалению уведомления.

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

• Хотя эта настройка применяется к уведомлениям стилей Баннер и СМС, она функционально бессмысленна для стилей Баннер.

• Значение 0 отключит автоматическое удаление.

• если уведомление не было создано этим модулем, этот метод вернет nil