Class: Cookies
Class: Cookies
Query and modify a session's cookies.
Processo: Principal
Esta classe não é exportada do módulo 'electron'
. Ele é somente disponibilizado como um valor de retorno de outros métodos na API Electron.
Instâncias da classe Cookies
são acessadas através da propriedade cookies
de uma Sessão
.
Como por exemplo:
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)
})
Eventos de instância
Os seguintes eventos estão disponíveis em instâncias de Cookies
:
Evento: 'changed'
Retorna:
event
Eventcookie
Cookie - O cookie que foi modificado.cause
string - The cause of the change with one of the following values:explicit
- O cookie foi modificado diretamente por uma ação do consumidor.overwrite
- O cookie foi removido automaticamente devido à uma ação de inserção que o sobrescreveu.expired
- O cookie foi automaticamente removido conforme expirou.evicted
- The cookie was automatically evicted during garbage collection.expired-overwrite
- The cookie was overwritten with an already-expired expiration date.
removed
boolean -true
se o cookie foi removido,false
caso contrário.
Emitido quando um cookie é modificado devido à adição, edição, remoção ou expiração.
Métodos de Instância
Os metódos a seguir estão disponíveis em instâncias de Cookies
:
cookies.get(filter)
filter
Objecturl
string (optional) - Retrieves cookies which are associated withurl
. Empty implies retrieving cookies of all URLs.name
string (opcional) - Filtra cookies por nome.domain
string (opcional) - Recupera cookies nos quais os domínios sejam iguais ou subdomínios dedomain
.path
string (opcional) - Recupera cookies nos quais o caminho seja igual apath
.secure
boolean (opcional) - Filtra cookies pela propriedade Secure.session
boolean (optional) - Filters out session or persistent cookies.httpOnly
boolean (optional) - Filters cookies by httpOnly.
Returns Promise<Cookie[]>
- A promise which resolves an array of cookie objects.
Sends a request to get all cookies matching filter
, and resolves a promise with the response.
cookies.set(details)
- Objeto
details
url
string - The URL to associate the cookie with. The promise will be rejected if the URL is invalid.name
string (optional) - The name of the cookie. Empty by default if omitted.value
string (optional) - The value of the cookie. Empty by default if omitted.domain
string (opcional) - O domínio do cookie; isto será normalizado com um ponto no início para que ele também seja válido para subdomínios. Empty by default if omitted.path
string (opcional) - O Diretório do cookie. Empty by default if omitted.secure
boolean (optional) - Whether the cookie should be marked as Secure. Defaults to false unless Same Site=None attribute is used.httpOnly
boolean (optional) - Whether the cookie should be marked as HTTP only. Defaults to false.expirationDate
Double (optional) - The expiration date of the cookie as the number of seconds since the UNIX epoch. If omitted then the cookie becomes a session cookie and will not be retained between sessions.sameSite
string (optional) - The Same Site policy to apply to this cookie. Pode serunspecified
,no_restriction
,lax
oustrict
. Por padrão élax
.
Returns Promise<void>
- A promise which resolves when the cookie has been set
Sets a cookie with details
.
cookies.remove(url, name)
url
string - A URL associada com o cookie.name
string - O nome do cookie a ser removido.
Returns Promise<void>
- A promise which resolves when the cookie has been removed
Removes the cookies matching url
and name
cookies.flushStore()
Returns Promise<void>
- A promise which resolves when the cookie store has been flushed
Escreve qualquer cookie que não tenha sido escrito no disco.