Aller au contenu principal

Classe : Cookies

Classe : Cookies​

Consulter et modifier les cookies d'une session.

Processus : Principal
Cette classe n'est pas exportée depuis le module 'electron'. Elle n'est disponible qu'en tant que valeur de retour des autres méthodes dans l'API Electron.

Les instances de la classe Cookies sont accessibles à l'aide de la propriété cookies d'une Session.

Par exemple :

const { session } = require('electron')

// Récupère tous les cookies.
session.defaultSession.cookies.get({})
  .then((cookies) => {
    console.log(cookies)
  }). atch((error) => {
    console.log(error)
  })

// Interroge tous les cookies associés à une Url spécifique.
session.defaultSession.cookies.get({ url: 'http://www.github.com' })
  .then((cookies) => {
    console.log(cookies)
  }). atch((erreur) => {
    console. og(error)
  })

// Définit un cookie avec les données de cookie spécifiées;
// peut écraser les cookies similaires s'ils existent.
const cookie = { url: 'http://www.github.com', name: 'dummy_name', value: 'dummy' }
session.defaultSession.cookies.set(cookie)
  . hen(() => {
    // succès
  }, (erreur) => {
    console. rror(erreur)
})

Événements d’instance​

Les événements suivants sont disponibles pour les instances de Cookies :

Événement : 'changed'​

Retourne :

  • event Event
  • cookie Cookie - Le cookie qui a été changé.
  • cause string - Cause du changement pouvant prendre une des valeurs suivantes :
    • explicit - Le cookie a été modifié directement par l'action du consommateur.
    • overwrite - Le cookie a été supprimé automatiquement a cause d'une insertion écrasante.
    • expired - Le cookie a été supprimé automatiquement par expiration.
    • evicted - Le cookie a été expulsé automatiquement par le ramasse-miettes.
    • expired-overwrite - Le cookie a été écrasé avec une date d'expiration dépassée.
  • removed boolean - true si le cookie a été supprimé, false autrement.

Émis lorsqu’un cookie a changé suite à un ajout, une édition, une suppresion ou son expiration.

Méthodes d’instance​

Les méthodes suivantes sont disponibles sur les instances de Cookies :

cookies.get(filter)​

  • Objet filter
    • url string (facultatif) - Récupère les cookies qui sont associés à url. Si la chaîne est vide les cookies de toutes les URL seront récupérés.
    • name string (facultatif) - Filtre les cookies par nom.
    • domain string (facultatif) - Récupère les cookies dont les domaines correspondent ou sont des sous-domaines de domains.
    • path string (facultatif) - Récupère les cookies dont le chemin correspond à path.
    • secure boolean (facultatif) - Filtre les cookies par leur propriété Secure.
    • session boolean (facultatif) - filtre les session ou les cookies persistants.
    • httpOnly boolean (facultatif) - Filtre les cookies par httpOnly.

Retourne Promise<Cookie[]> - Une promesse qui se résout avec un tableau d'objets cookie.

Envoie une demande pour obtenir tous les cookies correspondant à filter, et résout une promesse avec la réponse.

cookies.set(détails)​

  • Objet details
    • Chaîne url - L'URL avec laquelle associer le cookie. La promesse sera rejetée si l'URL est invalide.
    • name string (facultatif) - Nom du cookie. Chaîne vide par défaut si omis.
    • value string (facultatif) - Valeur du cookie. Chaîne vide par défaut si omis.
    • domain string (facultatif) - Le nom de domaine du cookie; ce dernier sera normalisé par un point le précédent pour qu'il soit valide pour les sous-domaines. Chaîne vide par défaut si omis.
    • path string (facultatif) - Le chemin du cookie. Chaîne vide par défaut si omis.
    • secure boolean (facultatif) - Indique si le cookie doit être marqué comme Secure. false par défaut à moins que l'attribut Same Site=None ne soit utilisé.
    • httpOnly boolean (facultatif) - Indique si le cookie doit être marqué comme HTTP seulement. False par défaut.
    • expirationDate Double (facultatif) - Date d'expiration du cookie exprimée en secondes depuis l'epoch UNIX. Si omis, le cookie devient alors un cookie de session et ne sera donc pas conservé entre deux sessions.
    • sameSite string (facultatif) - La politique de Même site à appliquer à ce cookie. Peut prendre les valeurs unspecified, no_restriction,lax ou strict. Par défaut la valeur est lax.

Retourne Promise<void> - Une promesse qui se résout lorsque le cookie a été défini

Définit un cookie selon details.

cookies.remove(url, nom)​

  • url string - Url associée au cookie.
  • name string - Nom du cookie à supprimer.

Retourne Promise<void> - Une promesse qui se résout lorsque le cookie a été supprimé

Supprime les cookies correspondant à url et name

cookies.flushStore()​

Retourne Promise<void> - Une promesse qui se résout lorsque la boutique de cookies a été vidée

Écrit toutes les données des cookies non écrites sur le disque.