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 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::TerminationStatus
          
typedef CefRequestHandler::WindowOpenDisposition
          
typedef CefRequestHandler::X509CertificateList
          
 
Method Summary
 virtual bool GetAuthCredentials( CefRefPtr< CefBrowser > browser, const CefString& origin_url, 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< CefResourceRequestHandler > GetResourceRequestHandler( CefRefPtr< CefBrowser > browser, CefRefPtr< CefFrame > frame, CefRefPtr< CefRequest > request, bool is_navigation, bool is_download, const CefString& request_initiator, bool& disable_default_handling )
          Called on the browser process IO thread before a resource request is initiated.
 virtual bool OnBeforeBrowse( CefRefPtr< CefBrowser > browser, CefRefPtr< CefFrame > frame, CefRefPtr< CefRequest > request, bool user_gesture, bool is_redirect )
          Called on the UI thread before browser navigation.
 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 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 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, HasAtLeastOneRef
 

Method Detail

GetAuthCredentials

public virtual bool GetAuthCredentials( CefRefPtr< CefBrowser > browser, const CefString& origin_url, 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. |origin_url| is the origin making this authentication request. |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.

GetResourceRequestHandler

public virtual CefRefPtr< CefResourceRequestHandler > GetResourceRequestHandler( CefRefPtr< CefBrowser > browser, CefRefPtr< CefFrame > frame, CefRefPtr< CefRequest > request, bool is_navigation, bool is_download, const CefString& request_initiator, bool& disable_default_handling );
Called on the browser process IO thread before a resource request is initiated. The |browser| and |frame| values represent the source of the request. |request| represents the request contents and cannot be modified in this callback. |is_navigation| will be true if the resource request is a navigation. |is_download| will be true if the resource request is a download. |request_initiator| is the origin (scheme + domain) of the page that initiated the request. Set |disable_default_handling| to true to disable default handling of the request, in which case it will need to be handled via CefResourceRequestHandler::GetResourceHandler or it will be canceled. To allow the resource load to proceed with default handling return NULL. To specify a handler for the resource return a CefResourceRequestHandler object. If this callback returns NULL the same method will be called on the associated CefRequestContextHandler, if any.

OnBeforeBrowse

public virtual bool OnBeforeBrowse( CefRefPtr< CefBrowser > browser, CefRefPtr< CefFrame > frame, CefRefPtr< CefRequest > request, bool user_gesture, 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. 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).

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.

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.

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 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