QNetworkRequest¶
Synopsis¶
Functions¶
- def __eq__ (other)
- def __ne__ (other)
- def attribute (code[, defaultValue=None])
- def hasRawHeader (headerName)
- def header (header)
- def originatingObject ()
- def priority ()
- def rawHeader (headerName)
- def rawHeaderList ()
- def setAttribute (code, value)
- def setHeader (header, value)
- def setOriginatingObject (object)
- def setPriority (priority)
- def setRawHeader (headerName, value)
- def setSslConfiguration (configuration)
- def setUrl (url)
- def sslConfiguration ()
- def url ()
Detailed Description¶
The PySide.QtNetwork.QNetworkRequest class holds a request to be sent with PySide.QtNetwork.QNetworkAccessManager .
PySide.QtNetwork.QNetworkRequest is part of the Network Access API and is the class holding the information necessary to send a request over the network. It contains a URL and some ancillary information that can be used to modify the request.
- class PySide.QtNetwork.QNetworkRequest(other)¶
- class PySide.QtNetwork.QNetworkRequest([url=QUrl()])
Parameters: - url – PySide.QtCore.QUrl
- other – PySide.QtNetwork.QNetworkRequest
Creates a copy of other .
Constructs a PySide.QtNetwork.QNetworkRequest object with url as the URL to be requested.
- PySide.QtNetwork.QNetworkRequest.CacheLoadControl¶
Controls the caching mechanism of PySide.QtNetwork.QNetworkAccessManager .
Constant Description QNetworkRequest.AlwaysNetwork always load from network and do not check if the cache has a valid entry (similar to the “Reload” feature in browsers) QNetworkRequest.PreferNetwork default value; load from the network if the cached entry is older than the network entry QNetworkRequest.PreferCache load from cache if available, otherwise load from network. Note that this can return possibly stale (but not expired) items from cache. QNetworkRequest.AlwaysCache only load from cache, indicating error if the item was not cached (i.e., off-line mode)
- PySide.QtNetwork.QNetworkRequest.KnownHeaders¶
List of known header types that PySide.QtNetwork.QNetworkRequest parses. Each known header is also represented in raw form with its full HTTP name.
Constant Description QNetworkRequest.ContentTypeHeader corresponds to the HTTP Content-Type header and contains a string containing the media (MIME) type and any auxiliary data (for instance, charset) QNetworkRequest.ContentLengthHeader corresponds to the HTTP Content-Length header and contains the length in bytes of the data transmitted. QNetworkRequest.LocationHeader corresponds to the HTTP Location header and contains a URL representing the actual location of the data, including the destination URL in case of redirections. QNetworkRequest.LastModifiedHeader corresponds to the HTTP Last-Modified header and contains a PySide.QtCore.QDateTime representing the last modification date of the contents QNetworkRequest.CookieHeader corresponds to the HTTP Cookie header and contains a QList < PySide.QtNetwork.QNetworkCookie > representing the cookies to be sent back to the server QNetworkRequest.SetCookieHeader corresponds to the HTTP Set-Cookie header and contains a QList < PySide.QtNetwork.QNetworkCookie > representing the cookies sent by the server to be stored locally
- PySide.QtNetwork.QNetworkRequest.Priority¶
This enum lists the possible network request priorities.
Constant Description QNetworkRequest.HighPriority High priority QNetworkRequest.NormalPriority Normal priority QNetworkRequest.LowPriority Low priority
Note
This enum was introduced or modified in Qt 4.7
- PySide.QtNetwork.QNetworkRequest.Attribute¶
Attribute codes for the PySide.QtNetwork.QNetworkRequest and PySide.QtNetwork.QNetworkReply .
Attributes are extra meta-data that are used to control the behavior of the request and to pass further information from the reply back to the application. Attributes are also extensible, allowing custom implementations to pass custom values.
The following table explains what the default attribute codes are, the PySide.QtCore.QVariant types associated, the default value if said attribute is missing and whether it’s used in requests or replies.
Constant Description QNetworkRequest.HttpStatusCodeAttribute Replies only, type: QVariant.Int (no default) Indicates the HTTP status code received from the HTTP server (like 200, 304, 404, 401, etc.). If the connection was not HTTP-based, this attribute will not be present. QNetworkRequest.HttpReasonPhraseAttribute Replies only, type: QVariant.ByteArray (no default) Indicates the HTTP reason phrase as received from the HTTP server (like “Ok”, “Found”, “Not Found”, “Access Denied”, etc.) This is the human-readable representation of the status code (see above). If the connection was not HTTP-based, this attribute will not be present. QNetworkRequest.RedirectionTargetAttribute Replies only, type: QVariant.Url (no default) If present, it indicates that the server is redirecting the request to a different URL. The Network Access API does not by default follow redirections: it’s up to the application to determine if the requested redirection should be allowed, according to its security policies. The returned URL might be relative. Use QUrl.resolved() to create an absolute URL out of it. QNetworkRequest.ConnectionEncryptedAttribute Replies only, type: QVariant.Bool (default: false) Indicates whether the data was obtained through an encrypted (secure) connection. QNetworkRequest.CacheLoadControlAttribute Requests only, type: QVariant.Int (default: QNetworkRequest.PreferNetwork ) Controls how the cache should be accessed. The possible values are those of QNetworkRequest.CacheLoadControl . Note that the default PySide.QtNetwork.QNetworkAccessManager implementation does not support caching. However, this attribute may be used by certain backends to modify their requests (for example, for caching proxies). QNetworkRequest.CacheSaveControlAttribute Requests only, type: QVariant.Bool (default: true) Controls if the data obtained should be saved to cache for future uses. If the value is false, the data obtained will not be automatically cached. If true, data may be cached, provided it is cacheable (what is cacheable depends on the protocol being used). QNetworkRequest.SourceIsFromCacheAttribute Replies only, type: QVariant.Bool (default: false) Indicates whether the data was obtained from cache or not. QNetworkRequest.DoNotBufferUploadDataAttribute Requests only, type: QVariant.Bool (default: false) Indicates whether the PySide.QtNetwork.QNetworkAccessManager code is allowed to buffer the upload data, e.g. when doing a HTTP POST. When using this flag with sequential upload data, the ContentLengthHeader header must be set. QNetworkRequest.HttpPipeliningAllowedAttribute Requests only, type: QVariant.Bool (default: false) Indicates whether the PySide.QtNetwork.QNetworkAccessManager code is allowed to use HTTP pipelining with this request. QNetworkRequest.HttpPipeliningWasUsedAttribute Replies only, type: QVariant.Bool Indicates whether the HTTP pipelining was used for receiving this reply. QNetworkRequest.CustomVerbAttribute Requests only, type: QVariant.ByteArray Holds the value for the custom HTTP verb to send (destined for usage of other verbs than GET, POST, PUT and DELETE). This verb is set when calling QNetworkAccessManager.sendCustomRequest() . QNetworkRequest.CookieLoadControlAttribute Requests only, type: QVariant.Int (default: QNetworkRequest.Automatic ) Indicates whether to send ‘Cookie’ headers in the request. This attribute is set to false by QtWebKit when creating a cross-origin XMLHttpRequest where withCredentials has not been set explicitly to true by the Javascript that created the request. See here for more information. (This value was introduced in 4.7.) QNetworkRequest.CookieSaveControlAttribute Requests only, type: QVariant.Int (default: QNetworkRequest.Automatic ) Indicates whether to save ‘Cookie’ headers received from the server in reply to the request. This attribute is set to false by QtWebKit when creating a cross-origin XMLHttpRequest where withCredentials has not been set explicitly to true by the Javascript that created the request. See here for more information. (This value was introduced in 4.7.) QNetworkRequest.AuthenticationReuseAttribute Requests only, type: QVariant.Int (default: QNetworkRequest.Automatic ) Indicates whether to use cached authorization credentials in the request, if available. If this is set to QNetworkRequest.Manual and the authentication mechanism is ‘Basic’ or ‘Digest’, Qt will not send an an ‘Authorization’ HTTP header with any cached credentials it may have for the request’s URL. This attribute is set to QNetworkRequest.Manual by QtWebKit when creating a cross-origin XMLHttpRequest where withCredentials has not been set explicitly to true by the Javascript that created the request. See here for more information. (This value was introduced in 4.7.) QNetworkRequest.User Special type. Additional information can be passed in QVariants with types ranging from User to UserMax . The default implementation of Network Access will ignore any request attributes in this range and it will not produce any attributes in this range in replies. The range is reserved for extensions of PySide.QtNetwork.QNetworkAccessManager . QNetworkRequest.UserMax Special type. See User.
- PySide.QtNetwork.QNetworkRequest.LoadControl¶
Indicates if an aspect of the request’s loading mechanism has been manually overridden, e.g. by QtWebKit .
Constant Description QNetworkRequest.Automatic default value: indicates default behaviour. QNetworkRequest.Manual indicates behaviour has been manually overridden.
Note
This enum was introduced or modified in Qt 4.7
- PySide.QtNetwork.QNetworkRequest.attribute(code[, defaultValue=None])¶
Parameters: - code – PySide.QtNetwork.QNetworkRequest.Attribute
- defaultValue – object
Return type: object
Returns the attribute associated with the code code . If the attribute has not been set, it returns defaultValue .
Note: this function does not apply the defaults listed in QNetworkRequest.Attribute .
See also
PySide.QtNetwork.QNetworkRequest.setAttribute() QNetworkRequest.Attribute
- PySide.QtNetwork.QNetworkRequest.hasRawHeader(headerName)¶
Parameters: headerName – PySide.QtCore.QByteArray Return type: PySide.QtCore.bool Returns true if the raw header headerName is present in this network request.
- PySide.QtNetwork.QNetworkRequest.header(header)¶
Parameters: header – PySide.QtNetwork.QNetworkRequest.KnownHeaders Return type: object Returns the value of the known network header header if it is present in this request. If it is not present, returns QVariant() (i.e., an invalid variant).
See also
QNetworkRequest.KnownHeaders PySide.QtNetwork.QNetworkRequest.rawHeader() PySide.QtNetwork.QNetworkRequest.setHeader()
- PySide.QtNetwork.QNetworkRequest.__ne__(other)¶
Parameters: other – PySide.QtNetwork.QNetworkRequest Return type: PySide.QtCore.bool Returns false if this object is not the same as other .
See also
PySide.QtNetwork.QNetworkRequest.operator==()
- PySide.QtNetwork.QNetworkRequest.__eq__(other)¶
Parameters: other – PySide.QtNetwork.QNetworkRequest Return type: PySide.QtCore.bool Returns true if this object is the same as other (i.e., if they have the same URL, same headers and same meta-data settings).
See also
PySide.QtNetwork.QNetworkRequest.operator!=()
- PySide.QtNetwork.QNetworkRequest.originatingObject()¶
Return type: PySide.QtCore.QObject Returns a reference to the object that initiated this network request; returns 0 if not set or the object has been destroyed.
- PySide.QtNetwork.QNetworkRequest.priority()¶
Return type: PySide.QtNetwork.QNetworkRequest.Priority Return the priority of this request.
- PySide.QtNetwork.QNetworkRequest.rawHeader(headerName)¶
Parameters: headerName – PySide.QtCore.QByteArray Return type: PySide.QtCore.QByteArray Returns the raw form of header headerName . If no such header is present, an empty PySide.QtCore.QByteArray is returned, which may be indistinguishable from a header that is present but has no content (use PySide.QtNetwork.QNetworkRequest.hasRawHeader() to find out if the header exists or not).
Raw headers can be set with PySide.QtNetwork.QNetworkRequest.setRawHeader() or with PySide.QtNetwork.QNetworkRequest.setHeader() .
- PySide.QtNetwork.QNetworkRequest.rawHeaderList()¶
Return type: Returns a list of all raw headers that are set in this network request. The list is in the order that the headers were set.
- PySide.QtNetwork.QNetworkRequest.setAttribute(code, value)¶
Parameters: - code – PySide.QtNetwork.QNetworkRequest.Attribute
- value – object
Sets the attribute associated with code code to be value value . If the attribute is already set, the previous value is discarded. In special, if value is an invalid PySide.QtCore.QVariant , the attribute is unset.
See also
PySide.QtNetwork.QNetworkRequest.attribute() QNetworkRequest.Attribute
- PySide.QtNetwork.QNetworkRequest.setHeader(header, value)¶
Parameters: - header – PySide.QtNetwork.QNetworkRequest.KnownHeaders
- value – object
Sets the value of the known header header to be value , overriding any previously set headers. This operation also sets the equivalent raw HTTP header.
See also
QNetworkRequest.KnownHeaders PySide.QtNetwork.QNetworkRequest.setRawHeader() PySide.QtNetwork.QNetworkRequest.header()
- PySide.QtNetwork.QNetworkRequest.setOriginatingObject(object)¶
Parameters: object – PySide.QtCore.QObject Allows setting a reference to the object initiating the request.
For example QtWebKit sets the originating object to the PySide.QtWebKit.QWebFrame that initiated the request.
- PySide.QtNetwork.QNetworkRequest.setPriority(priority)¶
Parameters: priority – PySide.QtNetwork.QNetworkRequest.Priority Set the priority of this request to priority .
Note
The priority is only a hint to the network access manager. It can use it or not. Currently it is used for HTTP to decide which request should be sent first to a server.
- PySide.QtNetwork.QNetworkRequest.setRawHeader(headerName, value)¶
Parameters: - headerName – PySide.QtCore.QByteArray
- value – PySide.QtCore.QByteArray
Sets the header headerName to be of value headerValue . If headerName corresponds to a known header (see QNetworkRequest.KnownHeaders ), the raw format will be parsed and the corresponding “cooked” header will be set as well.
For example:
request.setRawHeader("Last-Modified", "Sun, 06 Nov 1994 08:49:37 GMT")
will also set the known header LastModifiedHeader to be the PySide.QtCore.QDateTime object of the parsed date.
Note: setting the same header twice overrides the previous setting. To accomplish the behaviour of multiple HTTP headers of the same name, you should concatenate the two values, separating them with a comma (”,”) and set one single raw header.
See also
QNetworkRequest.KnownHeaders PySide.QtNetwork.QNetworkRequest.setHeader() PySide.QtNetwork.QNetworkRequest.hasRawHeader() PySide.QtNetwork.QNetworkRequest.rawHeader()
- PySide.QtNetwork.QNetworkRequest.setSslConfiguration(configuration)¶
Parameters: configuration – PySide.QtNetwork.QSslConfiguration Sets this network request’s SSL configuration to be config . The settings that apply are the private key, the local certificate, the SSL protocol (SSLv2, SSLv3, TLSv1 where applicable) and the ciphers that the SSL backend is allowed to use.
By default, no SSL configuration is set, which allows the backends to choose freely what configuration is best for them.
- PySide.QtNetwork.QNetworkRequest.setUrl(url)¶
Parameters: url – PySide.QtCore.QUrl Sets the URL this network request is referring to to be url .
- PySide.QtNetwork.QNetworkRequest.sslConfiguration()¶
Return type: PySide.QtNetwork.QSslConfiguration Returns this network request’s SSL configuration. By default, no SSL settings are specified.
- PySide.QtNetwork.QNetworkRequest.url()¶
Return type: PySide.QtCore.QUrl Returns the URL this network request is referring to.
