Spec-Zone.ru › Hammerspoon

hs.webview.datastore

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

Этот модуль доступен только под OS X 10.11 и более поздними версиями.

Этот модуль позволяет перечислять и выборочно очищать типы данных, хранящихся локально для веб-сайтов, посещаемых с помощью модуля hs.webview. Он также добавляет поддержку неперсистентных хранилищ данных для hs.webview (режим инкогнито) и позволяет неперсистентному хранилищу данных быть общим для нескольких экземпляров объектов hs.webview.

Хранилище данных для webview содержит различные типы данных, включая куки, кэши на диске и в памяти, а также постоянные данные, такие как базы данных WebSQL, IndexedDB и локальное хранилище. Вы можете использовать методы в этом модуле для выборочной или полной очистки общего хранилища данных (используемого всеми экземплярами Hammerspoon hs.webview без неперсистентного хранилища).

Обзор API

  • Функции - API-вызовы, предлагаемые непосредственно расширением
    • websiteDataTypes
  • Конструкторы - API-вызовы, возвращающие объект, обычно тот, который предлагает API-методы
    • default
    • fromWebview
    • newPrivate
  • Методы - API-вызовы, которые могут быть выполнены только над объектом, возвращаемым конструктором
    • fetchRecords
    • persistent
    • removeRecordsAfter
    • removeRecordsFor

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

Функции

websiteDataTypes
Подпись hs.webview.datastore.websiteDataTypes() -> table
Тип Функция
Описание

Возвращает список доступных типов данных в хранилище данных.

Параметры
  • Ничего
Возвращает
  • список строк, где каждая строка — это определённый тип данных, хранящийся в хранилище данных.
Примечания
  • На момент написания этого модуля следующие типы данных определены и возвращаются этой функцией:
    • WKWebsiteDataTypeDiskCache — кэши на диске.
    • WKWebsiteDataTypeOfflineWebApplicationCache — кэши автономных веб-приложений HTML.
    • WKWebsiteDataTypeMemoryCache — кэши в оперативной памяти.
    • WKWebsiteDataTypeLocalStorage — локальное хранилище HTML.
    • WKWebsiteDataTypeCookies — Куки.
    • WKWebsiteDataTypeSessionStorage — сессионное хранилище HTML.
    • WKWebsiteDataTypeIndexedDBDatabases — базы данных WebSQL.
    • WKWebsiteDataTypeWebSQLDatabases — базы данных IndexedDB.
Источник extensions/webview/libwebview_datastore.m строка 20

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

default
Подпись hs.webview.datastore.default() -> datastoreObject
Тип Конструктор
Описание

Возвращает объект, представляющий хранилище данных по умолчанию для экземпляров Hammerspoon hs.webview.

Параметры
  • Ничего
Возвращает
  • datastoreObject
Примечания
  • это хранилище данных используется, если не указано иное при создании экземпляра hs.webview.
Источник extensions/webview/libwebview_datastore.m строка 47
fromWebview
Подпись hs.webview.datastore.fromWebview(webview) -> datastoreObject
Тип Конструктор
Описание

Возвращает объект, представляющий хранилище данных для указанного экземпляра hs.webview.

Параметры
  • webview — экземпляр hs.webview (webviewObject)
Возвращает
  • datastoreObject
Примечания
  • При работе на системе с OS X 10.11 или более поздней, этот метод также будет добавлен в метатаблицу для объектов hs.webview, так что вы можете получить хранилище данных webview с помощью hs.webview:datastore().

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

Источник extensions/webview/libwebview_datastore.m строка 87
newPrivate
Подпись hs.webview.datastore.newPrivate() -> datastoreObject
Тип Конструктор
Описание

Возвращает объект, представляющий вновь созданное неперсистентное (приватное) хранилище данных для использования с экземпляром Hammerspoon hs.webview.

Параметры
  • Ничего
Возвращает
  • datastoreObject
Примечания
  • Хранилище данных, представленное этим объектом, будет изначально пустым. Вы можете использовать эту функцию для создания неперсистентного хранилища данных, которое вы хотите использовать совместно между несколькими экземплярами hs.webview. После создания хранилища данных вы назначаете его экземпляру hs.webview, включив ключ datastore в таблицу предпочтений конструктора hs.webview.new и установив его равным этому ключу. Все экземпляры webview, созданные с этим объектом хранилища данных, будут совместно использовать кэши веб-страниц, куки и т. д., но по-прежнему будут изолированы от хранилища данных по умолчанию, и оно будет очищено из памяти при удалении webview или перезапуске Hammerspoon.

  • Использование ключа datastore в конструкторе webview отличается от ключа private — использование ключа private переопределит ключ datastore и создаст отдельное неперсистентное хранилище данных для экземпляра webview. См. hs.webview.new для получения дополнительной информации.

Источник extensions/webview/libwebview_datastore.m строка 66

Методы

fetchRecords
Подпись hs.webview.datastore:fetchRecords([dataTypes], callback) -> datastoreObject
Тип Метод
Описание

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

Параметры
  • dataTypes — необязательная строка или таблица, определяющая типы данных для извлечения из хранилища данных. Если этот параметр не указан, он по умолчанию принимает список, возвращаемый hs.webview.datastore.websiteDataTypes.
  • callback — функция, которая принимает в качестве аргумента массив-таблицу, содержащую таблицы со следующими парами ключ-значение:
    • displayName — строка, содержащая имя сайта для отображения. Обычно имя для отображения — это доменное имя с суффиксом, взятым из источника безопасности ресурса (имя веб-сайта).
    • dataTypes — таблица, содержащая строки, представляющие типы данных, хранящихся для веб-сайта, указанного в displayName.
Возвращает
  • объект хранилища данных
Примечания
  • возвращаются только те сайты, у которых есть один или несколько указанных типов данных
  • для возвращаемых сайтов будут включены только те типы данных, которые были в запросе, даже если сайт имеет данные другого типа в хранилище данных.
Источник extensions/webview/libwebview_datastore.m строка 117
persistent
Подпись hs.webview.datastore:persistent() -> bool
Тип Метод
Описание

Возвращает, является ли хранилище данных постоянным.

Параметры
  • Ничего
Возвращает
  • булево значение, указывающее, является ли хранилище данных постоянным (true) или приватным (false)
Примечания
  • Обратите внимание, что это значение является обратным к hs.webview:privateBrowsing(), так как приватный просмотр использует неперсистентное хранилище данных.
Источник extensions/webview/libwebview_datastore.m строка 381
removeRecordsAfter
Подпись hs.webview.datastore:removeRecordsAfter(date, dataTypes, [callback]) -> datastoreObject
Тип Метод
Описание

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

Параметры
  • date — целое число, представляющее секунды, прошедшие с момента 1970-01-01 00:00:00 +0000 (например, os.time()), или строка, содержащая дату в формате RFC3339 (YYYY-MM-DD[T]HH:MM:SS[Z]).
  • dataTypes — строка или массив строк, определяющий типы данных для удаления из хранилища данных для указанных сайтов.
  • callback — необязательная функция, которая не должна принимать аргументы, и будет вызвана после удаления указанных элементов из хранилища данных.
Возвращает
  • объект хранилища данных
Примечания
  • Да, вы правильно прочитали описание — удаляются данные, позже указанной даты. Пока я не нашёл способ удалить данные, раньше указанной даты (например, для истечения срока действия старых данных), но предложения или обновления приветствуются в группе Hammerspoon Google или на веб-сайте GitHub.

  • Для указания, что должны быть удалены все типы данных, которые подходят, укажите функцию hs.webview.datastore.websiteDataTypes() в качестве второго аргумента.

  • Например, чтобы очистить хранилище данных Hammerspoon по умолчанию от всех данных, можно сделать следующее:

hs.webview.datastore.default():removeRecordsAfter(0, hs.webview.datastore.websiteDataTypes())
Источник extensions/webview/libwebview_datastore.m строка 287
removeRecordsFor
Подпись hs.webview.datastore:removeRecordsFor(displayNames, dataTypes, [callback]) -> datastoreObject
Тип Метод
Описание

Удалить данные из хранилища заданного типа(ов) для указанного сайта(ов).

Параметры
  • displayNames - строка или массив строк, указывающие отображаемые имена (сайты), для которых необходимо удалить записи.
  • dataTypes - строка или массив строк, указывающие типы данных для удаления из хранилища для указанных сайтов.
  • callback - необязательная функция, которая не должна принимать аргументов и будет вызвана после удаления указанных элементов из хранилища.
Возвращаемое значение
  • объект хранилища
Примечания
  • чтобы указать, что должны быть удалены все типы данных, которые подходят, укажите функцию hs.webview.datastore.websiteDataTypes() в качестве второго аргумента.
Источник extensions/webview/libwebview_datastore.m строка 186

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

Spec-Zone.ru

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