hs.webview

Поскольку использование этого метода может легко привести к сбою, полезные методы из hs.drawing были добавлены в сам модуль hs.webview. Если вы считаете, что полезный метод был пропущен, отправьте вопрос.

Возвращает объект hs.window для веб-вьюера, чтобы вы могли использовать методы hs.window на нём.

Устарело; вместо этого используйте hs.webview:level.

• см. примечания для hs.drawing.windowLevels

Таблица общих значений OID, найденных в сертификатах SSL. Сертификаты SSL, предоставленные функции обратного вызова для hs.webview:sslCallback или в результатах hs.webview:certificateChain, используют строки OID в качестве ключей, описывающих свойства сертификата, и эта таблица может быть использована для получения более распространённого имени для ключей, которые вы, скорее всего, увидите.

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

• Кнопка «Максимизировать» в заголовке окна включена, когда установлено Resizable.
• Кнопки «Закрыть», «Свернуть» и «Максимизировать» видны только тогда, когда окно также имеет заголовок (Titled).

Получить или установить, отображается ли текст заголовка в окне веб-вьюера.

• state — необязательная строка, содержащая текст «visible» или «hidden», указывающая, отображается ли текст заголовка веб-вьюера, когда стиль окна веб-вьюера включает «titled».

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

• См. также hs.webview:windowStyle и hs.webview.windowMasks.

• Когда к веб-вьюеру прикреплена панель инструментов, эта функция может быть использована для указания, отображается ли панель инструментов под заголовком окна веб-вьюера («visible») или непосредственно в строке заголовка окна, как в приложениях, подобных Safari («hidden»). При скрытом заголовке панель инструментов будет отображать только элементы панели инструментов в виде значков без подписей и игнорировать изменения, внесённые с hs.webview.toolbar:displayMode.

• Если к веб-вьюеру прикреплена панель инструментов, вы можете добиться того же эффекта, что и с этим методом, используя hs.webview:attachedToolbar():inTitleBar(boolean).

Создать объект webview и, по желанию, изменить его настройки.

• rect - прямоугольник, определяющий, где должен отображаться объект webview.
• preferencesTable - необязательная таблица, которая может содержать один или несколько из следующих ключей:
  • javaScriptEnabled - JavaScript включён (по умолчанию true)
  • javaScriptCanOpenWindowsAutomatically - JavaScript может открывать окна без вмешательства пользователя (по умолчанию true)
  • minimumFontSize - минимальный размер шрифта (по умолчанию 0.0)
  • developerExtrasEnabled - включить "Инспектировать элемент" в контекстном меню
  • suppressesIncrementalRendering - подавляет отображение содержимого, пока оно полностью не загрузится в память (по умолчанию false)
  • Нижеследующие дополнительные настройки также могут быть установлены под OS X 10.11 или новее (они будут проигнорированы с выводом предупреждения, если используются под OS X 10.10): * applicationName - строка, определяющая имя приложения, которое должно быть отображено в конце заголовка USER-AGENT браузера. Обратите внимание, что это добавляется только к строке пользовательского агента по умолчанию; если вы установите собственную строку с помощью hs.webview:userAgent, это значение игнорируется. * allowsAirPlay - логическое значение, определяющее, может ли воспроизведение медиа внутри webview проходить через устройства AirPlay. * datastore - объект hs.webview.datastore, определяющий место хранения данных веб-сайта, таких как куки, кэшируемое содержимое и т. д. * privateBrowsing - логическое значение (по умолчанию false), указывающее, что хранилище данных должно быть установлено на новое, пустое и непостоянное хранилище данных. Обратите внимание, что это переопределит ключ datastore, если оба указаны и это значение установлено в true.
• userContentController - необязательный объект hs.webview.usercontent, обеспечивающий инъекцию скриптов и обмен сообщениями с JavaScript с Hammerspoon из webview.

• Объект webview

• Чтобы установить начальный URL, используйте метод hs.webview:url перед отображением объекта webview.

• Настройки можно устанавливать только при создании объекта webview. Чтобы изменить настройки открытого webview, необходимо его закрыть и создать заново с помощью этого метода.

• developerExtrasEnabled не указан в документации Apple, но включен в документации WebKit2.

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

• rect - прямоугольник, определяющий, где должен отображаться объект webviewObject.
• preferencesTable - необязательная таблица, определяющая специальные настройки для объекта webview.
• userContentController - необязательный объект hs.webview.usercontent для вставки скриптов и обмена сообщениями с JavaScript с Hammerspoon из webview.

• Объект webview

• Параметры такие же, как для hs.webview.new — см. подробности там.

• Этот конструктор — просто сокращение для hs.webview.new(...):allowTextEntry(true):allowGestures(true):windowStyle(15), который определяет webview с адресной строкой, кнопками адресной строки (масштабирование, закрытие, сворачивание) и поддерживает ввод форм и жесты для перехода к предыдущей и следующей страницам.

• Для получения более подробной информации см. hs.webview.new и следующие ссылки:

  • hs.webview:allowGestures
  • hs.webview:allowTextEntry
  • hs.webview:windowStyle
  • hs.webview.windowMasks

Получить или установить, будет ли webview реагировать на жесты с трекпада или Magic Mouse. Значение по умолчанию — false.

• value - необязательное логическое значение, указывающее, будет ли webview реагировать на жесты.

• Если значение предоставлено, то этот метод возвращает объект webview; в противном случае — текущее значение

• Это метод-короткая запись для получения или установки как hs.webview:allowMagnificationGestures, так и hs.webview:allowNavigationGestures.
• Этот метод установит оба типа жестов в true или false, если ему предоставлен аргумент, но вернёт true только если оба типа жестов в настоящее время true; если один или оба метода жестов false, то этот метод вернёт false.

Получить или установить, будет ли webview реагировать на жесты масштабирования с трекпада или Magic Mouse. Значение по умолчанию — false.

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

• Если значение предоставлено, то этот метод возвращает объект webview; в противном случае — текущее значение

Получить или установить, будет ли webview реагировать на жесты навигации с трекпада или Magic Mouse. Значение по умолчанию — false.

• value - необязательное логическое значение, указывающее, будет ли webview реагировать на жесты навигации.

• Если значение предоставлено, то этот метод возвращает объект webview; в противном случае — текущее значение

Получить или установить, разрешено ли webview открывать новые окна любым способом. По умолчанию true.

• value - необязательное логическое значение, указывающее, должно ли webview разрешать открытие новых окон.

• Если значение предоставлено, то этот метод возвращает объект webview; в противном случае — текущее значение

• Этот метод позволяет предотвратить открытие новых окон webview любым способом. Это включает щелчок правой кнопкой мыши по ссылке и выбор «Открыть в новом окне», всплывающие окна JavaScript, ссылки с атрибутом target «__blank» и т. д.
• Если вам нужно только предотвратить автоматическое открытие окон JavaScript, установите значение javaScriptCanOpenWindowsAutomatically в false при создании webview — этот метод блокирует все способы.

Получить или установить, может ли webview принимать ввод с клавиатуры для заполнения веб-форм. По умолчанию false.

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

• Если значение предоставлено, то этот метод возвращает объект webview; в противном случае — текущее значение

Получить или установить уровень прозрачности окна, содержащего объект hs.webview.

• alpha - необязательное число от 0.0 до 1.0, определяющее новый уровень прозрачности webview.

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

Получить или прикрепить/открепить панель инструментов к/от веб-вью.

• toolbar - если объект hs.webview.toolbar указан, он будет прикреплён к веб-вью. Если явно указан nil, текущая панель инструментов будет удалена из веб-вью.

• если указан объект toolbarObject или явный nil, возвращается объект webview; в противном случае возвращается текущий объект toolbarObject или nil, если панель инструментов не прикреплена к веб-вью.

• Этот метод является удобной обёрткой для функции hs.webview.toolbar.attachToolbar.

• Если объект toolbarObject в данный момент прикреплён к другому окну при вызове этого метода, он будет откреплён от исходного окна и прикреплён к веб-вью. Если вы хотите прикрепить ту же панель инструментов к нескольким веб-вью, см. hs.webview.toolbar:copy.

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

• behavior - необязательное число, представляющее желаемое поведение окна для объекта webview.

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

• Параметры поведения окна определяют, как объект webview обрабатывается Spaces и Exposé. Для получения дополнительной информации см. hs.drawing.windowBehaviors.

Получить или установить параметры поведения окна для объекта webview, используя метки, определённые в hs.drawing.windowBehaviors.

• behaviorTable - необязательная таблица строк и/или чисел, определяющая желаемое поведение окна для объекта webview.

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

• Параметры поведения окна определяют, как объект webview обрабатывается Spaces и Exposé. Для получения дополнительной информации см. hs.drawing.windowBehaviors.

Выводит объект отрисовки поверх обычных окон.

• aboveEverything - необязательное логическое значение, которое контролирует, насколько вперёд должен быть выведен webview. True, чтобы поместить webview поверх всех окон (включая док и строку меню и полноэкранные окна), false, чтобы поместить webview над обычными окнами, но ниже док, строки меню и полноэкранных окон. По умолчанию false.

• Объект webview

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

• Нет

• таблица, содержащая сертификаты, составляющие цепочку SSL-сертификатов, защищающих последнее подтверждённое навигационное событие. Каждый сертификат описывается в таблице с ключами:
  • commonName - общее имя сертификата; чаще всего это строка, соответствующая серверной части запроса URL или другого описания цели сертификата.
  • values - таблица, содержащая пары ключ-значение, описывающие сертификат. Ключи будут OID сертификатов. Общие OID и их значение можно найти в hs.webview.certificateOIDs. Значение каждого ключа будет таблицей со следующими ключами:
    • label - описание или метка записи
    • localized label - локализованная версия label
    • type - описание типа данных для этого значения
    • value - значение

• Этот метод поддерживается только ОС X 10.11 и новее.

• Навигация, выполненная по HTTP вместо HTTPS, вернёт пустой массив.

• Для OID, определяющих тип «дата» — например, «2.5.29.24» (invalidityDate) — предоставленное число представляет собой количество секунд, прошедших с 00:00:00 1 января 1970 года, и может быть использовано напрямую с командой Lua os.date.

• Для OID, известных как представляющие дату, но указывающих её тип как «число» — например, «2.16.840.1.113741.2.1.1.1.7» (X509V1ValidityNotAfter) или «2.16.840.1.113741.2.1.1.1.6» (X509V1ValidityNotBefore) — эпоха — 00:00:00 1 января 2001 года. Чтобы преобразовать эти даты в формат, пригодный для Lua, вам потребуется выполнить действия, подобные следующим: os.date("%c", value + os.time({year=2001,month=1,day=1,hour=0,min=0,sec=0})

Возвращает массив объектов webview, которые были открыты как дочерние окна этого webview.

• Нет

• массив, содержащий объекты webview всех дочерних окон, открытых из этого webview.

Если веб-вью можно закрыть, это позволит получить или установить, разрешено ли нажатие клавиши Escape для закрытия окна веб-вью.

• flag - необязательное логическое значение, которое указывает, должно ли веб-вью, если его стиль включает Closable (см. hs.webview:windowStyle), разрешать клавишу Escape в качестве сочетания клавиш для закрытия окна веб-вью. По умолчанию false.

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

• Если это значение установлено в true, Escape закроет окно только в том случае, если ни один другой элемент не отреагирует на клавишу Escape (например, если вы редактируете текстовое поле ввода, Escape будет перехвачен полем ввода, а не окном webview).

Установить или отобразить, должен ли быть включён режим тёмной темы для окна hs.webview.

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

• Логическое значение, true, если режим тёмной темы включён, иначе false.

Удаляет объект webview, необязательно предварительно выведя его с анимацией (если он видимый).

• propagate - необязательное логическое значение, по умолчанию false, указывающее, следует ли также удалить дочерние окна этого webview.
• fadeOutTime - необязательное число секунд, в течение которых должно выполняться затемнение объекта webview. По умолчанию ноль.

• Нет

• Этот метод автоматически вызывается во время сбора мусора, особенно при завершении или перезагрузке Hammerspoon, со временем затемнения 0.

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

• value - необязательное булево значение, определяющее, будет ли веб-вью удалён при закрытии его окна любым методом. По умолчанию false для окна, созданного с hs.webview.new, и true для любого окна веб-вью, созданного основным веб-вью (пользователь выбирает «Открыть ссылку в новом окне» и т. д.).

• Если значение предоставлено, то этот метод возвращает объект веб-вью; в противном случае — текущее значение

• Если установлено в true, объект веб-вью будет удален, когда пользователь нажмёт кнопку закрытия окна веб-вью с заголовком и возможностью закрытия (см. hs.webview.windowStyle).
• Подчинённые явно созданному веб-вью автоматически имеют этот атрибут, установленный в true. Чтобы заставить закрытые подчинённые оставаться после закрытия родительского окна пользователем, можно установить это значение в false с помощью функции обратного вызова политики при получении действия «newWindow».

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

• None

• числовое значение от 0.0 до 1.0, указывающее процент загруженного ожидаемого контента.

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

• script - JavaScript-код для выполнения в контексте текущего веб-вью
• callback - необязательная функция, которая должна принимать два параметра в качестве результата выполненного JavaScript-кода. Параметры функции следующие:
  • result - результат выполненного JavaScript-кода или nil, если результата нет или произошла ошибка.
  • error - таблица NSError, описывающая любую ошибку, произошедшую во время выполнения JavaScript, или nil, если ошибок не было.

• объект веб-вью

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

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

• Если значение предоставлено, то этот метод возвращает объект веб-вью; в противном случае — текущее значение

• Для того, чтобы это значение имело какой-либо эффект, необходимо также зарегистрировать функцию обратного вызова ssl с помощью hs.webview:sslCallback, которая должна возвращать true, если сертификат должен быть предоставлен исключение, или false, если нет. Для предоставления сертификату исключения, оба метода должны возвращать true.

• Сертификат сервера может быть недействительным по ряду причин:

  • он не подписан признанным центром сертификации — чаще всего это означает, что сертификат самозаверенный.
  • сертификат истек
  • сертификат имеет общее имя (имя сервера веб-сайта), отличное от запрошенного (например, общее имя сертификата — www.site.com, но он используется для чего-то другого, возможно, просто https://site.com, возможно, для чего-то ещё)
  • некоторые корпоративные прокси-серверы не обрабатывают SSL должным образом и могут привести к тому, что сертификат будет выглядеть недействительным, даже если он действительный (это менее распространено, чем раньше, но всё ещё иногда встречается)
  • потенциально злонамеренные причины, включая атаки типа «человек посередине» или фишинговые мошенничества.

• Сервер Hammerspoon, предоставляемый hs.httpserver, использует самозаверенный сертификат, когда настроен на использование SSL, поэтому он будет считаться недействительным по причине 1 выше.

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

Получить или установить рамку окна веб-вью.

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

• Если аргумент предоставлен, объект веб-вью; в противном случае — текущее значение.

• Таблица rect — это таблица с парами ключ-значение, определяющими новые координаты верхнего левого угла окна веб-вью на экране (ключи x и y) и новые размеры (ключи h и w). Таблицу можно создать любым методом, включающим эти ключи, в том числе с помощью объекта hs.geometry.

Перейти к предыдущей странице в истории веб-вью, если это возможно.

• None

• Объект веб-вью

Перейти к следующей странице в истории веб-вью, если это возможно.

• None

• Объект веб-вью

Скрывает объект веб-вью

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

• Объект веб-вью

Возвращает историю URL для текущего веб-вью в виде массива.

• None

• Таблица, которая представляет собой массив просмотренных в этом веб-вью URL-адресов и ключ current, равный индексу, соответствующему текущей видимой записи. Каждый элемент массива будет таблицей со следующими ключами:
  • URL - URL веб-страницы
  • initialURL - URL начального запроса, который привёл к этому элементу
  • title - заголовок веб-страницы

Возвращает объект hs.window для веб-вью, чтобы вы могли использовать методы hs.window на нём.

• None

• объект hs.window

• hs.window:minimize работает только если веб-вью минимизируем (см. hs.webview.windowStyle)
• hs.window:setSize работает только если веб-вью изменяем (см. hs.webview.windowStyle)
• hs.window:close работает только если веб-вью закрываем (см. hs.webview.windowStyle)
• hs.window:maximize переместит веб-вью в верхний левый угол экрана, но изменит размеры веб-вью только если он изменяем (см. hs.webview.windowStyle)

Отобразить данный HTML в веб-вьюере с необязательным базовым URL для относительных ссылок.

• html — html, который должен быть отображён в веб-вьюере
• baseURL — необязательный базовый URL, который используется в качестве начальной точки для любых относительных ссылок в предоставленном html.

• Объект веб-вьюера

• Веб-страницы, сгенерированные таким образом, не добавляются в список истории веб-вьюера

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

• Нет

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

Проверяет, видимым ли является окно веб-вьюера.

• Нет

• true если окно веб-вьюера видимое, иначе false

Получение или установка уровня окна

• theLevel — необязательный параметр, задающий желаемый уровень как целое число, которое можно получить из hs.drawing.windowLevels.

• если параметр задан, возвращает объект веб-вьюера, иначе текущее значение

• см. примечания для hs.drawing.windowLevels

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

• Нет

• true, если содержимое всё ещё загружается, или false, если загрузка завершена.

Получение или установка текущего уровня масштабирования веб-вьюера. По умолчанию 1.0.

• value — необязательное число, задающее уровень масштабирования веб-вьюера.

• Если значение указано, этот метод возвращает объект веб-вьюера; иначе текущее значение

Устанавливает обратный вызов для отслеживания процесса навигации веб-вьюера.

• fn — функция, которая вызывается, когда статус навигации веб-вьюера изменяется. Для отключения функции обратного вызова явно укажите nil. Функция должна ожидать 3 или 4 аргумента и может необязательно вернуть 1. Аргументы функции определены следующим образом:
  • action — строка, обозначающая текущий статус веб-вьюера. Она будет одной из следующих: * didStartProvisionalNavigation — произошла запрос или действие по изменению содержимого основного кадра * didReceiveServerRedirectForProvisionalNavigation — для основного кадра получен редирект сервера * didCommitNavigation — началась загрузка содержимого для основного кадра * didFinishNavigation — загрузка основного кадра веб-вьюера завершена. * didFailNavigation — произошла ошибка после начала загрузки содержимого * didFailProvisionalNavigation — произошла ошибка до или во время начала загрузки содержимого
  • webView — объект веб-вьюера, для которого происходит навигация.
  • navID — идентификатор навигации, который можно использовать для связи этого события со специфическим запросом, сделанным методом hs.webview:url, hs.webview:html, или hs.webview:reload.
  • error — таблица, которая будет предоставлена только тогда, когда action равно didFailNavigation или didFailProvisionalNavigation. Если предоставлена, она будет содержать как минимум некоторые из следующих ключей, возможно, и другие: * code — числовое значение, указывающее код ошибки. Это в основном будет полезно разработчикам или при отладке и может быть удалено в будущем. * domain — строка, обозначающая домен ошибки. Это в основном будет полезно разработчикам или при отладке и может быть удалено в будущем. * description — строка, описывающая условие или проблему, которая произошла. * reason — если доступно, больше информации о том, что, возможно, вызвало возникновение проблемы.

• Объект веб-вьюера

• Значение возвращаемое функцией обратного вызова игнорируется, за исключением случаев, когда аргумент action равен didFailNavigation или didFailProvisionalNavigation. Если возвращаемое значение, когда аргумент действия является одним из этих значений, представляет собой строку, она будет обрабатываться как html и отображаться в веб-вьюере как сообщение об ошибке. Если возвращаемое значение — булевое значение true, тогда никаких изменений в веб-вьюере не будет (он продолжит отображать предыдущую веб-страницу). Все другие возвращаемые значения или отсутствие возвращаемого значения, если эти действия навигации произошли, приведут к отображению страницы по умолчанию об ошибке в веб-вьюере.

Получение последнего идентификатора навигации для указанного веб-вьюера.

• Нет

• идентификатор навигации

• Этот идентификатор навигации можно использовать для отслеживания прогресса веб-вьюера с помощью функции обратного вызова навигации — см. hs.webview.navigationCallback.

Перемещает объект веб-вьюера над объектом webview2, или все объекты веб-вьюера на том же уровне представления, если webview2 не указан.

• webview2 — необязательный объект веб-вьюера, над которым необходимо разместить объект веб-вьюера.

• Объект веб-вьюера

• Если объект веб-вьюера и webview2 не находятся на одном уровне представления, этот метод переместит объект веб-вьюера как можно ближе к желаемому расположению, не изменяя уровень представления объекта веб-вьюера. См. hs.webview.level.

Перемещает объект веб-вьюера под объектом webview2, или все объекты веб-вьюера на том же уровне представления, если webview2 не указан.

• webview2 — необязательный объект веб-вьюера, под которым необходимо разместить объект веб-вьюера.

• Объект веб-вьюера

• Если объект веб-вьюера и webview2 не находятся на одном уровне представления, этот метод переместит объект веб-вьюера как можно ближе к желаемому расположению, не изменяя уровень представления объекта веб-вьюера. См. hs.webview.level.

Получает объект родительского веб-вью для вызываемого объекта веб-вью или nil, если у веб-вью нет родителя.

• Ничего

• объект родительского веб-вью для вызываемого объекта веб-вью или nil, если у веб-вью нет родителя

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

• fn - функция, которая вызывается для утверждения или отклонения веб-навигации. Для отключения функции обратного вызова явно укажите nil. Функция обратного вызова примет три или четыре аргумента и должна вернуть 1 аргумент, который определит, одобрено или отклонено действие. Первый аргумент укажет тип запроса политики и определит второй и третий аргументы следующим образом:
  • navigationAction: Это относится к любому подключению к серверу или службе, которая предоставляет содержимое для веб-вью, и происходит до фактического установления подключения. * второй аргумент будет веб-вью, откуда исходит этот запрос. * третий аргумент будет таблицей с информацией о запросе навигации и может содержать следующие ключи: * request - таблица, содержащая запрос, который сгенерировал этот запрос на действие политики. См. hs.webview.url для получения подробной информации о том, какие ключи могут быть в этой таблице. * sourceFrame - таблица, описывающая фрейм, в котором произошел запрос, содержащая следующие ключи: * mainFrame - логическое значение, указывающее, является ли это основным фреймом веб-вью или нет * request - таблица, содержащая запрос для этого фрейма. См. hs.webview.url для получения подробной информации о том, какие ключи могут быть в этой таблице. * targetFrame - таблица с теми же ключами, что и sourceFrame, но описывающая цель запроса, если она отличается. * buttonNumber - число, указывающее нажатую кнопку мыши, которая инициировала это действие, или 0, если кнопка мыши не участвовала (например, URL, указанный через hs.webview.url или запрос на изображение и т.д. как часть обработки предыдущего запроса). * modifierFlags - таблица, содержащая ключи для нажатых клавиш модификаторов, которые были нажаты при генерации навигации, генерирующей этот запрос политики. * navigationType - строка, указывающая, как была запрошена навигация: linkActivated, formSubmitted, backForward, reload, formResubmitted, или other
  • Функция обратного вызова должна вернуть true если навигация должна быть продолжена или false, если она должна быть отклонена.
  • navigationResponse: Это относится к любому подключению к серверу или службе, которая предоставляет содержимое для веб-вью, и происходит после того, как подключение установлено, но до того, как оно было отображено в веб-вью. * второй аргумент будет веб-вью, откуда исходит этот запрос. * третий аргумент будет таблицей с информацией о полученном ответе и может содержать следующие ключи: * canShowMIMEType - логическое значение, указывающее, может ли веб-вью отображать содержимое в родном формате или с помощью плагина. Если это значение равно false, скорее всего, содержимое либо вообще не может быть отображено, либо будет отображаться как бессмыслица в веб-вью. * forMainFrame - логическое значение, указывающее, является ли ответ для навигации основного содержимого фреймов (т.е. не изображение или подфрейм и т.д.) * response - таблица, описывающая ответ на запрос URL, и может содержать следующие ключи: * expectedContentLength - ожидаемая длина содержимого ответа * suggestedFileName - рекомендуемое имя файла для данных ответа * MIMEType - тип MIME данных ответа * textEncodingName - если ответ представляет собой текст, то здесь будет содержаться используемый тип кодирования * URL - URL фактического ответа. Обратите внимание, что он может отличаться от исходного запроса из-за редиректов и т.д. * statusCode - код HTTP ответа на запрос * statusCodeDescription - локализованное описание кода ответа * allHeaderFields - таблица, содержащая поля заголовка и значения, предоставленные в ответе
  • Функция обратного вызова должна вернуть true если навигация должна быть продолжена или false, если она должна быть отклонена.
  • newWindow: Это относится к любому запросу на создание нового окна из веб-вью. Это включает JavaScript, выбор пользователем «Открыть в новом окне» и т.д. * второй аргумент будет новым веб-вью, которое генерируется этим запросом. * третий аргумент будет таблицей с информацией о запросе навигации. См. описание выше для navigationAction для получения подробной информации об этом параметре. * четвертый аргумент будет таблицей, содержащей запрошенные функции для нового окна (ни одна из них по умолчанию не будет обработана — вы можете сами выбрать, удовлетворить или проигнорировать запросы на функции в функции обратного вызова с аргументом веб-вью). и может содержать следующие ключи: * menuBarVisibility - видимость меню. (Не функция, предоставляемая для окон под OS X) * statusBarVisibility - видимость строка состояния. (В настоящее время не поддерживается этим модулем) * toolbarsVisibility - видимость панелей инструментов. * allowsResizing - возможность изменения размеров нового окна. * x - координата x нового окна. * y - координата y нового окна. * h - координата высоты нового окна. * w - координата ширины нового окна.
  • Функция обратного вызова должна вернуть true если новое окно должно быть создано или false, если оно не должно быть создано.
  • authenticationChallenge: Это относится к веб-странице, которая требует учетных данных для входа для аутентификации HTTPBasic или HTTPDigest. * второй аргумент будет веб-вью, откуда исходит этот запрос. * третий аргумент будет таблицей с подробностями о вызове, и может содержать следующие ключи: * previousFailureCount - целое число, указывающее количество ранее неудачных попыток входа. Будет равно 0 для первой попытки. * failureResponse - данные ответа, как описано для navigationResponse выше для последнего ответа об ошибке аутентификации * proposedCredential - таблица, содержащая ранее неверные учетные данные, содержащая следующие ключи: * hasPassword - логическое значение, указывающее, был ли предоставлен пароль с этими учетными данными * persistence - строковое значение, определяющее постоянство этих учетных данных. Это значение будет одним из следующих: * None - учетные данные только для этого запроса URL и не для других * session - учетные данные для этой сессии и будут забыты после удаления веб-вью * permanent - учетные данные хранятся в хранилище ключей пользователя * synchronized - учетные данные хранятся в хранилище ключей пользователя и могут быть разделены с другими устройствами с тем же Apple ID владельца. * user - имя пользователя неверных учетных данных * password - пароль неверных учетных данных * protectionSpace - таблица, описывающая область для аутентификации, и может содержать следующие ключи: * port - порт сервера, с которым происходит общение для этого запроса * receivesCredentialSecurely - логическое значение, указывающее, может ли учетная запись быть отправлена на сервер безопасно * authenticationMethod - строка, указывающая тип аутентификации: default, HTTPBasic или HTTPDigest. Существуют и другие типы, но в настоящее время они не поддерживаются этим модулем или не применяются к веб-вью. * host - имя хоста сервера, с которым происходит общение для этого запроса * protocol - протокол, для которого происходит аутентификация * isProxy - логическое значение, указывающее, происходит ли аутентификация с прокси-сервером * proxyType - строка, представляющая тип прокси-сервера: http, https, ftp или socks. * realm - строка, представляющая имя области для аутентификации.
  • Функция обратного вызова должна вернуть true, если пользователю следует запросить имя пользователя и пароль, таблицу с ключами user и password, содержащими имя пользователя и пароль для входа, или false, если запрос входа должен быть отменен. Обратите внимание, что если ваша функция возвращает таблицу и не удается пройти аутентификацию три раза, пользователю все равно будет предложено это сделать, чтобы предотвратить циклы.

• Объект веб-вью

• При действии newWindow навигацияCallback и policyCallback автоматически дублируются для нового окна из родительского окна. Если вы хотите отключить их для нового окна или назначить другой набор функций обратного вызова, вы можете сделать это, прежде чем возвращать true в функции обратного вызова с предоставленным аргументом веб-вью.

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

• Ничего

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

• Этот метод поддерживается только в OS X 10.11 и новее

• См. hs.webview.datastore и hs.webview.new для получения дополнительной информации.

Перезагрузить страницу в веб-вьювере, при необходимости выполнив полную перепроверку с помощью условных проверок кеша.

• validate — необязательный boolean, указывающий, следует ли пытаться выполнить полную перепроверку кэшированных данных. По умолчанию false.

• Объект веб-вьювера

Разместить объект веб-вьювера за обычными окнами, между обоями рабочего стола и значками.

• Нет

• Объект рисования

Получить или установить, отображается ли у окна веб-вьювера тень. По умолчанию false.

• value — необязательное булево значение, указывающее, должна ли у веб-вьювера быть тень.

• Если значение предоставлено, метод возвращает объект веб-вьювера; в противном случае — текущее значение

Отобразить объект веб-вьювера.

• fadeInTime — необязательное число секунд для плавного появления веб-вьювера. По умолчанию ноль.

• Объект веб-вьювера

Получить или установить размер окна веб-вьювера.

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

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

• Таблица размеров — это таблица с парами ключ-значение, определяющими размер (ключи h и w), до которого должен быть изменён размер веб-вьювера. Таблица может быть создана любым методом, включающим эти ключи, включая использование объекта hs.geometry.

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

• fn — функция, которая вызывается для проверки сертификата SSL, чтобы определить, следует ли разрешить исключение. Чтобы отключить функцию обратного вызова, явно укажите nil. Функция обратного вызова примет два аргумента и должна вернуть 1 аргумент, который определит, одобрено или отклонено действие. Первый аргумент — веб-вьювер, из которого исходит этот запрос. Второй аргумент — таблица, содержащая детали защищенного пространства, и может включать следующие ключи:
  • port — порт сервера, с которым происходит общение по этому запросу.
  • receivesCredentialSecurely — булево значение, указывающее, можно ли безопасно отправить учредительные данные на сервер.
  • authenticationMethod — строка, указывающая тип аутентификации, в данном случае "serverTrust".
  • host — имя хоста сервера, с которым происходит общение по этому запросу.
  • protocol — протокол, для которого происходит аутентификация.
  • isProxy — boolean, указывающий, происходит ли аутентификация через прокси-сервер.
  • proxyType — строка, представляющая тип прокси-сервера: http, https, ftp или socks.
  • realm — строка, представляющая имя области аутентификации.
  • certificates — массив таблиц, каждая таблица описывает сертификат в цепочке сертификатов SSL, предоставленной сервером, отвечающим на запрос веб-вьювера. Каждая таблица будет содержать следующие ключи: * commonName — общее имя сертификата; чаще всего это строка, соответствующая части сервера в запросе URL-адреса или другому описанию назначения сертификата. * values — таблица, содержащая пары ключ-значение, описывающие сертификат. Ключи будут OID сертификата. Общие OID и их значение можно найти в hs.webview.certificateOIDs. Значение каждого ключа будет таблицей с ключами: * label — описание или метка записи * localized label — локализованная версия label * type — описание типа данных для этого значения * value — значение

• Объект веб-вьювера

• Функция обратного вызова должна возвращать true, если для этого сертификата должно быть разрешено исключение, или false, если оно должно быть отклонено.

• даже если этот обратный вызов вернёт true, сертификат получит исключение только в том случае, если hs.webview:examineInvalidCertificates также установлено в true.

• как только недействительному сертификату будет предоставлено исключение, это исключение останется в силе до удаления объекта веб-вьювера.

• обратный вызов вызывается только для недействительных сертификатов — если сертификат действителен или как только ему было предоставлено исключение, обратный вызов не вызывается (больше не вызывается) для этого сертификата.

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

Остановить загрузку дополнительного контента для веб-вьювера.

• Нет

• Объект веб-вьювера

• Этот метод не останавливает загрузку основного контента страницы по указанному URL-адресу
• Если hs.webview:loading вернёт true, этот метод ничего не делает — см. примечания:
  • Документация Apple не ясна, и эксперименты показали, что если этот метод применяется до загрузки содержимого указанного URL-адреса, это может привести к блокировке веб-вьювера; однако, похоже, он останавливает загрузку дополнительных ресурсов, указанных для контента (внешние файлы скриптов, внешние файлы стилей, запросы AJAX и т.д.), и должен использоваться в этом контексте.

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

• Нет

• заголовок

Получить или установить координату верхнего левого угла окна веб-вьювера.

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

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

• Таблица точек — это таблица с парами ключ-значение, определяющими новые координаты верхнего левого угла веб-вьювера на экране (ключи x и y). Таблица может быть создана любым методом, включающим эти ключи, включая использование объекта hs.geometry.

Получить или установить, является ли фон веб-вью прозрачным. По умолчанию — false.

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

• Если значение предоставлено, метод возвращает объект веб-вью; в противном случае — текущее значение

• При включении цвет фона веб-вью равен цвету тела background-color (по умолчанию прозрачный)
• Установка background-color:rgba(0, 225, 0, 0.3) на <body> придаст веб-вью полупрозрачный зелёный фон

Получить или установить URL для отображения в веб-вью.

• URL - необязательная строка или таблица, представляющая URL для отображения. Если вы предоставляете таблицу, она должна содержать один или несколько из следующих ключей (обратите внимание, что URL — единственный обязательный ключ):
  • URL - URL желаемого контента
  • mainDocumentURL - URL основного документа, если он отличается. Это обычно важно только для согласования куки и в настоящее время не оказывает влияния на этот модуль.
  • HTTPBody - тело сообщения запроса, как в запросе HTTP POST
  • HTTPMethod - HTTP-метод запроса, по умолчанию GET.
  • timeoutInterval - интервал ожидания запроса в секундах, по умолчанию 60.0.
  • HTTPShouldHandleCookies - автоматически ли должны обрабатываться куки, по умолчанию true. В настоящее время нет поддержки ручного управления куками, хотя это может измениться в будущем.
  • HTTPShouldUsePipelining - может ли запрос продолжать передавать данные до получения ответа от удалённого сервера. По умолчанию false.
  • cachePolicy - строковое значение, представляющее политику кэширования для запроса. Должно соответствовать одному из следующих значений: * protocolCachePolicy - (по умолчанию) политика кэширования, определённая как значение по умолчанию для протокола запроса URL * ignoreLocalCache - игнорировать любой кэшированный локально контент и запросить весь контент с удалённого сервера * returnCacheOrLoad - вернуть кэшированные данные, независимо от их возраста или срока действия. Если в кэше нет данных, соответствующих запросу, загрузить данные из исходного источника. * returnCacheDontLoad - рассматривать запрос как оффлайн - вернуть кэшированные данные, независимо от их возраста или срока действия. Если в кэше нет данных, соответствующих запросу, загрузка считается неудачной.
  • networkServiceType - строковое значение, представляющее тип сетевой службы запроса. Должно соответствовать одному из следующих значений: * default - (по умолчанию) стандартный сетевой трафик. Редко используйте значение, отличное от этого, так как это может повлиять на отзывчивость вашего компьютера и других приложений. * VoIP - при типе службы VoIP ядро продолжает прослушивать входящий трафик, пока ваше приложение находится на заднем плане, затем пробуждает ваше приложение всякий раз, когда появляются новые данные. Это следует использовать только для соединений, используемых для связи с VoIP-службой. * video - указывает, что это видео-трафик * background - используйте это для данных, если вы выполняете загрузку, не запрошенную пользователем — например, предварительную загрузку контента, чтобы он стал доступным, когда пользователь захочет его просмотреть. * voice - указывает, что это голосовая связь
  • HTTPHeaderFields - таблица, содержащая пары «ключ-значение», соответствующие дополнительным заголовкам, которые вы хотите включить в свой запрос. Поскольку спецификация HTTP требует, чтобы и ключи, и значения были строками, любые ключи, которые не являются строками, игнорируются, а любые значения, которые не являются строками или числами, также игнорируются. Кроме того, следующие ключи обрабатываются автоматически за кулисами и будут игнорироваться, если вы их укажете: * Authorization * Connection * Host * WWW-Authenticate * Content-Length

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

• Поле networkServiceType в таблице запроса URL является подсказкой для операционной системы о том, для чего используется подлежащий трафик. Эта подсказка улучшает способность системы приоритизировать трафик, определять, как быстро ей нужно разбудить радио Wi-Fi и так далее. Предоставляя точную информацию, вы улучшаете способность системы оптимально балансировать время автономной работы, производительность и другие соображения. Аналогично, неточная информация может негативно повлиять на производительность и время автономной работы вашей системы.

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

• Нет

• таблица, содержащая ключи URL веб-вью. См. функцию hs.http.urlParts для описания возможных ключей, возвращаемых в таблице.

• Этот метод является оболочкой для функции hs.http.urlParts которая использует API OS X, основанный на RFC 1808.
• Вы также можете рассмотреть функцию hs.httpserver.hsminweb.urlParts для версии, более согласованной с RFC 3986.

Получить или установить строку user agent веб-вью

• agent - опционная строка, задающая строку user agent, которая должна включаться во все запросы URL, выполняемые объектом веб-вью.

• Если параметр указан, возвращает объект веб-вью, в противном случае возвращает текущее значение

• Этот метод поддерживается только OS X 10.11 и новее

• Строка user agent по умолчанию, используемая объектами веб-вью, будет примерно такой (точные версии будут различаться в зависимости от вашей версии OS X):

• "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_5) AppleWebKit/601.6.17 (KHTML, like Gecko)"

• По умолчанию этот метод возвращает пустую строку ("") при запросе — это указывает на то, что используется значение по умолчанию, показанное выше. Вы также можете вернуться к этому значению по умолчанию, установив user agent в "" с помощью этого метода (например, hs.webview:userAgent("")).

• Некоторые веб-сайты подстраивают контент в зависимости от строки user agent или используют её для других внутренних целей (отслеживание, статистика, доступность страницы, макет и т. д.). Общие строки user-agent можно найти на http://www.useragentstring.com/pages/useragentstring.php.

• Если вы установили имя приложения user agent с параметром applicationName в конструктор hs.webview.new, оно будет проигнорировано, если это значение не равно "", т. е. строке user agent по умолчанию. Если вы хотите указать имя приложения после строки user agent и использовать пользовательскую строку, включите имя приложения в вашу пользовательскую строку.

Установить или очистить обратный вызов для обновлений окна веб-вью

• fn - функция, которая будет вызываться при перемещении или закрытии окна веб-вью. Укажите явное nil, чтобы очистить текущий обратный вызов. Функция должна ожидать 2 или 3 аргумента и не возвращать значение. Аргументы будут следующими:
  • "closing", webview - указывает, что окно веб-вью закрывается, либо пользователем, либо с помощью метода hs.webview:delete. * action - в этом случае "closing", указывающий на закрытие окна веб-вью * webview - веб-вью, которое закрывается
  • "focusChange", webview, state - указывает, что окно веб-вью стало или перестало быть активным окном * action - в этом случае "focusChange", указывающий на закрытие окна веб-вью * webview - веб-вью, которое закрывается * state - булево значение, true, если веб-вью стало активным окном, или false, если оно потеряло фокус
  • "frameChange", webview, frame - указывает, что окно веб-вью было перемещено или переопределено * action - в этом случае "focusChange", указывающий на закрытие окна веб-вью * webview - веб-вью, которое закрывается * frame - прямоугольная таблица, содержащая новые координаты и размер окна веб-вью

• Объект веб-вью

Получить или установить стиль отображения окна

• mask - если присутствует, эта маска должна быть комбинацией значений, найденных в hs.webview.windowMasks , описывающих стиль окна. Маска должна быть предоставлена как одно из следующего:
  • целое число - число, представляющее стиль, который может быть создан путем объединения значений, найденных в hs.webview.windowMasks, с оператором логического ИЛИ.
  • строка - единственный ключ из hs.webview.windowMasks, который будет переключен в текущем стиле окна.
  • таблица - список ключей из hs.webview.windowMasks, которые будут объединены для создания конечного стиля путем объединения их значений с оператором логического ИЛИ.

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

Устанавливает заголовок для окна webview.

• title - если указан и не равен nil, то это заголовок для установки в окне webview. Если этот параметр отсутствует или равен nil, заголовок будет следовать за заголовком содержимого webview.

• Объект webview

• Заголовок будет скрыт, если стиль окна не включает стиль «titled» (см. hs.webview.windowStyle и hs.webview.windowMasks)