Overview   Project   Class   Tree   Index 
CEF3 C++ API Docs - Version 3.3239.1700.g385b2d4
FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD

(default)
Class CefRequestHandler

CefBaseRefCounted
   |
   +--CefRequestHandler

   in cef_request_handler.h

class CefRequestHandler
extends CefBaseRefCounted

Implement this interface to handle events related to browser requests. The methods of this class will be called on the thread indicated.


Inner Classes, Typedefs, and Enums
typedef CefRequestHandler::ReturnValue
          
typedef CefRequestHandler::TerminationStatus
          
typedef CefRequestHandler::URLRequestStatus
          
typedef CefRequestHandler::WindowOpenDisposition
          
typedef CefRequestHandler::X509CertificateList
          
 
Method Summary
 virtual bool GetAuthCredentials( CefRefPtr< CefBrowser > browser, CefRefPtr< CefFrame > frame, bool isProxy, const CefString& host, int port, const CefString& realm, const CefString& scheme, CefRefPtr< CefAuthCallback > callback )
          Called on the IO thread when the browser needs credentials from the user.
 virtual CefRefPtr< CefResourceHandler > GetResourceHandler( CefRefPtr< CefBrowser > browser, CefRefPtr< CefFrame > frame, CefRefPtr< CefRequest > request )
          Called on the IO thread before a resource is loaded.
 virtual CefRefPtr< CefResponseFilter > GetResourceResponseFilter( CefRefPtr< CefBrowser > browser, CefRefPtr< CefFrame > frame, CefRefPtr< CefRequest > request, CefRefPtr< CefResponse > response )
          Called on the IO thread to optionally filter resource response content.
 virtual bool OnBeforeBrowse( CefRefPtr< CefBrowser > browser, CefRefPtr< CefFrame > frame, CefRefPtr< CefRequest > request, bool is_redirect )
          Called on the UI thread before browser navigation.
 virtual CefRequestHandler::ReturnValue OnBeforeResourceLoad( CefRefPtr< CefBrowser > browser, CefRefPtr< CefFrame > frame, CefRefPtr< CefRequest > request, CefRefPtr< CefRequestCallback > callback )
          Called on the IO thread before a resource request is loaded.
 virtual bool OnCertificateError( CefRefPtr< CefBrowser > browser, cef_errorcode_t cert_error, const CefString& request_url, CefRefPtr< CefSSLInfo > ssl_info, CefRefPtr< CefRequestCallback > callback )
          Called on the UI thread to handle requests for URLs with an invalid SSL certificate.
 virtual bool OnOpenURLFromTab( CefRefPtr< CefBrowser > browser, CefRefPtr< CefFrame > frame, const CefString& target_url, CefRequestHandler::WindowOpenDisposition target_disposition, bool user_gesture )
          Called on the UI thread before OnBeforeBrowse in certain limited cases where navigating a new or different browser might be desirable.
 virtual void OnPluginCrashed( CefRefPtr< CefBrowser > browser, const CefString& plugin_path )
          Called on the browser process UI thread when a plugin has crashed.
 virtual void OnProtocolExecution( CefRefPtr< CefBrowser > browser, const CefString& url, bool& allow_os_execution )
          Called on the UI thread to handle requests for URLs with an unknown protocol component.
 virtual bool OnQuotaRequest( CefRefPtr< CefBrowser > browser, const CefString& origin_url, int64 new_size, CefRefPtr< CefRequestCallback > callback )
          Called on the IO thread when JavaScript requests a specific storage quota size via the webkitStorageInfo.
 virtual void OnRenderProcessTerminated( CefRefPtr< CefBrowser > browser, CefRequestHandler::TerminationStatus status )
          Called on the browser process UI thread when the render process terminates unexpectedly.
 virtual void OnRenderViewReady( CefRefPtr< CefBrowser > browser )
          Called on the browser process UI thread when the render view associated with |browser| is ready to receive/handle IPC messages in the render process.
 virtual void OnResourceLoadComplete( CefRefPtr< CefBrowser > browser, CefRefPtr< CefFrame > frame, CefRefPtr< CefRequest > request, CefRefPtr< CefResponse > response, CefRequestHandler::URLRequestStatus status, int64 received_content_length )
          Called on the IO thread when a resource load has completed.
 virtual void OnResourceRedirect( CefRefPtr< CefBrowser > browser, CefRefPtr< CefFrame > frame, CefRefPtr< CefRequest > request, CefRefPtr< CefResponse > response, CefString& new_url )
          Called on the IO thread when a resource load is redirected.
 virtual bool OnResourceResponse( CefRefPtr< CefBrowser > browser, CefRefPtr< CefFrame > frame, CefRefPtr< CefRequest > request, CefRefPtr< CefResponse > response )
          Called on the IO thread when a resource response is received.
 virtual bool OnSelectClientCertificate( CefRefPtr< CefBrowser > browser, bool isProxy, const CefString& host, int port, const CefRequestHandler::X509CertificateList& certificates, CefRefPtr< CefSelectClientCertificateCallback > callback )
          Called on the UI thread when a client certificate is being requested for authentication.
   
Methods inherited from class CefBaseRefCounted
AddRef, Release, HasOneRef
 

Method Detail

GetAuthCredentials

public virtual bool GetAuthCredentials( CefRefPtr< CefBrowser > browser, CefRefPtr< CefFrame > frame, bool isProxy, const CefString& host, int port, const CefString& realm, const CefString& scheme, CefRefPtr< CefAuthCallback > callback );
Called on the IO thread when the browser needs credentials from the user. |isProxy| indicates whether the host is a proxy server. |host| contains the hostname and |port| contains the port number. |realm| is the realm of the challenge and may be empty. |scheme| is the authentication scheme used, such as "basic" or "digest", and will be empty if the source of the request is an FTP server. Return true to continue the request and call CefAuthCallback::Continue() either in this method or at a later time when the authentication information is available. Return false to cancel the request immediately.

GetResourceHandler

public virtual CefRefPtr< CefResourceHandler > GetResourceHandler( CefRefPtr< CefBrowser > browser, CefRefPtr< CefFrame > frame, CefRefPtr< CefRequest > request );
Called on the IO thread before a resource is loaded. To allow the resource to load normally return NULL. To specify a handler for the resource return a CefResourceHandler object. The |request| object should not be modified in this callback.

GetResourceResponseFilter

public virtual CefRefPtr< CefResponseFilter > GetResourceResponseFilter( CefRefPtr< CefBrowser > browser, CefRefPtr< CefFrame > frame, CefRefPtr< CefRequest > request, CefRefPtr< CefResponse > response );
Called on the IO thread to optionally filter resource response content. |request| and |response| represent the request and response respectively and cannot be modified in this callback.

OnBeforeBrowse

public virtual bool OnBeforeBrowse( CefRefPtr< CefBrowser > browser, CefRefPtr< CefFrame > frame, CefRefPtr< CefRequest > request, bool is_redirect );
Called on the UI thread before browser navigation. Return true to cancel the navigation or false to allow the navigation to proceed. The |request| object cannot be modified in this callback. CefLoadHandler::OnLoadingStateChange will be called twice in all cases. If the navigation is allowed CefLoadHandler::OnLoadStart and CefLoadHandler::OnLoadEnd will be called. If the navigation is canceled CefLoadHandler::OnLoadError will be called with an |errorCode| value of ERR_ABORTED.

OnBeforeResourceLoad

public virtual CefRequestHandler::ReturnValue OnBeforeResourceLoad( CefRefPtr< CefBrowser > browser, CefRefPtr< CefFrame > frame, CefRefPtr< CefRequest > request, CefRefPtr< CefRequestCallback > callback );
Called on the IO thread before a resource request is loaded. The |request| object may be modified. Return RV_CONTINUE to continue the request immediately. Return RV_CONTINUE_ASYNC and call CefRequestCallback:: Continue() at a later time to continue or cancel the request asynchronously. Return RV_CANCEL to cancel the request immediately.

OnCertificateError

public virtual bool OnCertificateError( CefRefPtr< CefBrowser > browser, cef_errorcode_t cert_error, const CefString& request_url, CefRefPtr< CefSSLInfo > ssl_info, CefRefPtr< CefRequestCallback > callback );
Called on the UI thread to handle requests for URLs with an invalid SSL certificate. Return true and call CefRequestCallback::Continue() either in this method or at a later time to continue or cancel the request. Return false to cancel the request immediately. If CefSettings.ignore_certificate_errors is set all invalid certificates will be accepted without calling this method.

OnOpenURLFromTab

public virtual bool OnOpenURLFromTab( CefRefPtr< CefBrowser > browser, CefRefPtr< CefFrame > frame, const CefString& target_url, CefRequestHandler::WindowOpenDisposition target_disposition, bool user_gesture );
Called on the UI thread before OnBeforeBrowse in certain limited cases where navigating a new or different browser might be desirable. This includes user-initiated navigation that might open in a special way (e.g. links clicked via middle-click or ctrl + left-click) and certain types of cross-origin navigation initiated from the renderer process (e.g. navigating the top-level frame to/from a file URL). The |browser| and |frame| values represent the source of the navigation. The |target_disposition| value indicates where the user intended to navigate the browser based on standard Chromium behaviors (e.g. current tab, new tab, etc). The |user_gesture| value will be true if the browser navigated via explicit user gesture (e.g. clicking a link) or false if it navigated automatically (e.g. via the DomContentLoaded event). Return true to cancel the navigation or false to allow the navigation to proceed in the source browser's top-level frame.

OnPluginCrashed

public virtual void OnPluginCrashed( CefRefPtr< CefBrowser > browser, const CefString& plugin_path );
Called on the browser process UI thread when a plugin has crashed. |plugin_path| is the path of the plugin that crashed.

OnProtocolExecution

public virtual void OnProtocolExecution( CefRefPtr< CefBrowser > browser, const CefString& url, bool& allow_os_execution );
Called on the UI thread to handle requests for URLs with an unknown protocol component. Set |allow_os_execution| to true to attempt execution via the registered OS protocol handler, if any. SECURITY WARNING: YOU SHOULD USE THIS METHOD TO ENFORCE RESTRICTIONS BASED ON SCHEME, HOST OR OTHER URL ANALYSIS BEFORE ALLOWING OS EXECUTION.

OnQuotaRequest

public virtual bool OnQuotaRequest( CefRefPtr< CefBrowser > browser, const CefString& origin_url, int64 new_size, CefRefPtr< CefRequestCallback > callback );
Called on the IO thread when JavaScript requests a specific storage quota size via the webkitStorageInfo.requestQuota function. |origin_url| is the origin of the page making the request. |new_size| is the requested quota size in bytes. Return true to continue the request and call CefRequestCallback::Continue() either in this method or at a later time to grant or deny the request. Return false to cancel the request immediately.

OnRenderProcessTerminated

public virtual void OnRenderProcessTerminated( CefRefPtr< CefBrowser > browser, CefRequestHandler::TerminationStatus status );
Called on the browser process UI thread when the render process terminates unexpectedly. |status| indicates how the process terminated.

OnRenderViewReady

public virtual void OnRenderViewReady( CefRefPtr< CefBrowser > browser );
Called on the browser process UI thread when the render view associated with |browser| is ready to receive/handle IPC messages in the render process.

OnResourceLoadComplete

public virtual void OnResourceLoadComplete( CefRefPtr< CefBrowser > browser, CefRefPtr< CefFrame > frame, CefRefPtr< CefRequest > request, CefRefPtr< CefResponse > response, CefRequestHandler::URLRequestStatus status, int64 received_content_length );
Called on the IO thread when a resource load has completed. |request| and |response| represent the request and response respectively and cannot be modified in this callback. |status| indicates the load completion status. |received_content_length| is the number of response bytes actually read.

OnResourceRedirect

public virtual void OnResourceRedirect( CefRefPtr< CefBrowser > browser, CefRefPtr< CefFrame > frame, CefRefPtr< CefRequest > request, CefRefPtr< CefResponse > response, CefString& new_url );
Called on the IO thread when a resource load is redirected. The |request| parameter will contain the old URL and other request-related information. The |response| parameter will contain the response that resulted in the redirect. The |new_url| parameter will contain the new URL and can be changed if desired. The |request| object cannot be modified in this callback.

OnResourceResponse

public virtual bool OnResourceResponse( CefRefPtr< CefBrowser > browser, CefRefPtr< CefFrame > frame, CefRefPtr< CefRequest > request, CefRefPtr< CefResponse > response );
Called on the IO thread when a resource response is received. To allow the resource to load normally return false. To redirect or retry the resource modify |request| (url, headers or post body) and return true. The |response| object cannot be modified in this callback.

OnSelectClientCertificate

public virtual bool OnSelectClientCertificate( CefRefPtr< CefBrowser > browser, bool isProxy, const CefString& host, int port, const CefRequestHandler::X509CertificateList& certificates, CefRefPtr< CefSelectClientCertificateCallback > callback );
Called on the UI thread when a client certificate is being requested for authentication. Return false to use the default behavior and automatically select the first certificate available. Return true and call CefSelectClientCertificateCallback::Select either in this method or at a later time to select a certificate. Do not call Select or call it with NULL to continue without using any certificate. |isProxy| indicates whether the host is an HTTPS proxy or the origin server. |host| and |port| contains the hostname and port of the SSL server. |certificates| is the list of certificates to choose from; this list has already been pruned by Chromium so that it only contains certificates from issuers that the server trusts.

 Overview   Project   Class   Tree   Index 
CEF3 C++ API Docs - Version 3.3239.1700.g385b2d4
FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD

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