QGIS API Documentation 3.39.0-Master (3783037d301)
|
This class implements simple http header management. More...
#include <qgshttpheaders.h>
Public Member Functions | |
QgsHttpHeaders () | |
QgsHttpHeaders (const QDomElement &element) | |
Constructor from a QDomElement element. | |
Q_DECL_DEPRECATED | QgsHttpHeaders (const QgsSettings &settings, const QString &key=QString()) |
Constructor from QgsSettings settings object and root key. | |
QgsHttpHeaders (const QString &key) | |
Constructor from default QgsSettings object and root key. | |
QgsHttpHeaders (const QVariantMap &headers) | |
Constructor from map. | |
virtual | ~QgsHttpHeaders () |
default detructor | |
QVariantMap | headers () const |
Returns the headers as a variant map. | |
void | insert (const QString &key, const QVariant &value) |
insert a key with the specific value | |
QList< QString > | keys () const |
QgsHttpHeaders & | operator= (const QMap< QString, QVariant > &headers) |
QVariant & | operator[] (const QString &key) |
const QVariant | operator[] (const QString &key) const |
QString | sanitizeKey (const QString &key) const |
Returns a cleansed key. | |
void | setFromDomElement (const QDomElement &element) |
Loads headers from the element. | |
void | setFromMap (const QVariantMap &map) |
Loads headers from the map. | |
void | setFromSettings (const QgsSettings &settings, const QString &key=QString()) |
Loads headers from the settings. | |
void | setFromUrlQuery (const QUrlQuery &uri) |
Loads headers from the uri. | |
QString | toSpacedString () const |
Returns key/value pairs as strings separated by space. | |
bool | updateDomElement (QDomElement &el) const |
Updates a map by adding all the HTTP headers. | |
bool | updateMap (QVariantMap &map) const |
Updates a map by adding all the HTTP headers. | |
bool | updateNetworkRequest (QNetworkRequest &request) const |
Updates a request by adding all the HTTP headers. | |
Q_DECL_DEPRECATED bool | updateSettings (QgsSettings &settings, const QString &key=QString()) const |
Updates the settings by adding all the http headers in the path "key/PATH_PREFIX/". | |
bool | updateUrlQuery (QUrlQuery &uri) const |
Updates an uri by adding all the HTTP headers. | |
Static Public Attributes | |
static const QString | KEY_REFERER = "referer" |
Used in settings as the referer key. | |
static const QString | PARAM_PREFIX = "http-header:" |
Used in uri to pass headers as params. | |
static const QString | PATH_PREFIX = "http-header/" |
Used in settings as the group name. | |
This class implements simple http header management.
Definition at line 41 of file qgshttpheaders.h.
QgsHttpHeaders::QgsHttpHeaders | ( | const QVariantMap & | headers | ) |
|
default |
QgsHttpHeaders::QgsHttpHeaders | ( | const QgsSettings & | settings, |
const QString & | key = QString() |
||
) |
Constructor from QgsSettings settings object and root key.
settings | |
key |
Definition at line 46 of file qgshttpheaders.cpp.
QgsHttpHeaders::QgsHttpHeaders | ( | const QString & | key | ) |
Constructor from default QgsSettings object and root key.
key |
Definition at line 51 of file qgshttpheaders.cpp.
QgsHttpHeaders::QgsHttpHeaders | ( | const QDomElement & | element | ) |
Constructor from a QDomElement element.
element |
Definition at line 56 of file qgshttpheaders.cpp.
|
virtualdefault |
default detructor
|
inline |
Returns the headers as a variant map.
Definition at line 93 of file qgshttpheaders.h.
void QgsHttpHeaders::insert | ( | const QString & | key, |
const QVariant & | value | ||
) |
insert a key with the specific value
key | a key to add |
value | a value to add for the key |
Definition at line 281 of file qgshttpheaders.cpp.
QList< QString > QgsHttpHeaders::keys | ( | ) | const |
Definition at line 275 of file qgshttpheaders.cpp.
QgsHttpHeaders & QgsHttpHeaders::operator= | ( | const QMap< QString, QVariant > & | headers | ) |
Definition at line 269 of file qgshttpheaders.cpp.
QVariant & QgsHttpHeaders::operator[] | ( | const QString & | key | ) |
key | http header key name |
Definition at line 259 of file qgshttpheaders.cpp.
const QVariant QgsHttpHeaders::operator[] | ( | const QString & | key | ) | const |
key | http header key name |
Definition at line 264 of file qgshttpheaders.cpp.
QString QgsHttpHeaders::sanitizeKey | ( | const QString & | key | ) | const |
Returns a cleansed key.
key | a key to be sanitized |
Definition at line 252 of file qgshttpheaders.cpp.
void QgsHttpHeaders::setFromDomElement | ( | const QDomElement & | element | ) |
Loads headers from the element.
key KEY_REFERER will be read from attribute "KEY_PREFIX+KEY_REFERER" and attribute "KEY_REFERER" (for backward compatibility)
element |
Definition at line 213 of file qgshttpheaders.cpp.
void QgsHttpHeaders::setFromMap | ( | const QVariantMap & | map | ) |
Loads headers from the map.
key KEY_REFERER will be read from key "KEY_PREFIX+KEY_REFERER" and key "KEY_REFERER" (for backward compatibility)
map |
Definition at line 194 of file qgshttpheaders.cpp.
void QgsHttpHeaders::setFromSettings | ( | const QgsSettings & | settings, |
const QString & | key = QString() |
||
) |
Loads headers from the settings.
key KEY_REFERER will be read at path "key/PATH_PREFIX/KEY_REFERER" and path "key/KEY_REFERER" (for backward compatibility)
settings | |
key | sub group path |
Definition at line 140 of file qgshttpheaders.cpp.
void QgsHttpHeaders::setFromUrlQuery | ( | const QUrlQuery & | uri | ) |
QString QgsHttpHeaders::toSpacedString | ( | ) | const |
Returns key/value pairs as strings separated by space.
Definition at line 235 of file qgshttpheaders.cpp.
bool QgsHttpHeaders::updateDomElement | ( | QDomElement & | el | ) | const |
Updates a map by adding all the HTTP headers.
KEY_REFERER value will be available at attribute "KEY_PREFIX+KEY_REFERER" and attribute "KEY_REFERER" (for backward compatibility)
true
if the update succeed Definition at line 124 of file qgshttpheaders.cpp.
bool QgsHttpHeaders::updateMap | ( | QVariantMap & | map | ) | const |
Updates a map by adding all the HTTP headers.
KEY_REFERER value will be available at key "KEY_PREFIX+KEY_REFERER" and key "KEY_REFERER" (for backward compatibility)
true
if the update succeed Definition at line 109 of file qgshttpheaders.cpp.
bool QgsHttpHeaders::updateNetworkRequest | ( | QNetworkRequest & | request | ) | const |
Updates a request by adding all the HTTP headers.
true
if the update succeed Definition at line 63 of file qgshttpheaders.cpp.
bool QgsHttpHeaders::updateSettings | ( | QgsSettings & | settings, |
const QString & | key = QString() |
||
) | const |
Updates the settings by adding all the http headers in the path "key/PATH_PREFIX/".
KEY_REFERER value will be available at path "key/PATH_PREFIX/KEY_REFERER" and path "key/KEY_REFERER" (for backward compatibility)
settings | |
key | sub group path |
true
if the update succeed Definition at line 81 of file qgshttpheaders.cpp.
bool QgsHttpHeaders::updateUrlQuery | ( | QUrlQuery & | uri | ) | const |
Updates an uri by adding all the HTTP headers.
true
if the update succeed Definition at line 72 of file qgshttpheaders.cpp.
|
static |
Used in settings as the referer key.
Definition at line 51 of file qgshttpheaders.h.
|
static |
Used in uri to pass headers as params.
Definition at line 54 of file qgshttpheaders.h.
|
static |
Used in settings as the group name.
Definition at line 48 of file qgshttpheaders.h.