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 字符串中的 "域 "字段相对应。

请注意，此处的域可能以点开头，这不是有效的主机名。不过，这意味着此 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 启用了 "仅支持 Http "标志，则返回true 。

仅通过网络请求和回复（即 HTTP 协议）设置和检索 "HttpOnly "cookie。浏览器上运行的脚本无法访问它。

另请参见 isSecure().

bool QNetworkCookie::isSecure() const

如果在 cookie 字符串中指定了 "安全 "选项，则返回true ，否则返回 false。

安全 cookie 可能包含私人信息，因此不应通过未加密连接发送。

另请参阅 setSecure().

bool QNetworkCookie::isSessionCookie() const

如果该 cookie 是会话 cookie，则返回true 。会话 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 字符串的 "路径 "字段相对应。

另请参见 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()。