Spec-Zone.ru › Hammerspoon

hs.alert

Простые всплывающие уведомления

Обзор API

  • Переменные - Настраиваемые значения
    • defaultStyle
  • Функции - API-вызовы, предоставляемые расширением напрямую
    • closeAll
    • closeSpecific
    • show
    • showWithImage

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

Переменные

defaultStyle
Подпись hs.alert.defaultStyle[]
Тип Переменная
Описание

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

Источник extensions/alert/alert.lua строка 17

Функции

closeAll
Подпись hs.alert.closeAll([seconds])
Тип Функция
Описание

Закрывает все открытые в данный момент всплывающие уведомления на экране

Параметры
  • seconds - Необязательное число, определяющее продолжительность эффекта плавного закрытия. По умолчанию равно значению fadeOutDuration, определённому в hs.alert.defaultStyle
Возвращаемые значения
  • Ничего
Источник extensions/alert/alert.lua строка 284
closeSpecific
Подпись hs.alert.closeSpecific(uuid, [seconds])
Тип Функция
Описание

Закрывает всплывающее уведомление с указанным идентификатором

Параметры
  • uuid - идентификатор всплывающего уведомления для закрытия
  • seconds - Необязательное число, определяющее продолжительность эффекта плавного закрытия. По умолчанию равно значению fadeOutDuration, определённому в hs.alert.defaultStyle
Возвращаемые значения
  • Ничего
Примечания
  • Используйте эту функцию для закрытия всплывающего уведомления, которое открыто неопределённое время или чтобы прервать закрытие уведомления с длительной продолжительностью.
Источник extensions/alert/alert.lua строка 300
show
Подпись hs.alert.show(str, [style], [screen], [seconds]) -> uuid
Тип Функция
Описание

Кратковременно отображает сообщение крупным шрифтом в центре экрана; для удобства преобразует свой аргумент к строковому типу (tostring).

Параметры
  • str - Строка или hs.styledtext объект для отображения в всплывающем уведомлении
  • style - Необязательная таблица, содержащая один или несколько ключей, указанных в hs.alert.defaultStyle. Если str уже является hs.styledtext объектом, этот аргумент игнорируется.
  • screen - Необязательный hs.screen объект пользовательских данных, определяющий экран (монитор) для отображения уведомления. По умолчанию hs.screen.mainScreen(), что соответствует экрану с текущим активным окном.
  • seconds - Количество секунд для отображения всплывающего уведомления. По умолчанию 2. Если seconds указан и не является числом, всплывающее уведомление отображается неопределённое время.
Возвращаемые значения
  • Идентификатор всплывающего уведомления в виде строки.
Примечания
  • Для удобства вы можете вызвать эту функцию как hs.alert(...)
  • Эта функция фактически вызывает hs.alert.showWithImage(msg, nil, ...). В связи с этим применяются все те же правила обработки аргументов.
Источник extensions/alert/alert.lua строка 263
showWithImage
Подпись hs.alert.showWithImage(str, image, [style], [screen], [seconds]) -> uuid
Тип Функция
Описание

Отображает изображение и сообщение крупным шрифтом в центре экрана в течение короткого времени; для удобства преобразует свой аргумент к строковому типу (tostring).

Параметры
  • str - Строка или hs.styledtext объект для отображения в всплывающем уведомлении
  • image - Изображение для отображения в всплывающем уведомлении
  • style - Необязательная таблица, содержащая один или несколько ключей, указанных в hs.alert.defaultStyle. Если str уже является hs.styledtext объектом, этот аргумент игнорируется.
  • screen - Необязательный hs.screen объект пользовательских данных, определяющий экран (монитор) для отображения уведомления. По умолчанию hs.screen.mainScreen(), что соответствует экрану с текущим активным окном.
  • seconds - Количество секунд для отображения всплывающего уведомления. По умолчанию 2. Если seconds указан и не является числом, всплывающее уведомление отображается неопределённое время.
Возвращаемые значения
  • Идентификатор всплывающего уведомления в виде строки.
Примечания
  • Необязательные параметры обрабатываются в указанном порядке следующим образом:
    • Если аргумент является таблицей и style ещё не задано, то таблица присваивается style
    • Если аргумент является объектом пользовательских данных и screen ещё не задано, то объект пользовательских данных присваивается screen
    • Если duration ещё не задано, то ему присваивается значение аргумента
    • Если ни одно из условий не выполняется для данного аргумента, то возвращается ошибка
  • Причина этой логики заключается в поддержке создания постоянных всплывающих уведомлений, как это ранее обрабатывалось модулем: Если вы укажете не числовое значение для seconds, вам необходимо сохранить строковый идентификатор, возвращённый этой функцией, чтобы вы могли закрыть его вручную с помощью hs.alert.closeSpecific при удалении уведомления.
  • Любой элемент стиля, который не указан в таблице аргументов style, будет использовать значение, в данный момент определённое в таблице hs.alert.defaultStyle.
Источник extensions/alert/alert.lua строка 220

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

Spec-Zone.ru

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