PySide6.QtWebEngineCore.QWebEngineCookieStore

class QWebEngineCookieStore

The QWebEngineCookieStore class provides access to Chromium’s cookies. More…

Inheritance diagram of PySide6.QtWebEngineCore.QWebEngineCookieStore

Synopsis

Methods

Signals

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

The class allows to access HTTP cookies of Chromium for a specific profile. It can be used to synchronize cookies of Chromium and the QNetworkAccessManager, as well as to set, delete, and intercept cookies during navigation. Because cookie operations are asynchronous, the user can choose to provide a callback function to get notified about the success of the operation. The signal handlers for removal and addition should not be used to execute heavy tasks, because they might block the IO thread in case of a blocking connection.

Use cookieStore() and cookieStore() to access the cookie store object for a specific profile.

cookieAdded(cookie)
Parameters:

cookie – QNetworkCookie

This signal is emitted whenever a new cookie is added to the cookie store.

cookieRemoved(cookie)
Parameters:

cookie – QNetworkCookie

This signal is emitted whenever a cookie is deleted from the cookie store.

deleteAllCookies()

Deletes all the cookies in the cookie store.

Note

This operation is asynchronous.

See also

loadAllCookies()

deleteCookie(cookie[, origin=QUrl()])
Parameters:

Deletes cookie from the cookie store. It is possible to provide an optional origin URL argument to limit the scope of the cookie to be deleted.

Note

This operation is asynchronous.

deleteSessionCookies()

Deletes all the session cookies in the cookie store. Session cookies do not have an expiration date assigned to them.

Note

This operation is asynchronous.

See also

loadAllCookies()

loadAllCookies()

Loads all the cookies into the cookie store. The cookieAdded() signal is emitted on every loaded cookie. Cookies are loaded automatically when the store gets initialized, which in most cases happens on loading the first URL. However, calling this function is useful if cookies should be listed before entering the web content.

Note

This operation is asynchronous.

setCookie(cookie[, origin=QUrl()])
Parameters:

Adds cookie to the cookie store.

Note

If cookie specifies a QNetworkCookie::domain() that does not start with a dot, a dot is automatically prepended. To limit the cookie to the exact server, omit QNetworkCookie::domain() and set origin instead.

The provided URL should also include the scheme.

Note

This operation is asynchronous.

setCookieFilter(filterCallback)
Parameters:

filterCallback – PyCallable