QNetworkCookieJar Class

成员函数文档

[explicit] QNetworkCookieJar::QNetworkCookieJar(QObject *parent = nullptr)

创建一个 QNetworkCookieJar 对象，并将父对象设置为parent 。

cookie jar 初始化为空。

[virtual noexcept] QNetworkCookieJar::~QNetworkCookieJar()

销毁 cookie jar 对象并丢弃其中存储的所有 cookie。在QNetworkCookieJar 默认实现中，Cookie 不会保存到磁盘。

如果需要将 cookie 保存到磁盘，则必须从QNetworkCookieJar 派生，并自行将 cookie 保存到磁盘。

[protected] QList<QNetworkCookie> QNetworkCookieJar::allCookies() const

返回存储在此 cookie jar 中的所有 cookie。该函数适用于将 cookie 保存到磁盘的派生类，也适用于执行 cookie 过期和其他策略。

另请参阅 setAllCookies() 和cookiesForUrl()。

[virtual] QList<QNetworkCookie> QNetworkCookieJar::cookiesForUrl(const QUrl &url) const

返回向url 发送请求时要添加的 cookie。默认的QNetworkAccessManager::createRequest() 会调用此函数，将此函数返回的 cookie 添加到发送的请求中。

如果找到多个同名但路径不同的 cookie，则先返回路径较长的 cookie，再返回路径较短的 cookie。换句话说，该函数返回的 cookie 按路径长度递减排序。

默认的QNetworkCookieJar 类只实现了非常基本的安全策略（确保 cookie 的域和路径与回复的相匹配）。要使用自己的算法增强安全策略，请覆盖 cookiesForUrl()。

另请参阅 setCookiesFromUrl() 和QNetworkAccessManager::setCookieJar()。

[virtual] bool QNetworkCookieJar::deleteCookie(const QNetworkCookie &cookie)

从 cookie jar 中删除与cookie 具有相同标识符的 cookie。

如果 cookie 被删除，则返回true ，否则返回 false。

另请参阅 QNetworkCookie::hasSameIdentifier().

[virtual] bool QNetworkCookieJar::insertCookie(const QNetworkCookie &cookie)

将cookie 添加到此 cookie jar。

如果添加了cookie ，则返回true ，否则返回 false。

如果 cookie jar 中已经存在具有相同标识符的 cookie，它将被覆盖。

[protected] void QNetworkCookieJar::setAllCookies(const QList<QNetworkCookie> &cookieList)

将此 cookie jar 保存的 cookie 内部列表设置为cookieList 。该函数适合派生类通过重新实现setCookiesFromUrl() 来实现从永久存储中加载 cookie 或自己的 cookie 接受策略。

另请参阅 allCookies() 和setCookiesFromUrl()。

[virtual] bool QNetworkCookieJar::setCookiesFromUrl(const QList<QNetworkCookie> &cookieList, const QUrl &url)

将cookieList 列表中的 cookie 添加到此 cookie 罐中。在插入之前，cookie 会被规范化。

如果为url 设置了一个或多个 cookie，则返回true ，否则返回 false。

如果 cookie jar 中已经存在 cookie，它将被cookieList 中的 cookie 覆盖。

默认的QNetworkCookieJar 类只实现了非常基本的安全策略（确保 cookie 的域和路径与回复的相匹配）。要使用自己的算法增强安全策略，请重载 setCookiesFromUrl()。

此外，QNetworkCookieJar 没有规定 cookie 罐的最大容量。重新执行此函数可丢弃旧 cookie，为新 cookie 留出空间。

另请参阅 cookiesForUrl()、QNetworkAccessManager::setCookieJar() 和QNetworkCookie::normalize()。

[virtual] bool QNetworkCookieJar::updateCookie(const QNetworkCookie &cookie)

如果此 cookie 中存在与cookie 相同标识符的 cookie，则该 cookie 将被更新。此函数使用insertCookie() 。

如果cookie 已更新，则返回true ；如果罐中没有与cookie 的标识符匹配的 cookie，则返回 false。

另请参见 QNetworkCookie::hasSameIdentifier()。

[virtual protected] bool QNetworkCookieJar::validateCookie(const QNetworkCookie &cookie, const QUrl &url) const

如果cookie 的域和路径有效，则返回true ，否则返回 false。url 参数用于确定是否允许使用 cookie 中指定的域。