QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
HTTP network content fetcher. More...
#include <qgsnetworkcontentfetcher.h>
Signals | |
void | downloadProgress (qint64 bytesReceived, qint64 bytesTotal) |
Emitted when data is received. | |
void | errorOccurred (QNetworkReply::NetworkError code, const QString &errorMsg) |
Emitted when an error with code error occurred while processing the request errorMsg is a textual description of the error. | |
void | finished () |
Emitted when content has loaded. | |
Public Member Functions | |
QgsNetworkContentFetcher ()=default | |
~QgsNetworkContentFetcher () override | |
void | cancel () |
Cancels any ongoing request. | |
QString | contentAsString () const |
Returns the fetched content as a string. | |
QString | contentDispositionFilename () const |
Returns the associated filename from the reply's content disposition header, if present. | |
void | fetchContent (const QNetworkRequest &request, const QString &authcfg=QString()) |
Fetches content using a network request and handles redirects. | |
void | fetchContent (const QUrl &url, const QString &authcfg=QString()) |
Fetches content from a remote URL and handles redirects. | |
QNetworkReply * | reply () |
Returns a reference to the network reply. | |
bool | wasCanceled () const |
Returns true if the fetching was canceled. | |
HTTP network content fetcher.
A simple method for fetching remote HTTP content and converting the content to standard formats.
URL redirects are automatically handled.
Definition at line 39 of file qgsnetworkcontentfetcher.h.
|
default |
|
override |
Definition at line 29 of file qgsnetworkcontentfetcher.cpp.
void QgsNetworkContentFetcher::cancel | ( | ) |
Cancels any ongoing request.
Definition at line 116 of file qgsnetworkcontentfetcher.cpp.
QString QgsNetworkContentFetcher::contentAsString | ( | ) | const |
Returns the fetched content as a string.
Definition at line 102 of file qgsnetworkcontentfetcher.cpp.
QString QgsNetworkContentFetcher::contentDispositionFilename | ( | ) | const |
Returns the associated filename from the reply's content disposition header, if present.
Definition at line 97 of file qgsnetworkcontentfetcher.cpp.
|
signal |
Emitted when data is received.
|
signal |
Emitted when an error with code error occurred while processing the request errorMsg is a textual description of the error.
void QgsNetworkContentFetcher::fetchContent | ( | const QNetworkRequest & | request, |
const QString & | authcfg = QString() |
||
) |
Fetches content using a network request and handles redirects.
The finished() signal will be emitted when content has been fetched.
Optionally, authentication configuration can be set via the authcfg argument.
Definition at line 47 of file qgsnetworkcontentfetcher.cpp.
void QgsNetworkContentFetcher::fetchContent | ( | const QUrl & | url, |
const QString & | authcfg = QString() |
||
) |
Fetches content from a remote URL and handles redirects.
The finished() signal will be emitted when content has been fetched.
url | URL to fetch |
authcfg | optional authentication configuration |
Definition at line 39 of file qgsnetworkcontentfetcher.cpp.
|
signal |
Emitted when content has loaded.
QNetworkReply * QgsNetworkContentFetcher::reply | ( | ) |
Returns a reference to the network reply.
Definition at line 87 of file qgsnetworkcontentfetcher.cpp.
bool QgsNetworkContentFetcher::wasCanceled | ( | ) | const |
Returns true
if the fetching was canceled.
Definition at line 129 of file qgsnetworkcontentfetcher.cpp.