PySide6.QtNetworkAuth.QAbstractOAuthReplyHandler

class QAbstractOAuthReplyHandler

Handles replies to OAuth authentication requests. More…

Inherited by: QOAuthOobReplyHandler, QOAuthUriSchemeReplyHandler, QOAuthHttpServerReplyHandler

Synopsis

Methods

• def __init__()

Virtual methods

• def callback()

• def networkReplyFinished()

Signals

• def callbackDataReceived()

• def callbackReceived()

• def replyDataReceived()

• def tokenRequestErrorOccurred()

• def tokensReceived()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

The QAbstractOAuthReplyHandler class handles the answers to all OAuth authentication requests. This class is designed as a base whose subclasses implement custom behavior in the callback() and networkReplyFinished() methods.

__init__([parent=None])

Parameters:

parent – QObject

Constructs a reply handler as a child of parent.

abstract callback()

Return type:

str

Returns an absolute URI that the server will redirect the resource owner back to when the Resource Owner Authorization step is completed. If the client is unable to receive callbacks or a callback URI has been established via other means, the parameter value must be set to “oob” (all lower-case), to indicate an out-of-band configuration.

Derived classes should implement this function to provide the expected callback type.

callbackDataReceived(data)

Parameters:

data – QByteArray

This signal is emitted when a callback request is received: data contains the information before parsing.

callbackReceived(values)

Parameters:

values – Dictionary with keys of type .QString and values of type QVariant.

This signal is emitted when the reply from the server is received, with values containing the token credentials and any additional information the server may have returned. When this signal is emitted, the authorization process is complete.

abstract networkReplyFinished(reply)

Parameters:

reply – QNetworkReply

After the server determines whether the request is valid this function will be called. Reimplement it to get the data received from the server wrapped in reply. reply will be automatically deleted using deleteLater(), it thus must not be stored beyond the scope of this function.

replyDataReceived(data)

Parameters:

data – QByteArray

This signal is emitted when an HTTP request finishes and the data is available. data contains the response before parsing.

tokenRequestErrorOccurred(error, errorString)

Parameters:

• error – Error

• errorString – str

This signal is emitted when a token request or refresh error has occurred. The errorString may provide further details on the error.

See also

requestFailed()

tokensReceived(tokens)

Parameters:

tokens – Dictionary with keys of type .QString and values of type QVariant.

This signal is emitted when new tokens are received from the server.