PySide6.QtNetworkAuth.QAbstractOAuth2¶

class QAbstractOAuth2¶

QAbstractOAuth2 类是所有 OAuth 2 认证方法实现的基础。更多…

继承自： QOAuth2AuthorizationCodeFlow

概要¶

注意

本文档可能包含从C++自动翻译到Python的代码片段。我们始终欢迎对代码片段翻译的贡献。如果您发现翻译问题，您也可以通过在我们的https:/bugreports.qt.io/projects/PYSIDE上创建工单来告知我们。

详细描述¶

该类定义了OAuth 2认证类的基本接口。通过继承该类，您可以为不同的网络服务创建使用OAuth 2标准的自定义认证方法。

关于OAuth 2如何工作的描述可以在以下链接中找到：The OAuth 2.0 Authorization Framework

注意

当使用from __feature__ import true_property时，属性可以直接使用，否则通过访问器函数使用。

property clientIdentifierSharedKeyᅟ: str¶

此属性保存客户端共享密钥，如果服务器需要身份验证来请求令牌，则将其用作密码。

Access functions:

clientIdentifierSharedKey()
setClientIdentifierSharedKey()
信号 clientIdentifierSharedKeyChanged()

property expirationᅟ: QDateTime¶

此属性保存当前访问令牌的过期时间。

Access functions:

expirationAt()
信号 expirationAtChanged()

property refreshTokenᅟ: str¶

Access functions:

refreshToken()
setRefreshToken()
信号 refreshTokenChanged()

property scopeᅟ: str¶

此属性保存此属性保存所需的范围，该范围定义了客户端请求的权限。

范围值更新为授权服务器授予的范围值。如果响应中的范围为空，则请求的范围被视为已授予且不会更改。

Access functions:

scope()
setScope()
信号 scopeChanged()

property stateᅟ: str¶

此属性保存了在身份验证期间发送到服务器的字符串。状态用于在收到回调时识别和验证请求。

Access functions:

state()
setState()
信号 stateChanged()

property userAgentᅟ: str¶

此属性保存用于创建网络请求的User-Agent标头。

默认值为“QtOAuth/1.0 (+https://www.qt.io)”。

Access functions:

userAgent()
setUserAgent()
信号 userAgentChanged()

__init__([parent=None])¶

Parameters:: 父对象 – QObject

使用parent作为父对象构造一个QAbstractOAuth2对象。

__init__(manager[, parent=None])

Parameters:

manager – QNetworkAccessManager
parent – QObject

使用parent作为父对象构造一个QAbstractOAuth2对象，并将manager设置为网络访问管理器。

authorizationCallbackReceived(data)¶

Parameters:: data – 字典，键类型为 .QString，值类型为 QVariant。

当回复服务器从服务器接收到授权回调时发出的信号：data 包含从服务器接收到的值。

clientIdentifierSharedKey()¶

Return type:: 字符串

另请参阅

setClientIdentifierSharedKey()

属性 clientIdentifierSharedKeyᅟ 的获取器。

clientIdentifierSharedKeyChanged(clientIdentifierSharedKey)¶

Parameters:: clientIdentifierSharedKey – str

属性 clientIdentifierSharedKeyᅟ 的通知信号。

createAuthenticatedUrl(url[, parameters=QVariantMap()])¶

Parameters:

url – QUrl
parameters – 字典，键类型为 .QString，值类型为 QVariant。

Return type:

QUrl

返回的URL基于url，将其与给定的parameters和访问令牌结合。

error(error, errorDescription, uri)¶

Parameters:

error – str
errorDescription – str
uri – QUrl

当服务器响应授权请求时发出信号，错误定义在RFC 6749错误响应中。

error 是错误名称；errorDescription 描述错误，uri 是一个可选的URI，包含有关错误的更多信息。

另请参阅

requestFailed()

expirationAt()¶

Return type:: QDateTime

属性 expirationᅟ 的获取器。

expirationAtChanged(expiration)¶

Parameters:: 过期时间 – QDateTime

属性 expirationᅟ 的通知信号。

post(url, multiPart)¶

Parameters:

url – QUrl
multiPart – QHttpMultiPart

Return type:

QNetworkReply

注意

此函数已弃用。

请直接使用QtNetwork类，参见HTTP方法替代方案。

这是一个重载函数。

发送一个经过身份验证的POST请求并返回一个新的QNetworkReply。url和multiPart用于创建请求。

{超文本传输协议 – HTTP/1.1: POST}

另请参阅

post() https://tools.ietf.org/html/rfc2616#section-9.6

post(url, data)

Parameters:

url – QUrl
data – QByteArray

Return type:

QNetworkReply

注意

此函数已弃用。

请直接使用QtNetwork类，参见HTTP方法替代方案。

这是一个重载函数。

发送一个经过身份验证的POST请求并返回一个新的QNetworkReply。url和data用于创建请求。

{超文本传输协议 – HTTP/1.1: POST}

另请参阅

post() https://tools.ietf.org/html/rfc2616#section-9.6

put(url, multiPart)¶

Parameters:

url – QUrl
multiPart – QHttpMultiPart

Return type:

QNetworkReply

注意

此函数已弃用。

请直接使用QtNetwork类，参见HTTP方法替代方案。

这是一个重载函数。

发送一个经过身份验证的PUT请求并返回一个新的QNetworkReply。url 和 multiPart 用于创建请求。

{超文本传输协议 – HTTP/1.1: PUT}

另请参阅

put() https://tools.ietf.org/html/rfc2616#section-9.6

put(url, data)

Parameters:

url – QUrl
data – QByteArray

Return type:

QNetworkReply

注意

此函数已弃用。

请直接使用QtNetwork类，参见HTTP方法替代方案。

这是一个重载函数。

发送一个经过身份验证的PUT请求并返回一个新的QNetworkReply。url和data用于创建请求。

{超文本传输协议 – HTTP/1.1: PUT}

另请参阅

put() https://tools.ietf.org/html/rfc2616#section-9.6

refreshToken()¶

Return type:: 字符串

获取当前的刷新令牌。

刷新令牌通常比访问令牌具有更长的生命周期，因此保存它们以供以后使用是有意义的。

返回当前的刷新令牌或空字符串，如果没有可用的刷新令牌。

另请参阅

setRefreshToken()

属性 refreshTokenᅟ 的获取器。

refreshTokenChanged(refreshToken)¶

Parameters:: refreshToken – str

属性 refreshTokenᅟ 的通知信号。

responseType()¶

Return type:: 字符串

返回使用的response_type。

responseTypeChanged(responseType)¶

Parameters:: responseType – str

scope()¶

Return type:: 字符串

另请参阅

setScope()

属性 scopeᅟ 的获取器。

scopeChanged(scope)¶

Parameters:: scope – str

属性 scopeᅟ 的通知信号。

setClientIdentifierSharedKey(clientIdentifierSharedKey)¶

Parameters:: clientIdentifierSharedKey – str

另请参阅

clientIdentifierSharedKey()

属性 clientIdentifierSharedKeyᅟ 的设置器。

setRefreshToken(refreshToken)¶

Parameters:: refreshToken – str

设置要使用的新刷新令牌 refreshToken。

可以使用自定义刷新令牌通过此方法刷新访问令牌，然后可以通过refreshAccessToken()刷新访问令牌。

另请参阅

refreshToken()

属性 refreshTokenᅟ 的设置器。

setResponseType(responseType)¶

Parameters:: responseType – str

setScope(scope)¶

Parameters:: scope – str

另请参阅

scope()

属性 scopeᅟ 的设置器。

setSslConfiguration(configuration)¶

Parameters:: 配置 – QSslConfiguration

设置TLS configuration，用于在客户端和授权服务器之间建立双向TLS连接时使用。

另请参阅

sslConfiguration() sslConfigurationChanged()

setState(state)¶

Parameters:: state – str

另请参阅

state()

属性 stateᅟ 的设置器。

setUserAgent(userAgent)¶

Parameters:: userAgent – str

另请参阅

userAgent()

属性 userAgentᅟ 的设置器。

sslConfiguration()¶

Return type:: QSslConfiguration

返回在客户端和授权服务器之间建立相互TLS连接时要使用的TLS配置。

另请参阅

setSslConfiguration() sslConfigurationChanged()

sslConfigurationChanged(configuration)¶

Parameters:: 配置 – QSslConfiguration

当TLS配置发生变化时，信号被发出。configuration参数包含新的TLS配置。

另请参阅

sslConfiguration() setSslConfiguration()

state()¶

Return type:: 字符串

另请参阅

setState()

属性 stateᅟ 的获取器。

stateChanged(state)¶

Parameters:: state – str

属性 stateᅟ 的通知信号。

userAgent()¶

Return type:: 字符串

另请参阅

setUserAgent()

属性 userAgentᅟ 的获取器。

userAgentChanged(userAgent)¶

Parameters:: userAgent – str

属性 userAgentᅟ 的通知信号。

PySide6.QtNetworkAuth.QAbstractOAuth2¶

概要¶

属性¶

方法¶

虚拟方法¶

信号¶

详细描述¶