blob: 37b282e7dc4e54db525c0fb66e11ff6c5105bfc6 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
// Copyright (C) 2017 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only
#include "qabstractoauthreplyhandler.h"
#include "qabstractoauthreplyhandler_p.h"
QT_BEGIN_NAMESPACE
Q_LOGGING_CATEGORY(lcReplyHandler, "qt.networkauth.replyhandler")
/*!
\class QAbstractOAuthReplyHandler
\inmodule QtNetworkAuth
\ingroup oauth
\brief Handles replies to OAuth authentication requests.
\since 5.8
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.
*/
/*!
\fn QString QAbstractOAuthReplyHandler::callback() const
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 \b 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.
*/
/*!
\fn void QAbstractOAuthReplyHandler::networkReplyFinished(QNetworkReply *reply)
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 \a reply. \a reply will be automatically
deleted using deleteLater(), it thus must not be stored beyond the
scope of this function.
*/
/*!
\fn void QAbstractOAuthReplyHandler::callbackReceived(const QVariantMap &values)
This signal is emitted when the reply from the server is
received, with \a values containing the token credentials
and any additional information the server may have returned.
When this signal is emitted, the authorization process
is complete.
*/
/*!
\fn void QAbstractOAuthReplyHandler::tokensReceived(const QVariantMap &tokens)
This signal is emitted when new \a tokens are received from the
server.
*/
/*!
\fn void QAbstractOAuthReplyHandler::tokenRequestErrorOccurred(QAbstractOAuth::Error error,
const QString& errorString)
This signal is emitted when a token request or refresh \a error has
occurred. The \a errorString may provide further details on the error.
\sa QAbstractOAuth::requestFailed()
\since 6.6
*/
/*!
\fn void QAbstractOAuthReplyHandler::replyDataReceived(const QByteArray &data)
This signal is emitted when an HTTP request finishes and the
data is available. \a data contains the response before parsing.
*/
/*!
\fn void QAbstractOAuthReplyHandler::callbackDataReceived(const QByteArray &data)
This signal is emitted when a callback request is received:
\a data contains the information before parsing.
*/
/*!
Constructs a reply handler as a child of \a parent.
*/
QAbstractOAuthReplyHandler::QAbstractOAuthReplyHandler(QObject *parent)
: QObject(parent)
{}
/*!
Destroys the reply handler.
*/
QAbstractOAuthReplyHandler::~QAbstractOAuthReplyHandler()
{}
/*! \internal */
QAbstractOAuthReplyHandler::QAbstractOAuthReplyHandler(QObjectPrivate &d, QObject *parent)
: QObject(d, parent)
{}
QT_END_NAMESPACE
|