Modules

cookies.set()

La méthode set() de l'API cookies défint un cookie contenant les données de cookie spécifiées. Cette méthode équivaut à l'émission d'un en-tête HTTP Set-Cookie lors d'une requête adressée à une URL donnée.

L'appel réussit uniquement si vous incluez la permission de l'API "cookies" dans votre fichier manifest.json, ainsi que les permissions d'hôte pour l'URL indiquée dans son manifest. L'URL donnée a également besoin des permissions nécessaires pour créer un cookie avec les paramètres donnés.

C'est une fonction asynchrone qui renvoie une Promise.

Syntaxe

var setting = browser.cookies.set(
  details               // object
)

Paramètres

details
Un objet contenant les détails du cookie  que vous souhaitez définir. Il peut avoir les propriétés suivantes :
url
Une chaîne représenant l'URI de requête à associer au cookie. CEtte valeur peut affecter les valeurs par défaut du cookie créé. Si les autorisations d'hote pour cette URL ne sont pas spécifiées dans le fichier manifest, l'appel de la méthode échouera.
nameFacultatif
Une chaîne représentant le nom du cookie. S'il est omi, il est vide par défaut.
valueFacultatif
Une chaîne représentant la valeur du cookie. représentant le nom du cookie. S'il est omi, il est vide par défaut.
domainFacultatif
Une chaîne représentant le domaine du cookie. S'il est omi, representing the domain of the cookie. If omi, le cookie devient un cookie hote uniquement.
pathFacultatif
Une chaîne représentant le chemin du cookie. S'il est omi, la valeur par défaut est la partie du chemin du paramètre de l'URL.
secureFacultatif
Un booléen qui spécifie si le cookie doit être marqué comme sécurisé (true), ou pas (false). S'il est omi, la valeur par défaut est false.
httpOnlyFacultatif
Un booléen qui spécifie si le cookie doit être marqué comme  HttpOnly (true), ou pas (false). S'il est omi, la valeur par défaut est  false.
expirationDateFacultatif
Un nombre qui représente la date d'expiration du cookie en tant que nombre en secondes écoulées depuis l'époqueUNIX. S'il est omi, le cookie devient un cookie de session.
storeIdFacultatif
Une chaîne représentant l'ID du cookie store dans lequel défini le cookie. S'il est omi, le cookie est défini par défaut dans le cookie store du contexte d'exécution actuel.

Valeur retournée

Une Promise qui sera remplie avec un objet  cookies.Cookie contenant les détails sur le cookie qui a été défini. Si l'appel échoue pour une raison quelconque, la promesse sera rejetée avec un message d'erreur.

Compatibilité du navigateur

ChromeEdgeFirefoxFirefox for AndroidOpera
Support simple Oui Oui451481 Oui

1. Before version 56, this function did not modify cookies in private browsing mode. From version 56 onwards this is fixed.

Exemples

Cet exemple définit un cookie pour le document hébergé par l'onglet actuellement actif :

var getActive = browser.tabs.query({active: true, currentWindow: true});
getActive.then(setCookie);

function setCookie(tabs) {
  browser.cookies.set({
    url: tabs[0].url,
    name: "favourite-colour",
    value: "red"
  });
}

Example extensions

Remerciements :

Cette API est basée sur l'API Chromium chrome.cookies. Cette documentation est dérivée de cookies.json dans le code Chromium.

Les données de compatibilité relatives à Microsoft Edge sont fournies par Microsoft Corporation et incluses ici sous la licence Creative Commons Attribution 3.0 pour les États-Unis.

Étiquettes et contributeurs liés au document

 Contributeurs à cette page : hellosct1
 Dernière mise à jour par : hellosct1,