Класс: Cookies

Запрос и изменение файлов cookie сессии.

Процесс: Основной
Этот класс не экспортируется из модуля 'electron'. Он доступен только в качестве значения возврата других методов в API Electron.

Экземпляры класса Cookies доступны через свойство cookies объекта Session.

Например:

const { session } = require('electron')

// Query all cookies.
session.defaultSession.cookies.get({})
  .then((cookies) => {
    console.log(cookies)
  }).catch((error) => {
    console.log(error)
  })

// Query all cookies associated with a specific url.
session.defaultSession.cookies.get({ url: 'http://www.github.com' })
  .then((cookies) => {
    console.log(cookies)
  }).catch((error) => {
    console.log(error)
  })

// Set a cookie with the given cookie data;
// may overwrite equivalent cookies if they exist.
const cookie = { url: 'http://www.github.com', name: 'dummy_name', value: 'dummy' }
session.defaultSession.cookies.set(cookie)
  .then(() => {
    // success
  }, (error) => {
    console.error(error)
  })

События экземпляра

Следующие события доступны для экземпляров Cookies:

Событие: 'changed'

Возвращает:

event Событие
cookie Файл cookie - Измененный файл cookie.
cause строка - Причина изменения с одним из следующих значений:
- explicit - Файл cookie был изменен непосредственно действием пользователя.
- overwrite - Файл cookie был автоматически удален из-за операции вставки, которая его перезаписала.
- expired - Файл cookie был автоматически удален по истечении срока действия.
- evicted - Файл cookie был автоматически удален во время сбора мусора.
- expired-overwrite - Файл cookie был перезаписан с уже истекшим сроком действия.
removed boolean - true если файл cookie был удален, false в противном случае.

Вызывается при изменении файла cookie, добавлении, редактировании, удалении или истечении срока действия.

Методы экземпляра

Следующие методы доступны для экземпляров Cookies:

`cookies.get(filter)`

filter Объект
- url строка (необязательно) - Возвращает файлы cookie, связанные с url. Пустая строка означает получение файлов cookie всех URL.
- name строка (необязательно) - Фильтрует файлы cookie по имени.
- domain строка (необязательно) - Возвращает файлы cookie, чьи домены совпадают или являются поддоменами domains.
- path строка (необязательно) - Возвращает файлы cookie, чьи пути совпадают с path.
- secure boolean (необязательно) - Фильтрует файлы cookie по их свойству Secure.
- session boolean (необязательно) - Фильтрует сеансовые или постоянные файлы cookie.

Возвращает Promise<Cookie[]> - Обещание, которое разрешает массив объектов cookie.

Отправляет запрос на получение всех файлов cookie, соответствующих filter, и разрешает обещание с ответом.

`cookies.set(details)`

details Объект
- url строка - URL, с которым ассоциируется файл cookie. Обещание будет отклонено, если URL недействителен.
- name строка (необязательно) - Имя файла cookie. По умолчанию пустое, если опущено.
- value строка (необязательно) - Значение файла cookie. По умолчанию пустое, если опущено.
- domain строка (необязательно) - Домен файла cookie; он будет нормализован с предшествующей точкой, чтобы быть также допустимым для поддоменов. По умолчанию пустое, если опущено.
- path строка (необязательно) - Путь файла cookie. По умолчанию пустое, если опущено.
- secure boolean (необязательно) - Указывает, должен ли файл cookie быть отмечен как Secure. По умолчанию false, если не используется атрибут SameSite=None.
- httpOnly boolean (необязательно) - Указывает, должен ли файл cookie быть помечен как HTTP-только. По умолчанию false.
- expirationDate Double (необязательно) - Дата истечения срока действия файла cookie как количество секунд с момента эпохи Unix. Если опущено, файл cookie становится сеансовым и не сохраняется между сеансами.
- sameSite строка (необязательно) - Политика Same Site, применяемая к этому файлу cookie. Может быть unspecified, no_restriction, lax или strict. По умолчанию lax.

Возвращает Promise<void> - Обещание, которое разрешается, когда файл cookie задан.

Устанавливает файл cookie с details.

`cookies.remove(url, name)`

url строка - URL, связанный с файлом cookie.
name строка - Имя файла cookie для удаления.

Возвращает Promise<void> - Обещание, которое разрешается, когда файл cookie удален.

Удаляет файлы cookie, соответствующие url и name.

`cookies.flushStore()`

Возвращает Promise<void> - Обещание, которое разрешается, когда хранилище файлов cookie очищено.

Записывает все не записанные данные файлов cookie на диск.