返回顶部

class QAbstractOAuth2#

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

继承自： QOAuth2AuthorizationCodeFlow

摘要#

属性#

clientIdentifierSharedKeyᅟ
expirationᅟ
refreshTokenᅟ
scopeᅟ - 这个属性包含所需的范围，定义了客户端请求的权限
stateᅟ
userAgentᅟ

方法#

def __init__()
def clientIdentifierSharedKey()
def expirationAt()
定义 refreshToken()
定义 responseType()
定义 scope()
定义 setClientIdentifierSharedKey()
定义 setRefreshToken()
定义 setResponseType()
定义 setScope()
定义 setSslConfiguration()
定义 setState()
定义 setUserAgent()
定义 sslConfiguration()
定义 state()
定义 userAgent()

虚方法#

定义 createAuthenticatedUrl()
定义 post()
定义 put()

备注

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

详细说明#

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

有关 OAuth 2 工作原理的描述可参考： OAuth 2.0 授权框架

备注

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

属性 clientIdentifierSharedKeyᅟ: str#

此属性包含用于密码的客户端共享密钥，在服务器要求请求令牌进行身份验证时使用。

访问函数

clientIdentifierSharedKey()
setClientIdentifierSharedKey()
信号 clientIdentifierSharedKeyChanged()

属性 expirationᅟ: QDateTime#

此属性包含当前访问令牌的过期时间。

访问函数

expirationAt()
信号 expirationAtChanged()

属性 refreshTokenᅟ: str#

访问函数

refreshToken()
setRefreshToken()
信号 refreshTokenChanged()

属性 scopeᅟ: str#

该属性持有指定的作用域，该作用域定义了客户端请求的权限。

访问函数

scope()
setScope()
信号 scopeChanged()

属性 state: str#

该属性持有在认证过程中发送到服务器的字符串。状态用于当收到回调时识别和验证请求。

访问函数

state()
setState()
信号 stateChanged()

属性 userAgent: str#

该属性持有用于创建网络请求的 User-Agent 头部。

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

访问函数

userAgent()
setUserAgent()
信号 userAgentChanged()

__init__([parent=None])#

参数:: parent – QObject

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

__init__(manager[, parent=None])

参数:

manager – QNetworkAccessManager
parent – QObject

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

authorizationCallbackReceived(data)#

参数:: data – 键为 QString 类型，值为 QVariant 类型的字典。

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

clientIdentifierSharedKey()#

返回类型:: str

另请参阅

setClientIdentifierSharedKey()

属性 clientIdentifierSharedKey 的获取器。

clientIdentifierSharedKeyChanged(clientIdentifierSharedKey)#

参数:: clientIdentifierSharedKey – 字符串

属性 clientIdentifierSharedKey 的通知信号。

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

参数:

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

返回类型:

QUrl

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

error(error, errorDescription, uri)#

参数:

error – 字符串
errorDescription – 字符串
uri – QUrl

当服务器以 RFC 6749 中定义的错误响应方式响应授权请求时，会发出此信号 RFC 6749 错误响应。

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

另请参阅

requestFailed()

expirationAt()#

返回类型:: QDateTime

属性 expiration 的获取器。

expirationAtChanged(expiration)#

参数:: expiration – QDateTime

属性 expiration 的通知信号。

post(url, multiPart)#

参数:

url – QUrl
multiPart – QHttpMultiPart

返回类型:

QNetworkReply

这是一个重载函数。

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

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

另请参阅

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

post(url, data)

参数:

url – QUrl
data – QByteArray

返回类型:

QNetworkReply

这是一个重载函数。

发送带认证的 POST 请求并返回一个新的 QNetworkReply。使用 url 和 data 来创建请求。

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

另请参阅

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

put(url, multiPart)#

参数:

url – QUrl
multiPart – QHttpMultiPart

返回类型:

QNetworkReply

这是一个重载函数。

发送带认证的 PUT 请求并返回一个新的 QNetworkReply。使用 url 和 multiPart 来创建请求。

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

另请参阅

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

put(url, data)

参数:

url – QUrl
data – QByteArray

返回类型:

QNetworkReply

这是一个重载函数。

发送带认证的 PUT 请求并返回一个新的 QNetworkReply。使用 url 和 data 来创建请求。

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

另请参阅

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

refreshToken()#

返回类型:: str

获取当前的刷新令牌。

刷新令牌通常比访问令牌有更长的有效期，因此将其保存以供以后使用是有意义的。

返回当前的刷新令牌或空字符串（如果不可用）。

另请参阅

setRefreshToken()

属性 refreshTokenᅟ 的获取器。

refreshTokenChanged(refreshToken)#

参数:: refreshToken – str

属性 refreshTokenᅟ 的通知信号。

responseType()#

返回类型:: str

返回使用的 response_type。

responseTypeChanged(responseType)#

参数:: responseType – str

scope()#

返回类型:: str

另请参阅

setScope()

属性 scopeᅟ 的获取器。

scopeChanged(scope)#

参数:: scope – 字符串

属性 scope属性 的通知信号。

setClientIdentifierSharedKey(clientIdentifierSharedKey)#

参数:: clientIdentifierSharedKey – 字符串

另请参阅

clientIdentifierSharedKey()

clientIdentifierSharedKey属性 的设置器。

setRefreshToken(refreshToken)#

参数:: refreshToken – str

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

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

另请参阅

refreshToken()

refreshToken属性 的设置器。

setResponseType(responseType)#

参数:: responseType – str

setScope(scope)#

参数:: scope – 字符串

另请参阅

scope()

scope属性 的设置器。

setSslConfiguration(configuration)#

参数:: configuration – QSslConfiguration

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

另请参阅

sslConfiguration() sslConfigurationChanged()

setState(state)#

参数:: state – 字符串

另请参阅

state()

state属性 的设置器。

setUserAgent(userAgent)#

参数:: userAgent – str

另请参阅

userAgent()

属性 userAgent⁈ 的设置器。

sslConfiguration()#

返回类型:: QSslConfiguration

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

另请参阅

setSslConfiguration() sslConfigurationChanged()

sslConfigurationChanged(configuration)#

参数:: configuration – QSslConfiguration

当 TLS 配置改变时发出信号。参数 configuration 包含新的 TLS 配置。

另请参阅

sslConfiguration() setSslConfiguration()

state()#

返回类型:: str

另请参阅

setState()

属性 state⁈ 的获取器。

stateChanged(state)#

参数:: state – 字符串

属性 state⁈ 的通知信号。

userAgent()#

返回类型:: str

另请参阅

setUserAgent()

属性 userAgent⁈ 的获取器。

userAgentChanged(userAgent)#

参数:: userAgent – str

属性 userAgent⁈ 的通知信号。