QGIS API Documentation  3.11.0-Master (68611307d7)
Public Types | Public Member Functions | List of all members
QgsNetworkRequestParameters Class Reference

Encapsulates parameters and properties of a network request. More...

#include <qgsnetworkaccessmanager.h>

Public Types

enum  RequestAttributes { AttributeInitiatorClass = QNetworkRequest::User + 3000, AttributeInitiatorRequestId }
 Custom request attributes. More...
 

Public Member Functions

 QgsNetworkRequestParameters ()=default
 Default constructor. More...
 
 QgsNetworkRequestParameters (QNetworkAccessManager::Operation operation, const QNetworkRequest &request, int requestId, const QByteArray &content=QByteArray())
 Constructor for QgsNetworkRequestParameters, with the specified network operation and original request. More...
 
QByteArray content () const
 Returns the request's content. More...
 
QString initiatorClassName () const
 Returns the class name of the object which initiated this request. More...
 
QVariant initiatorRequestId () const
 Returns the internal ID used by the object which initiated this request to identify individual requests. More...
 
QNetworkAccessManager::Operation operation () const
 Returns the request operation, e.g. More...
 
QString originatingThreadId () const
 Returns a string identifying the thread which the request originated from. More...
 
QNetworkRequest request () const
 Returns the network request. More...
 
int requestId () const
 Returns a unique ID identifying the request. More...
 

Detailed Description

Encapsulates parameters and properties of a network request.

Since
QGIS 3.6

Definition at line 51 of file qgsnetworkaccessmanager.h.

Member Enumeration Documentation

◆ RequestAttributes

Custom request attributes.

Enumerator
AttributeInitiatorClass 

Class name of original object which created the request.

AttributeInitiatorRequestId 

Internal ID used by originator object to identify requests.

Definition at line 56 of file qgsnetworkaccessmanager.h.

Constructor & Destructor Documentation

◆ QgsNetworkRequestParameters() [1/2]

QgsNetworkRequestParameters::QgsNetworkRequestParameters ( )
default

Default constructor.

◆ QgsNetworkRequestParameters() [2/2]

QgsNetworkRequestParameters::QgsNetworkRequestParameters ( QNetworkAccessManager::Operation  operation,
const QNetworkRequest &  request,
int  requestId,
const QByteArray &  content = QByteArray() 
)

Constructor for QgsNetworkRequestParameters, with the specified network operation and original request.

Definition at line 673 of file qgsnetworkaccessmanager.cpp.

Member Function Documentation

◆ content()

QByteArray QgsNetworkRequestParameters::content ( ) const
inline

Returns the request's content.

This is only used for POST or PUT operation requests.

Definition at line 103 of file qgsnetworkaccessmanager.h.

◆ initiatorClassName()

QString QgsNetworkRequestParameters::initiatorClassName ( ) const
inline

Returns the class name of the object which initiated this request.

This is only available for QNetworkRequests which have had the QgsNetworkRequestParameters::AttributeInitiatorClass attribute set.

See also
initiatorRequestId()

Definition at line 113 of file qgsnetworkaccessmanager.h.

◆ initiatorRequestId()

QVariant QgsNetworkRequestParameters::initiatorRequestId ( ) const
inline

Returns the internal ID used by the object which initiated this request to identify individual requests.

This is only available for QNetworkRequests which have had the QgsNetworkRequestParameters::AttributeInitiatorRequestId attribute set.

See also
initiatorClassName()

Definition at line 124 of file qgsnetworkaccessmanager.h.

◆ operation()

QNetworkAccessManager::Operation QgsNetworkRequestParameters::operation ( ) const
inline

Returns the request operation, e.g.

GET or POST.

Definition at line 79 of file qgsnetworkaccessmanager.h.

◆ originatingThreadId()

QString QgsNetworkRequestParameters::originatingThreadId ( ) const
inline

Returns a string identifying the thread which the request originated from.

Definition at line 92 of file qgsnetworkaccessmanager.h.

◆ request()

QNetworkRequest QgsNetworkRequestParameters::request ( ) const
inline

Returns the network request.

This is the original network request sent to QgsNetworkAccessManager, but with QGIS specific configuration options such as proxy handling and SSL exceptions applied.

Definition at line 87 of file qgsnetworkaccessmanager.h.

◆ requestId()

int QgsNetworkRequestParameters::requestId ( ) const
inline

Returns a unique ID identifying the request.

Definition at line 97 of file qgsnetworkaccessmanager.h.


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