QAbstractOAuth Class

メンバ関数のドキュメント

[virtual noexcept] QAbstractOAuth::~QAbstractOAuth()

抽象的な OAuth を破棄します。

QUrl QAbstractOAuth::authorizationUrl() const

認証リクエストのURLを返します。

関連項目： setAuthorizationUrl()。

[signal] void QAbstractOAuth::authorizeWithBrowser(const QUrl &url)

このシグナルは、resourceOwnerAuthorization() によって生成されたurl が、Webブラウザで利用可能になり、アプリケーションがユーザーになりすますことができるようになったときに発信されます。

resourceOwnerAuthorization()も参照してください 。

[protected] QString QAbstractOAuth::callback() const

現在の返信ハンドラに対応する現在のコールバック文字列を返します。返される文字列は、コールバック URI を指定するためにサーバーに送信される文字列、あるいはヘッドレスデバイスにおける代替メソッドを識別する単語です。

replyHandler() およびsetReplyHandler()も参照してください 。

QString QAbstractOAuth::clientIdentifier() const

認証プロセスで使用されている現在のクライアント識別子を返します。

関連項目： setClientIdentifier()。

QAbstractOAuth::ContentType QAbstractOAuth::contentType() const

認証済み呼び出しで使用されている現在の Content-Type を返します。

関連項目： setContentType() およびpost()。

[pure virtual invokable] QNetworkReply *QAbstractOAuth::deleteResource(const QUrl &url, const QVariantMap &parameters = QVariantMap())

認証済みのDELETEリクエストを送信し、新しいQNetworkReply を返します。url およびparameters は、リクエストの作成に使用されます。

関連項目:ハイパーテキスト転送プロトコル – HTTP/1.1: DELETE

QVariantMap QAbstractOAuth::extraTokens() const

認証中にサーバーから受け取った追加のトークンを返します。

関連項目： extraTokensChanged()。

[static protected] QByteArray QAbstractOAuth::generateRandomString(quint8 length)

状態やノンスとして使用できるランダムな文字列を生成します。パラメータlength は、生成される文字列の長さを指定します。

関連項目:OAuth 1.0 プロトコル: ノンスとタイムスタンプ。

注： この関数はスレッドセーフです。

[pure virtual invokable] QNetworkReply *QAbstractOAuth::get(const QUrl &url, const QVariantMap &parameters = QVariantMap())

認証済みのGETリクエストを送信し、新しいQNetworkReply を返します。url およびparameters は、リクエストの作成に使用されます。

関連項目:ハイパーテキスト転送プロトコル – HTTP/1.1: GET

[pure virtual slot] void QAbstractOAuth::grant()

この関数をオーバーライドして、サブクラスで対応する認証フローを実装してください。クライアントコードはこの関数を呼び出して、認証ワークフローを開始します。この際、ユーザーの操作が必要になる場合があります。例えば、Webブラウザを介してユーザーに認証を依頼するなどです。認証に成功した場合は、granted() を発行する必要があります。これにより、認証済み呼び出しで認証情報を使用できる状態になったことが通知されます。

[signal] void QAbstractOAuth::granted()

このシグナルは、認証フローが正常に完了した際に送信されます。

[pure virtual invokable] QNetworkReply *QAbstractOAuth::head(const QUrl &url, const QVariantMap &parameters = QVariantMap())

認証済みのHEADリクエストを送信し、新しいQNetworkReply を返します。url およびparameters は、リクエストの作成に使用されます。

関連項目:ハイパーテキスト転送プロトコル – HTTP/1.1: HEAD

QAbstractOAuth::ModifyParametersFunction QAbstractOAuth::modifyParametersFunction() const

現在のパラメータ変更関数を返します。

setModifyParametersFunction() およびStageも参照してください 。

QNetworkAccessManager *QAbstractOAuth::networkAccessManager() const

認証フロー中にサーバーへリクエストを送信したり、認証呼び出しを行ったりするために使用される、現在のネットワークアクセスマネージャーを返します。

setNetworkAccessManager() およびQNetworkAccessManagerも参照してください 。

[pure virtual invokable] QNetworkReply *QAbstractOAuth::post(const QUrl &url, const QVariantMap &parameters = QVariantMap())

認証済みのPOSTリクエストを送信し、新しいQNetworkReply を返します。url およびparameters は、リクエストを作成するために使用されます。

関連項目:ハイパーテキスト転送プロトコル – HTTP/1.1: POST

[pure virtual] void QAbstractOAuth::prepareRequest(QNetworkRequest *request, const QByteArray &verb, const QByteArray &body = QByteArray())

指定されたrequest に対し、認証済みリクエストに必要なヘッダーとbody を追加して認証を行います。

verb は有効なHTTP動詞である必要があり、request の送信に使用される動詞と同じでなければなりません。

[pure virtual invokable] QNetworkReply *QAbstractOAuth::put(const QUrl &url, const QVariantMap &parameters = QVariantMap())

認証済みのPUTリクエストを送信し、新しいQNetworkReply を返します。url およびparameters は、リクエストを作成するために使用されます。

関連項目:ハイパーテキスト転送プロトコル – HTTP/1.1: PUT

QAbstractOAuthReplyHandler *QAbstractOAuth::replyHandler() const

現在使用中のレスポンスハンドラを返します。

setReplyHandler() およびQAbstractOAuthReplyHandlerも参照してください 。

[signal] void QAbstractOAuth::requestFailed(const QAbstractOAuth::Error error)

このシグナルは、サーバーへのリクエストが失敗したことを示すために発信されます。渡されるerror は、リクエストがどのように失敗したかを示します。

QAbstractOAuth2::error() およびQAbstractOAuthReplyHandler::tokenRequestErrorOccurred()も参照してください 。

[virtual protected] void QAbstractOAuth::resourceOwnerAuthorization(const QUrl &url, const QMultiMap<QString, QVariant> &parameters)

Webブラウザで使用するリソース所有者認証URLを生成します。ベースURLとして `url ` を使用し、クエリは `parameters` を用いて作成されます。URLの準備が整うと、生成されたURLを含む `authorizeWithBrowser()` シグナルが発信されます。

authorizeWithBrowser()も参照してください 。

void QAbstractOAuth::setAuthorizationUrl(const QUrl &url)

認証リクエストのURLをurl に設定します。このアドレスは、ユーザーがアプリケーションに対し、ユーザーに代わって認証済み呼び出しを行う権限を付与するために使用されます。

関連項目 ：authorizationUrl()

void QAbstractOAuth::setClientIdentifier(const QString &clientIdentifier)

現在のクライアント識別子を `clientIdentifier` に設定します。

clientIdentifier()も参照してください 。

void QAbstractOAuth::setContentType(QAbstractOAuth::ContentType contentType)

現在の Content-Type をcontentType に設定します。

contentType()も参照してください 。

void QAbstractOAuth::setModifyParametersFunction(const QAbstractOAuth::ModifyParametersFunction &modifyParametersFunction)

パラメータ変更関数 `modifyParametersFunction` を設定します。この関数は、指定された認証段階においてサーバーへ送信されるパラメータをカスタマイズするために使用されます。この関数の呼び出し回数は、認証時に使用されるフローによって異なります。

modifyParametersFunction() およびStageも参照してください 。

void QAbstractOAuth::setNetworkAccessManager(QNetworkAccessManager *networkAccessManager)

ネットワークマネージャーをnetworkAccessManager に設定します。QAbstractOAuth はnetworkAccessManager の所有権を取得しません。カスタムネットワークアクセスマネージャーが設定されていない場合は、内部のネットワークアクセスマネージャーが使用されます。このネットワークアクセスマネージャーは、認証サーバーへのリクエストおよび Web サービスへの認証済みリクエストの送信に使用されます。

networkAccessManager() およびQNetworkAccessManagerも参照してください 。

void QAbstractOAuth::setReplyHandler(QAbstractOAuthReplyHandler *handler)

現在の返信ハンドラをhandler に設定します。

replyHandler()も参照してください 。

[protected] void QAbstractOAuth::setStatus(QAbstractOAuth::Status status)

現在のステータスを「status 」に設定します。このメソッドは、QAbstractOAuth を基にしたクラスで利用するためのものです。

status()も参照してください 。

void QAbstractOAuth::setToken(const QString &token)

token への認証済みリクエストの署名に使用されるトークンを設定します。

token()も参照してください 。

QAbstractOAuth::Status QAbstractOAuth::status() const

現在の認証ステータスを返します。

関連項目： setStatus() およびStatus 。

QString QAbstractOAuth::token() const

認証済みリクエストの署名に使用されるトークンを返します。

関連項目： setToken()。