QNetworkCookie Class

成员函数文档

[explicit] QNetworkCookie::QNetworkCookie(const QByteArray &name = QByteArray(), const QByteArray &value = QByteArray())

创建一个新的 QNetworkCookie 对象，将 Cookie 名称初始化为name ，将其值初始化为value 。

Cookie 只有在具有名称时才有效。然而，其值对应用程序而言是不透明的，而值为空对远程服务器而言可能具有特殊含义。

QNetworkCookie::QNetworkCookie(const QNetworkCookie &other)

通过复制other 中的内容，创建一个新的QNetworkCookie对象。

[noexcept] QNetworkCookie::~QNetworkCookie()

销毁此QNetworkCookie 对象。

QString QNetworkCookie::domain() const

返回此 Cookie 关联的域名。这对应于 Cookie 字符串中的“domain”字段。

请注意，此处的域名可能以点号开头，这并非有效的主机名。但这意味着该 Cookie 匹配所有以该域名结尾的主机名。

另请参阅 setDomain()。

QDateTime QNetworkCookie::expirationDate() const

返回此 Cookie 的过期日期。如果此 Cookie 是一个会话 Cookie，则返回的QDateTime 将无效。如果日期已过，则表示此 Cookie 已过期，不应再次将其发送回远程服务器。

过期日期对应于 Cookie 字符串中“expires”条目的参数。

另请参阅 isSessionCookie() 和setExpirationDate()。

bool QNetworkCookie::hasSameIdentifier(const QNetworkCookie &other) const

如果该 Cookie 的标识符元组与other 相同，则返回true 。标识符元组由名称、域名和路径组成。

另请参阅 operator==()。

bool QNetworkCookie::isHttpOnly() const

如果此 Cookie 启用了“HttpOnly”标志，则返回true 。

具有“HttpOnly”属性的 Cookie 仅通过网络请求和响应（即 HTTP 协议）进行设置和读取；无法通过在浏览器上运行的脚本访问。

另请参阅 isSecure()。

bool QNetworkCookie::isSecure() const

如果 Cookie 字符串中指定了“secure”选项，则返回true ；否则返回false。

安全 Cookie 可能包含私人信息，不应通过未加密的连接重新发送。

另请参阅 setSecure()。

bool QNetworkCookie::isSessionCookie() const

如果该 Cookie 是会话 Cookie，则返回true 。会话 Cookie 是指没有过期日期的 Cookie，这意味着当应用程序的会话结束时（通常是在应用程序退出时），该 Cookie 应被删除。

另请参阅 expirationDate() 和setExpirationDate()。

QByteArray QNetworkCookie::name() const

返回此 Cookie 的名称。Cookie 的唯一必填字段是其名称，若缺少该字段，则该 Cookie 不被视为有效。

另请参阅 setName() 和value()。

void QNetworkCookie::normalize(const QUrl &url)

如果 Cookie 的路径和域名之前为空，该函数会将其规范化。url 参数用于确定正确的域名和路径。

[static] QList<QNetworkCookie> QNetworkCookie::parseCookies(QByteArrayView cookieString)

解析从服务器响应的“Set-Cookie:”头中接收到的 Cookie 字符串cookieString 。如果解析出错，该函数将返回一个空列表。

由于 HTTP 头可以同时设置多个 Cookie，因此该函数会返回一个QList<QNetworkCookie>，其中每个已解析的 Cookie 对应一个元素。

另请参阅 toRawForm()。

QString QNetworkCookie::path() const

返回与该 Cookie 关联的路径。这对应于 Cookie 字符串中的“path”字段。

另请参阅 setPath()。

[since 6.1] QNetworkCookie::SameSite QNetworkCookie::sameSitePolicy() const

如果 cookie 字符串中指定了“SameSite ”选项，则返回该选项；如果不存在，则返回SameSite::Default 。

该函数在 Qt 6.1 中引入。

另请参阅 setSameSitePolicy()。

void QNetworkCookie::setDomain(const QString &domain)

将此 Cookie 关联的域名设置为domain 。

另请参阅 domain()。

void QNetworkCookie::setExpirationDate(const QDateTime &date)

将此 Cookie 的过期日期设置为date 。如果为该 Cookie 设置无效的过期日期，则表示它是一个会话 Cookie。

另请参阅 isSessionCookie() 和expirationDate()。

void QNetworkCookie::setHttpOnly(bool enable)

将此 Cookie 的“HttpOnly”标志设置为enable 。

另请参阅 isHttpOnly()。

void QNetworkCookie::setName(const QByteArray &cookieName)

将此 Cookie 的名称设置为cookieName 。请注意，若将 Cookie 名称设置为空的QByteArray ，该 Cookie 将失效。

另请参阅 name() 和value()。

void QNetworkCookie::setPath(const QString &path)

将此 Cookie 关联的路径设置为path 。

另请参阅 path()。

[since 6.1] void QNetworkCookie::setSameSitePolicy(QNetworkCookie::SameSite sameSite)

将此 Cookie 的“SameSite ”选项设置为“sameSite ”。

该函数于 Qt 6.1 中引入。

另请参阅 sameSitePolicy()。

void QNetworkCookie::setSecure(bool enable)

将此 Cookie 的安全标志设置为enable 。

安全 Cookie 可能包含私人信息，不应通过未加密的连接重新发送。

另请参阅 isSecure()。

void QNetworkCookie::setValue(const QByteArray &value)

将此 Cookie 的值设置为value 。

另请参阅 value() 和name()。

[noexcept] void QNetworkCookie::swap(QNetworkCookie &other)

将此 Cookie 与other 互换。此操作速度非常快，且绝不会失败。

QByteArray QNetworkCookie::toRawForm(QNetworkCookie::RawForm form = Full) const

返回此QNetworkCookie 的原始格式。该函数返回的QByteArray 适用于HTTP头，无论是服务器响应中的Set-Cookie头，还是客户端请求中的Cookie头。您可以使用form 从两种格式中选择一种。

另请参阅 parseCookies()。

QByteArray QNetworkCookie::value() const

返回该 Cookie 的值，该值由 Cookie 字符串指定。请注意，即使 Cookie 的值为空，它仍然有效。

Cookie 的名称-值对对应用程序而言是“不透明”的：也就是说，其值本身没有任何特定含义。

另请参阅 setValue() 和name()。

bool QNetworkCookie::operator!=(const QNetworkCookie &other) const

如果该 Cookie 不等于other ，则返回true 。

另请参阅 operator==()。

QNetworkCookie &QNetworkCookie::operator=(const QNetworkCookie &other)

将QNetworkCookie 对象other 的内容复制到此对象中。

bool QNetworkCookie::operator==(const QNetworkCookie &other) const

如果该 Cookie 与other 完全相等，则返回true 。只有当 Cookie 的所有字段都完全相同时，该函数才会返回true 。

但在某些情况下，两个同名的 Cookie 可能会被视为相等。

另请参阅 operator!=() 和hasSameIdentifier()。