En esta página

QAbstractOAuth Class

La clase `QAbstractOAuth` es la base de todas las implementaciones de los métodos de autenticación OAuth. Más información...

Encabezado: #include <QAbstractOAuth>
CMake: find_package(Qt6 REQUIRED COMPONENTS NetworkAuth)
target_link_libraries(mytarget PRIVATE Qt6::NetworkAuth)
qmake: QT += networkauth
Heredado de: QObject
Heredado por:

QAbstractOAuth2 y QOAuth1

Tipos públicos

enum class ContentType { WwwFormUrlEncoded, Json }
enum class Error { NoError, NetworkError, ServerError, OAuthTokenNotFoundError, OAuthTokenSecretNotFoundError, …, ExpiredError }
enum class Stage { RequestingTemporaryCredentials, RequestingAuthorization, RequestingAccessToken, RefreshingAccessToken }
enum class Status { NotAuthenticated, TemporaryCredentialsReceived, Granted, RefreshingToken }

Propiedades

Funciones públicas

virtual ~QAbstractOAuth()
QUrl authorizationUrl() const
QString clientIdentifier() const
QAbstractOAuth::ContentType contentType() const
virtual QNetworkReply *deleteResource(const QUrl &url, const QVariantMap &parameters = QVariantMap()) = 0
QVariantMap extraTokens() const
virtual QNetworkReply *get(const QUrl &url, const QVariantMap &parameters = QVariantMap()) = 0
virtual QNetworkReply *head(const QUrl &url, const QVariantMap &parameters = QVariantMap()) = 0
QAbstractOAuth::ModifyParametersFunction modifyParametersFunction() const
QNetworkAccessManager *networkAccessManager() const
virtual QNetworkReply *post(const QUrl &url, const QVariantMap &parameters = QVariantMap()) = 0
virtual void prepareRequest(QNetworkRequest *request, const QByteArray &verb, const QByteArray &body = QByteArray()) = 0
virtual QNetworkReply *put(const QUrl &url, const QVariantMap &parameters = QVariantMap()) = 0
QAbstractOAuthReplyHandler *replyHandler() const
void setAuthorizationUrl(const QUrl &url)
void setClientIdentifier(const QString &clientIdentifier)
void setContentType(QAbstractOAuth::ContentType contentType)
void setModifyParametersFunction(const QAbstractOAuth::ModifyParametersFunction &modifyParametersFunction)
void setNetworkAccessManager(QNetworkAccessManager *networkAccessManager)
void setReplyHandler(QAbstractOAuthReplyHandler *handler)
void setToken(const QString &token)
QAbstractOAuth::Status status() const
QString token() const

Ranuras públicas

virtual void grant() = 0

Señales

void authorizationUrlChanged(const QUrl &url)
void authorizeWithBrowser(const QUrl &url)
void clientIdentifierChanged(const QString &clientIdentifier)
void contentTypeChanged(QAbstractOAuth::ContentType contentType)
void extraTokensChanged(const QVariantMap &tokens)
void granted()
void requestFailed(const QAbstractOAuth::Error error)
void statusChanged(QAbstractOAuth::Status status)
void tokenChanged(const QString &token)

Funciones protegidas

QString callback() const
virtual void resourceOwnerAuthorization(const QUrl &url, const QMultiMap<QString, QVariant> &parameters)
void setStatus(QAbstractOAuth::Status status)

Miembros estáticos protegidos

QByteArray generateRandomString(quint8 length)

Descripción detallada

La clase define la interfaz básica de las clases de autenticación OAuth. Al heredar de esta clase, se pueden crear métodos de autenticación personalizados para distintos servicios web.

También contiene algunas funciones para facilitar el proceso de implementación de diferentes flujos de autenticación.

Documentación sobre los tipos de miembros

enum class QAbstractOAuth::ContentType

Indica el tipo de contenido MIME (Content-Type) de los métodos POST en las llamadas autenticadas.

ConstanteValorDescripción
QAbstractOAuth::ContentType::WwwFormUrlEncoded0Utiliza el formato application/x-www-form-urlencoded.
QAbstractOAuth::ContentType::Json1Utiliza el formato application/json.

enum class QAbstractOAuth::Error

Indica el último error recibido.

ConstanteValorDescripción
QAbstractOAuth::Error::NoError0No se ha producido ningún error.
QAbstractOAuth::Error::NetworkError1No se ha podido conectar al servidor.
QAbstractOAuth::Error::ServerError2El servidor respondió a la solicitud con un error, o su respuesta no se recibió correctamente (por ejemplo, debido a una discrepancia de estado).
QAbstractOAuth::Error::OAuthTokenNotFoundError3La respuesta del servidor a una solicitud de token no proporcionó ningún identificador de token.
QAbstractOAuth::Error::OAuthTokenSecretNotFoundError4La respuesta del servidor a una solicitud de token no proporcionó ningún secreto de token.
QAbstractOAuth::Error::OAuthCallbackNotVerified5El servidor de autorización no ha verificado el URI de devolución de llamada facilitado en la solicitud. Esto suele ocurrir cuando la devolución de llamada facilitada no coincide con la proporcionada durante el registro del cliente.
QAbstractOAuth::Error::ClientError (since Qt 6.9)6Un error atribuible a la aplicación cliente (por ejemplo, falta de configuración o intento de realizar una solicitud en un estado en el que no está permitido). Actualmente utilizado por QOAuth2DeviceAuthorizationFlow.
QAbstractOAuth::Error::ExpiredError (since Qt 6.9)7Un token ha caducado. Actualmente lo utiliza QOAuth2DeviceAuthorizationFlow.

enum class QAbstractOAuth::Stage

Identifica una fase de autenticación. Se pasa a un ` modifyParametersFunction ` para que este pueda realizar diferentes modificaciones en los parámetros cada vez que se le invoque durante el proceso de autenticación.

ConstanteValorDescripción
QAbstractOAuth::Stage::RequestingTemporaryCredentials0Preparación de la solicitud de credenciales temporales.
QAbstractOAuth::Stage::RequestingAuthorization1Preparación de la URL de concesión de autorización.
QAbstractOAuth::Stage::RequestingAccessToken2Preparación de la solicitud de token.
QAbstractOAuth::Stage::RefreshingAccessToken3Preparación de la actualización del token de acceso.

enum class QAbstractOAuth::Status

Indica el estado actual de la autenticación.

ConstanteValorDescripción
QAbstractOAuth::Status::NotAuthenticated0No se ha obtenido ningún token.
QAbstractOAuth::Status::TemporaryCredentialsReceived1Se han recibido credenciales temporales; este estado se utiliza en algunos métodos de autenticación OAuth.
QAbstractOAuth::Status::Granted2Se han recibido credenciales de token y se permiten las llamadas autenticadas.
QAbstractOAuth::Status::RefreshingToken3Se han solicitado nuevas credenciales de token.

Documentación de propiedades

authorizationUrl : QUrl

Esta propiedad contiene la URL utilizada para solicitar la autorización del propietario del recurso, tal y como se describe en: El protocolo OAuth 1.0: Autorización del propietario del recurso

Funciones de acceso:

QUrl authorizationUrl() const
void setAuthorizationUrl(const QUrl &url)

Señal de notificación:

void authorizationUrlChanged(const QUrl &url)

clientIdentifier : QString

Esta propiedad contiene el identificador del cliente utilizado en el proceso de autenticación.

Funciones de acceso:

QString clientIdentifier() const
void setClientIdentifier(const QString &clientIdentifier)

Señal de notificador:

void clientIdentifierChanged(const QString &clientIdentifier)

Véase también setClientIdentifier().

contentType : QAbstractOAuth::ContentType

Esta propiedad contiene el tipo de contenido (Content-Type) que se debe utilizar al enviar los parámetros de autorización.

Esta propiedad controla cómo se formatean los parámetros cuando se envían con una solicitud POST. También se añade un encabezado adecuado.

Funciones de acceso:

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

Señal del notificador:

void contentTypeChanged(QAbstractOAuth::ContentType contentType)

[read-only] extraTokens : QVariantMap

Esta propiedad almacena los tokens adicionales recibidos del servidor.

Funciones de acceso:

QVariantMap extraTokens() const

Señal de notificador:

void extraTokensChanged(const QVariantMap &tokens)

[read-only] status : Status

Esta propiedad contiene el estado actual de autenticación.

Funciones de acceso:

QAbstractOAuth::Status status() const

Señal de notificación:

void statusChanged(QAbstractOAuth::Status status)

token : QString

Esta propiedad contiene el token utilizado para firmar las solicitudes autenticadas.

Funciones de acceso:

QString token() const
void setToken(const QString &token)

Señal de notificador:

void tokenChanged(const QString &token)

Véase también setToken().

Documentación de funciones de miembro

[virtual noexcept] QAbstractOAuth::~QAbstractOAuth()

Elimina el OAuth abstracto.

QUrl QAbstractOAuth::authorizationUrl() const

Devuelve la URL de la solicitud de autorización.

Nota: Funcióngetter para la propiedad authorizationUrl.

Véase también setAuthorizationUrl().

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

Esta señal se emite cuando el objeto « url » generado por resourceOwnerAuthorization() está listo para utilizarse en el navegador web y permitir que la aplicación actúe en nombre del usuario.

Véase también resourceOwnerAuthorization().

[protected] QString QAbstractOAuth::callback() const

Devuelve la cadena de callback actual correspondiente al gestor de respuestas actual. La cadena devuelta es la que se envía al servidor para especificar el URI de callback, o la palabra que identifica el método alternativo en dispositivos sin interfaz gráfica.

Véase también replyHandler() y setReplyHandler().

QString QAbstractOAuth::clientIdentifier() const

Devuelve el identificador de cliente actual utilizado en el proceso de autenticación.

Nota: Funcióngetter para la propiedad clientIdentifier.

Véase también setClientIdentifier().

QAbstractOAuth::ContentType QAbstractOAuth::contentType() const

Devuelve el tipo de contenido (Content-Type) actual utilizado en las llamadas autenticadas.

Nota: Funcióngetter para la propiedad contentType.

Véase también setContentType() y post().

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

Envía una solicitud DELETE autenticada y devuelve un nuevo objeto ` QNetworkReply`. Se utilizan los métodos ` url ` y ` parameters ` para crear la solicitud.

Véase también: Protocolo de transferencia de hipertexto – HTTP/1.1: DELETE

Nota: Esta función se puede invocar a través del sistema de metaobjetos y desde QML. Véase Q_INVOKABLE.

QVariantMap QAbstractOAuth::extraTokens() const

Devuelve los tokens adicionales recibidos del servidor durante la autenticación.

Nota: Funcióngetter para la propiedad extraTokens.

Véase también extraTokensChanged().

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

Genera una cadena aleatoria que puede utilizarse como estado o nonce. El parámetro « length » determina la longitud de la cadena generada.

Véase también: El protocolo OAuth 1.0: Nonce y marca de tiempo.

Nota: Esta función es segura para subprocesos.

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

Envía una solicitud GET autenticada y devuelve un nuevo objeto ` QNetworkReply`. Se utilizan ` url ` y ` parameters ` para crear la solicitud.

Véase también: Protocolo de transferencia de hipertexto – HTTP/1.1: GET

Nota: Esta función se puede invocar a través del sistema de metaobjetos y desde QML. Véase Q_INVOKABLE.

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

Sobrescribe esta función para implementar el flujo de autenticación correspondiente en las subclases. El código del cliente llama a esta función para iniciar el proceso de autenticación. Esto puede requerir la intervención del usuario: por ejemplo, solicitar su autorización a través de un navegador web. Cuando la autenticación se realiza con éxito, debe emitir ` granted()`; esto indica que las credenciales están listas para utilizarse en llamadas autenticadas.

[signal] void QAbstractOAuth::granted()

Esta señal se emite cuando el proceso de autorización finaliza con éxito.

Envía una solicitud HEAD autenticada y devuelve un nuevo objeto ` QNetworkReply`. Se utilizan los parámetros ` url ` y ` parameters ` para crear la solicitud.

Véase también: Protocolo de transferencia de hipertexto – HTTP/1.1: HEAD

Nota: Esta función se puede invocar a través del sistema de metaobjetos y desde QML. Véase Q_INVOKABLE.

QAbstractOAuth::ModifyParametersFunction QAbstractOAuth::modifyParametersFunction() const

Devuelve la función de modificación de parámetros actual.

Véase también setModifyParametersFunction() y Stage.

QNetworkAccessManager *QAbstractOAuth::networkAccessManager() const

Devuelve el gestor de acceso a la red actual que se utiliza para enviar las solicitudes al servidor durante los flujos de autenticación o para realizar llamadas de autenticación.

Véase también setNetworkAccessManager() y QNetworkAccessManager.

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

Envía una solicitud POST autenticada y devuelve un nuevo objeto ` QNetworkReply`. Se utilizan ` url ` y ` parameters ` para crear la solicitud.

Véase también: Protocolo de transferencia de hipertexto – HTTP/1.1: POST

Nota: Esta función se puede invocar a través del sistema de metaobjetos y desde QML. Véase Q_INVOKABLE.

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

Autoriza el request indicado añadiéndole el encabezado « body », necesario para las solicitudes autenticadas.

El verb debe ser un verbo HTTP válido y debe coincidir con el que se utilizará para enviar el request.

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

Envía una solicitud PUT autenticada y devuelve un nuevo ` QNetworkReply`. Se utilizan ` url ` y ` parameters ` para crear la solicitud.

Véase también: Protocolo de transferencia de hipertexto – HTTP/1.1: PUT

Nota: Esta función se puede invocar a través del sistema de metaobjetos y desde QML. Véase Q_INVOKABLE.

QAbstractOAuthReplyHandler *QAbstractOAuth::replyHandler() const

Devuelve el controlador de respuesta que se está utilizando actualmente.

Véase también setReplyHandler() y QAbstractOAuthReplyHandler.

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

Esta señal se emite para indicar que una solicitud enviada a un servidor ha fallado. El código de estado « error » proporcionado indica el motivo del fallo de la solicitud.

Véase también QAbstractOAuth2::error() y QAbstractOAuthReplyHandler::tokenRequestErrorOccurred().

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

Crea la URL de autorización del propietario del recurso que se utilizará en el navegador web: se utiliza url como URL base y la consulta se crea mediante parameters. Cuando la URL esté lista, se emitirá la señal authorizeWithBrowser() con la URL generada.

Véase también authorizeWithBrowser().

void QAbstractOAuth::setAuthorizationUrl(const QUrl &url)

Establece la URL de la solicitud de autorización en url. Esta dirección se utilizará para permitir que el usuario conceda a la aplicación la capacidad de realizar llamadas autenticadas en nombre del usuario.

Nota: Funciónde asignación para la propiedad authorizationUrl.

Véase también authorizationUrl().

void QAbstractOAuth::setClientIdentifier(const QString &clientIdentifier)

Establece el identificador del cliente actual en clientIdentifier.

Nota: Funciónde asignación para la propiedad clientIdentifier.

Véase también ` clientIdentifier()`.

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

Establece el tipo de contenido actual en « contentType ».

Nota: Funciónde asignación para la propiedad contentType.

Véase también contentType().

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

Establece la función de modificación de parámetros modifyParametersFunction. Esta función se utiliza para personalizar los parámetros enviados al servidor durante una fase de autorización específica. El número de llamadas a esta función depende del flujo utilizado durante la autenticación.

Véase también modifyParametersFunction() y Stage.

void QAbstractOAuth::setNetworkAccessManager(QNetworkAccessManager *networkAccessManager)

Configura el gestor de red en networkAccessManager. QAbstractOAuth no asume la titularidad de networkAccessManager. Si no se ha configurado ningún gestor de acceso a la red personalizado, se utiliza un gestor de acceso a la red interno. Este gestor de acceso a la red se utilizará para realizar la solicitud al servidor de autenticación y la solicitud autenticada al servicio web.

Véase también networkAccessManager() y QNetworkAccessManager.

void QAbstractOAuth::setReplyHandler(QAbstractOAuthReplyHandler *handler)

Establece el gestor de respuestas actual en handler.

Nota: No adquiere la propiedad de handler.

Véase también replyHandler().

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

Establece el estado actual en « status ». Este método está destinado a clases basadas en « QAbstractOAuth ».

Véase también status().

void QAbstractOAuth::setToken(const QString &token)

Establece el token utilizado para firmar las solicitudes autenticadas dirigidas a token.

Nota: Funciónde asignación para la propiedad token.

Véase también token().

QAbstractOAuth::Status QAbstractOAuth::status() const

Devuelve el estado actual de autenticación.

Nota: Funcióngetter para la propiedad status.

Véase también setStatus() y Status.

QString QAbstractOAuth::token() const

Devuelve el token utilizado para firmar las solicitudes autenticadas.

Nota: Funcióngetter para la propiedad token.

Véase también setToken().

© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.