Saltar al contenido principal

Clase: Cookies

Clase: Cookies​

Busca y modifica las cookies de la sesión.

Proceso: Main
Esta clase no está exportada desde el módulo 'electron'. Sólo está disponible como un valor de retorno de otros métodos en la API de Electron.

Las instancias de la clase Cookies son accedidas utilizado la propiedad cookies de una Session.

Por ejemplo:

const { session } = require('electron')

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

// Consulta todas las cookies asociadas con un url especifica.
session.defaultSession.cookies.get({ url: 'https://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: 'https://www.github.com', name: 'dummy_name', value: 'dummy' }
session.defaultSession.cookies.set(cookie)
  .then(() => {
    // success
  }, (error) => {
    console.error(error)
  })

Eventos de Instancia​

Los siguientes eventos están disponibles en las instancias de Cookies:

Evento: "changed"​

Devuelve:

  • event
  • cookie Cookie - La cookie que se ha cambiado.
  • cause string - La causa del cambio con uno de los siguientes valores:
    • explicit - La cookie se cambió directamente por la acción de un consumidor.
    • overwrite - La cookie se eliminó automáticamente debido a una operación insertada que la sobreescribió.
    • expired - La cookie se eliminó automáticamente debido a que expiró.
    • evicted - La cookie fue desecha automáticamente durante la recolección de desechos.
    • expired-overwrite - La cookie fue sobreescrita con una fecha de vencimiento ya expirada.
  • removed booleano - true si la cookie se eliminó, false si no lo hizo.

Aparece cuando se cambia una cookie porque fue añadida, editada, eliminada o expirada.

Métodos de Instancia​

Los siguientes métodos están disponibles en las instancias de Cookies:

cookies.get(filter)​

  • Objeto filter
    • url string (opcional) - Recupera las cookies las cuales están asociadas con la url. Vacío implica recuperar las cookies de todas las URLs.
    • name cadena (opcional) - Filtra las cookies por nombre.
    • domain cadena (opcional) - Recupera las cookies de cuyos dominios coinciden o son subdominios de domains.
    • path cadena (opcional) - Recupera las cookies de cuya ruta coincide con path.
    • secure booleano (opcional) - Filtra las cookies por su propiedad Secure.
    • session booleano (opcional) - Filtra las cookies fuera de la sesión o cookies persistentes.
    • httpOnly boolean (optional) - Filters cookies by httpOnly.

Returns Promise<Cookie[]> - Una promesa que resulve un array de objetos cookies.

Envía una solicitud para obtener todas las cookies que coincidan con filter, y resuelve una promesa con la respuesta.

cookies.set(details)​

  • details Object
    • url string - La URL con la que asociar la cookie. La promise será rechazada si la URL es invalida.
    • name string (opcional) - El nombre de la cookie. Vacío por defecto si se omite.
    • value string (opcional) - El valor de la cookie. Vacío por defecto si se omite.
    • domain string (optional) - El dominio de la cookie; este será normalizado por precediéndolo con un punto para que también sea valido para el uso de subdominios. Vacío por defecto si se omite.
    • path string (opcional) - La ruta de la cookie. Vacío por defecto si se omite.
    • secure boolean (opcional) - Si la cookie debería ser marcado como Segura o no. Por defecto false a menos que el atributo Same Site=None sea utilizado.
    • httpOnly boolean (opcional) - Si la cookie debería ser marcada como sólo HTTP. Por defecto es falso.
    • expirationDate Doble (opcional) - La fecha de vencimiento de la cookie como el número de segundos desde la época UNIX. Si se omite, entonces la cookie cambia a una cookie de sesión y no se conservará entre sesiones.
    • sameSite string (opcional) - La política del Mismo sitio para aplicar a esta cookie. Puede ser unspecified, no_restriction, lax o strict. Por defecto es lax.

Returns Promise<void> - Una promesa que resuelve cuando la cookie ha sido establecida

Establece una cookie con detalles.

cookies.remove(url, name)​

  • url cadena - La URL asociada con la cookie.
  • name cadena - El nombre de la cookie que será eliminada.

Devuelve Promise<void> - Una promesa que se resuelve cuando la cookie ha sido removida

Elimina las cookies que coinciden con url y name

cookies.flushStore()​

Devuelve Promise<void> - Una promesa que se resuelve cuando el almacenamiento de la cookie ha sido borrado

Escribe cualquier dato de cookies en el disco que no haya sido escrito

Cookies written by any method will not be written to disk immediately, but will be written every 30 seconds or 512 operations

Calling this method can cause the cookie to be written to disk immediately.