Skip to content

Request.md

Latest commit

 

History

History
226 lines (143 loc) · 4.84 KB

Request.md

File metadata and controls

226 lines (143 loc) · 4.84 KB

API categories | API index

Request (class)

Object of this class is used in RequestHandler.OnBeforeBrowse() and RequestHandler.OnBeforeResourceLoad().

Table of contents:

Methods

CreateRequest
Return static Request

You cannot instantiate Request class directly, use this static method instead by calling cefpython.Request.CreateRequest().

IsReadOnly
Return bool

Returns true if this object is read-only.

GetUrl
Return str

Get the fully qualified url.

SetUrl

Parameter Type
url string
Return void

Set the fully qualified url.

GetMethod
Return str

Get the request method type. The value will default to POST if post data is provided and GET otherwise.

SetMethod

Parameter Type
method string
Return void

Set the request method type.

GetPostData
Return list

Get the post data. If the form content type is "multipart/form-data" then the post data will be returned as a list. If the form content type is "application/x-www-form-urlencoded" then the post data will be returned as a dict.

SetPostData

Parameter Type
postData list
Return void

Set the post data. See GetPostData() for an explanation of the postData type.

GetHeaderMap
Return dict

Get all header fields with duplicate keys overwritten by last.

GetHeaderMultimap
Return list

Get all header fields. Returns list of tuples (name, value). Headers may have duplicate keys, if you want to ignore duplicates use GetHeaderMap().

SetHeaderMap

Parameter Type
headerMap dict
Return void

Set all header fields.

SetHeaderMultimap

Parameter Type
headerMultimap list
Return void

Set all header fields. headerMultimap must be a list of tuples (name, value).

GetFlags
Return int

Get the flags used in combination with WebRequest.

Available flags (access via cefpython.Request.Flags["xxx"]):

  • None - Default behavior.
  • SkipCache - If set the cache will be skipped when handling the request.
  • AllowCachedCredentials - If set user name, password, and cookies may be sent with the request.
  • AllowCookies - If set cookies may be sent with the request and saved from the response. AllowCachedCredentials must also be set.
  • ReportUploadProgress - If set upload progress events will be generated when a request has a body.
  • ReportLoadTiming - If set load timing info will be collected for the request.
  • ReportRawHeaders - If set the headers sent and received for the request will be recorded.
  • NoDownloadData - If set the WebRequestClient::OnDownloadData method will not be called.
  • NoRetryOn5xx - If set 5xx redirect errors will be propagated to the observer instead of automatically re-tried. This currently only applies for requests originated in the browser process.

SetFlags

Parameter Type
flags int
Return void

Set the flags used in combination with WebRequest.

GetFirstPartyForCookies
Return str

Get the url to the first party for cookies used in combination with
WebRequest.

SetFirstPartyForCookies

Parameter Type
url string
Return void

Set the url to the first party for cookies used in combination with
WebRequest.

GetResourceType
Return int

Not yet implemented in CEF Python.

Get the resource type for this request. Accurate resource type information may only be available in the browser process.

GetTransitionType
Return int

Not yet implemented in CEF Python.

Get the transition type for this request. Only available in the browser
process and only applies to requests that represent a main frame or
sub-frame navigation.