Overview   Project   Class   Tree   Index 
CEF3 C++ API Docs - Version 75.1.4+g4210896+chromium-75.0.3770.100
FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD

(default)
Class CefRequest

CefBaseRefCounted
   |
   +--CefRequest

   in cef_request.h

class CefRequest
extends CefBaseRefCounted

Class used to represent a web request. The methods of this class may be called on any thread.


Inner Classes, Typedefs, and Enums
typedef CefRequest::HeaderMap
          
typedef CefRequest::ReferrerPolicy
          
typedef CefRequest::ResourceType
          
typedef CefRequest::TransitionType
          
 
Method Summary
 static CefRefPtr< CefRequest > Create()
          Create a new CefRequest object.
 virtual CefString GetFirstPartyForCookies()= 0
          Get the URL to the first party for cookies used in combination with CefURLRequest.
 virtual int GetFlags()= 0
          Get the flags used in combination with CefURLRequest.
 virtual CefString GetHeaderByName( const CefString& name )= 0
          Returns the first header value for |name| or an empty string if not found.
 virtual void GetHeaderMap( CefRequest::HeaderMap& headerMap )= 0
          Get the header values.
 virtual uint64 GetIdentifier()= 0
          Returns the globally unique identifier for this request or 0 if not specified.
 virtual CefString GetMethod()= 0
          Get the request method type.
 virtual CefRefPtr< CefPostData > GetPostData()= 0
          Get the post data.
 virtual CefRequest::ReferrerPolicy GetReferrerPolicy()= 0
          Get the referrer policy.
 virtual CefString GetReferrerURL()= 0
          Get the referrer URL.
 virtual CefRequest::ResourceType GetResourceType()= 0
          Get the resource type for this request.
 virtual CefRequest::TransitionType GetTransitionType()= 0
          Get the transition type for this request.
 virtual CefString GetURL()= 0
          Get the fully qualified URL.
 virtual bool IsReadOnly()= 0
          Returns true if this object is read-only.
 virtual void Set( const CefString& url, const CefString& method, CefRefPtr< CefPostData > postData, const CefRequest::HeaderMap& headerMap )= 0
          Set all values at one time.
 virtual void SetFirstPartyForCookies( const CefString& url )= 0
          Set the URL to the first party for cookies used in combination with CefURLRequest.
 virtual void SetFlags( int flags )= 0
          Set the flags used in combination with CefURLRequest.
 virtual void SetHeaderByName( const CefString& name, const CefString& value, bool overwrite )= 0
          Set the header |name| to |value|.
 virtual void SetHeaderMap( const CefRequest::HeaderMap& headerMap )= 0
          Set the header values.
 virtual void SetMethod( const CefString& method )= 0
          Set the request method type.
 virtual void SetPostData( CefRefPtr< CefPostData > postData )= 0
          Set the post data.
 virtual void SetReferrer( const CefString& referrer_url, CefRequest::ReferrerPolicy policy )= 0
          Set the referrer URL and policy.
 virtual void SetURL( const CefString& url )= 0
          Set the fully qualified URL.
   
Methods inherited from class CefBaseRefCounted
AddRef, Release, HasOneRef, HasAtLeastOneRef
 

Method Detail

Create

public static CefRefPtr< CefRequest > Create();
Create a new CefRequest object.

GetFirstPartyForCookies

public virtual CefString GetFirstPartyForCookies()= 0;
Get the URL to the first party for cookies used in combination with CefURLRequest.

GetFlags

public virtual int GetFlags()= 0;
Get the flags used in combination with CefURLRequest. See cef_urlrequest_flags_t for supported values.

GetHeaderByName

public virtual CefString GetHeaderByName( const CefString& name )= 0;
Returns the first header value for |name| or an empty string if not found. Will not return the Referer value if any. Use GetHeaderMap instead if |name| might have multiple values.

GetHeaderMap

public virtual void GetHeaderMap( CefRequest::HeaderMap& headerMap )= 0;
Get the header values. Will not include the Referer value if any.

GetIdentifier

public virtual uint64 GetIdentifier()= 0;
Returns the globally unique identifier for this request or 0 if not specified. Can be used by CefResourceRequestHandler implementations in the browser process to track a single request across multiple callbacks.

GetMethod

public virtual CefString GetMethod()= 0;
Get the request method type. The value will default to POST if post data is provided and GET otherwise.

GetPostData

public virtual CefRefPtr< CefPostData > GetPostData()= 0;
Get the post data.

GetReferrerPolicy

public virtual CefRequest::ReferrerPolicy GetReferrerPolicy()= 0;
Get the referrer policy.

GetReferrerURL

public virtual CefString GetReferrerURL()= 0;
Get the referrer URL.

GetResourceType

public virtual CefRequest::ResourceType GetResourceType()= 0;
Get the resource type for this request. Only available in the browser process.

GetTransitionType

public virtual CefRequest::TransitionType GetTransitionType()= 0;
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.

GetURL

public virtual CefString GetURL()= 0;
Get the fully qualified URL.

IsReadOnly

public virtual bool IsReadOnly()= 0;
Returns true if this object is read-only.

Set

public virtual void Set( const CefString& url, const CefString& method, CefRefPtr< CefPostData > postData, const CefRequest::HeaderMap& headerMap )= 0;
Set all values at one time.

SetFirstPartyForCookies

public virtual void SetFirstPartyForCookies( const CefString& url )= 0;
Set the URL to the first party for cookies used in combination with CefURLRequest.

SetFlags

public virtual void SetFlags( int flags )= 0;
Set the flags used in combination with CefURLRequest. See cef_urlrequest_flags_t for supported values.

SetHeaderByName

public virtual void SetHeaderByName( const CefString& name, const CefString& value, bool overwrite )= 0;
Set the header |name| to |value|. If |overwrite| is true any existing values will be replaced with the new value. If |overwrite| is false any existing values will not be overwritten. The Referer value cannot be set using this method.

SetHeaderMap

public virtual void SetHeaderMap( const CefRequest::HeaderMap& headerMap )= 0;
Set the header values. If a Referer value exists in the header map it will be removed and ignored.

SetMethod

public virtual void SetMethod( const CefString& method )= 0;
Set the request method type.

SetPostData

public virtual void SetPostData( CefRefPtr< CefPostData > postData )= 0;
Set the post data.

SetReferrer

public virtual void SetReferrer( const CefString& referrer_url, CefRequest::ReferrerPolicy policy )= 0;
Set the referrer URL and policy. If non-empty the referrer URL must be fully qualified with an HTTP or HTTPS scheme component. Any username, password or ref component will be removed.

SetURL

public virtual void SetURL( const CefString& url )= 0;
Set the fully qualified URL.

 Overview   Project   Class   Tree   Index 
CEF3 C++ API Docs - Version 75.1.4+g4210896+chromium-75.0.3770.100
FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD

Chromium Embedded Framework (CEF) Copyright © 2016 Marshall A. Greenblatt