QGIS API Documentation 3.41.0-Master (cea29feecf2)
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
QgsAuthorizationSettings Class Reference

Utility class that contains authorization information. More...

#include <qgsauthorizationsettings.h>

Public Member Functions

 QgsAuthorizationSettings (const QString &userName=QString(), const QString &password=QString(), const QgsHttpHeaders &httpHeaders=QgsHttpHeaders(), const QString &authcfg=QString())
 Constructor for QgsAuthorizationSettings.
 
bool setAuthorization (QNetworkRequest &request) const
 Update authorization for request.
 
bool setAuthorizationReply (QNetworkReply *reply) const
 Update authorization for reply.
 

Public Attributes

QString mAuthCfg
 Authentication configuration ID.
 
QgsHttpHeaders mHttpHeaders
 headers for http requests
 
QString mPassword
 Password for basic http authentication.
 
QString mUserName
 Username for basic http authentication.
 

Detailed Description

Utility class that contains authorization information.

Since
QGIS 3.42

Definition at line 35 of file qgsauthorizationsettings.h.

Constructor & Destructor Documentation

◆ QgsAuthorizationSettings()

QgsAuthorizationSettings::QgsAuthorizationSettings ( const QString &  userName = QString(),
const QString &  password = QString(),
const QgsHttpHeaders httpHeaders = QgsHttpHeaders(),
const QString &  authcfg = QString() 
)

Constructor for QgsAuthorizationSettings.

Definition at line 18 of file qgsauthorizationsettings.cpp.

Member Function Documentation

◆ setAuthorization()

bool QgsAuthorizationSettings::setAuthorization ( QNetworkRequest &  request) const

Update authorization for request.

Definition at line 25 of file qgsauthorizationsettings.cpp.

◆ setAuthorizationReply()

bool QgsAuthorizationSettings::setAuthorizationReply ( QNetworkReply *  reply) const

Update authorization for reply.

Definition at line 41 of file qgsauthorizationsettings.cpp.

Member Data Documentation

◆ mAuthCfg

QString QgsAuthorizationSettings::mAuthCfg

Authentication configuration ID.

Definition at line 58 of file qgsauthorizationsettings.h.

◆ mHttpHeaders

QgsHttpHeaders QgsAuthorizationSettings::mHttpHeaders

headers for http requests

Definition at line 55 of file qgsauthorizationsettings.h.

◆ mPassword

QString QgsAuthorizationSettings::mPassword

Password for basic http authentication.

Definition at line 52 of file qgsauthorizationsettings.h.

◆ mUserName

QString QgsAuthorizationSettings::mUserName

Username for basic http authentication.

Definition at line 49 of file qgsauthorizationsettings.h.


The documentation for this class was generated from the following files: