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

(default)
Class CefRequestContext

CefBaseRefCounted
   |
   +--CefRequestContext

   in cef_request_context.h

class CefRequestContext
extends CefBaseRefCounted

A request context provides request handling for a set of related browser or URL request objects. A request context can be specified when creating a new browser via the CefBrowserHost static factory methods or when creating a new URL request via the CefURLRequest static factory methods. Browser objects with different request contexts will never be hosted in the same render process. Browser objects with the same request context may or may not be hosted in the same render process depending on the process model. Browser objects created indirectly via the JavaScript window.open function or targeted links will share the same render process and the same request context as the source browser. When running in single-process mode there is only a single render process (the main process) and so all browsers created in single-process mode will share the same request context. This will be the first request context passed into a CefBrowserHost static factory method and all other request context objects will be ignored.


Method Summary
 virtual bool CanSetPreference( const CefString& name )= 0
          Returns true if the preference with the specified |name| can be modified using SetPreference.
 virtual void ClearCertificateExceptions( CefRefPtr< CefCompletionCallback > callback )= 0
          Clears all certificate exceptions that were added as part of handling CefRequestHandler::OnCertificateError().
 virtual bool ClearSchemeHandlerFactories()= 0
          Clear all registered scheme handler factories.
 virtual void CloseAllConnections( CefRefPtr< CefCompletionCallback > callback )= 0
          Clears all active and idle connections that Chromium currently has.
 static CefRefPtr< CefRequestContext > CreateContext( CefRefPtr< CefRequestContext > other, CefRefPtr< CefRequestContextHandler > handler )
          Creates a new context object that shares storage with |other| and uses an optional |handler|.
 static CefRefPtr< CefRequestContext > CreateContext( const CefRequestContextSettings& settings, CefRefPtr< CefRequestContextHandler > handler )
          Creates a new context object with the specified |settings| and optional |handler|.
 virtual bool DidLoadExtension( const CefString& extension_id )= 0
          Returns true if this context was used to load the extension identified by |extension_id|.
 virtual CefRefPtr< CefDictionaryValue > GetAllPreferences( bool include_defaults )= 0
          Returns all preferences as a dictionary.
 virtual CefString GetCachePath()= 0
          Returns the cache path for this object.
 virtual CefRefPtr< CefCookieManager > GetDefaultCookieManager( CefRefPtr< CefCompletionCallback > callback )= 0
          Returns the default cookie manager for this object.
 virtual CefRefPtr< CefExtension > GetExtension( const CefString& extension_id )= 0
          Returns the extension matching |extension_id| or NULL if no matching extension is accessible in this context (see HasExtension).
 virtual bool GetExtensions( std::vector< CefString >& extension_ids )= 0
          Retrieve the list of all extensions that this context has access to (see HasExtension).
 static CefRefPtr< CefRequestContext > GetGlobalContext()
          Returns the global context object.
 virtual CefRefPtr< CefRequestContextHandler > GetHandler()= 0
          Returns the handler for this context if any.
 virtual CefRefPtr< CefValue > GetPreference( const CefString& name )= 0
          Returns the value for the preference with the specified |name|.
 virtual bool HasExtension( const CefString& extension_id )= 0
          Returns true if this context has access to the extension identified by |extension_id|.
 virtual bool HasPreference( const CefString& name )= 0
          Returns true if a preference with the specified |name| exists.
 virtual bool IsGlobal()= 0
          Returns true if this object is the global context.
 virtual bool IsSame( CefRefPtr< CefRequestContext > other )= 0
          Returns true if this object is pointing to the same context as |that| object.
 virtual bool IsSharingWith( CefRefPtr< CefRequestContext > other )= 0
          Returns true if this object is sharing the same storage as |that| object.
 virtual void LoadExtension( const CefString& root_directory, CefRefPtr< CefDictionaryValue > manifest, CefRefPtr< CefExtensionHandler > handler )= 0
          Load an extension.
 virtual void PurgePluginListCache( bool reload_pages )= 0
          Tells all renderer processes associated with this context to throw away their plugin list cache.
 virtual bool RegisterSchemeHandlerFactory( const CefString& scheme_name, const CefString& domain_name, CefRefPtr< CefSchemeHandlerFactory > factory )= 0
          Register a scheme handler factory for the specified |scheme_name| and optional |domain_name|.
 virtual void ResolveHost( const CefString& origin, CefRefPtr< CefResolveCallback > callback )= 0
          Attempts to resolve |origin| to a list of associated IP addresses.
 virtual cef_errorcode_t ResolveHostCached( const CefString& origin, std::vector< CefString >& resolved_ips )= 0
          Attempts to resolve |origin| to a list of associated IP addresses using cached data.
 virtual bool SetPreference( const CefString& name, CefRefPtr< CefValue > value, CefString& error )= 0
          Set the |value| associated with preference |name|.
   
Methods inherited from class CefBaseRefCounted
AddRef, Release, HasOneRef, HasAtLeastOneRef
 

Method Detail

CanSetPreference

public virtual bool CanSetPreference( const CefString& name )= 0;
Returns true if the preference with the specified |name| can be modified using SetPreference. As one example preferences set via the command-line usually cannot be modified. This method must be called on the browser process UI thread.

ClearCertificateExceptions

public virtual void ClearCertificateExceptions( CefRefPtr< CefCompletionCallback > callback )= 0;
Clears all certificate exceptions that were added as part of handling CefRequestHandler::OnCertificateError(). If you call this it is recommended that you also call CloseAllConnections() or you risk not being prompted again for server certificates if you reconnect quickly. If |callback| is non-NULL it will be executed on the UI thread after completion.

ClearSchemeHandlerFactories

public virtual bool ClearSchemeHandlerFactories()= 0;
Clear all registered scheme handler factories. Returns false on error. This function may be called on any thread in the browser process.

CloseAllConnections

public virtual void CloseAllConnections( CefRefPtr< CefCompletionCallback > callback )= 0;
Clears all active and idle connections that Chromium currently has. This is only recommended if you have released all other CEF objects but don't yet want to call CefShutdown(). If |callback| is non-NULL it will be executed on the UI thread after completion.

CreateContext

public static CefRefPtr< CefRequestContext > CreateContext( CefRefPtr< CefRequestContext > other, CefRefPtr< CefRequestContextHandler > handler );
Creates a new context object that shares storage with |other| and uses an optional |handler|.

CreateContext

public static CefRefPtr< CefRequestContext > CreateContext( const CefRequestContextSettings& settings, CefRefPtr< CefRequestContextHandler > handler );
Creates a new context object with the specified |settings| and optional |handler|.

DidLoadExtension

public virtual bool DidLoadExtension( const CefString& extension_id )= 0;
Returns true if this context was used to load the extension identified by |extension_id|. Other contexts sharing the same storage will also have access to the extension (see HasExtension). This method must be called on the browser process UI thread.

GetAllPreferences

public virtual CefRefPtr< CefDictionaryValue > GetAllPreferences( bool include_defaults )= 0;
Returns all preferences as a dictionary. If |include_defaults| is true then preferences currently at their default value will be included. The returned object contains a copy of the underlying preference values and modifications to the returned object will not modify the underlying preference values. This method must be called on the browser process UI thread.

GetCachePath

public virtual CefString GetCachePath()= 0;
Returns the cache path for this object. If empty an "incognito mode" in-memory cache is being used.

GetDefaultCookieManager

public virtual CefRefPtr< CefCookieManager > GetDefaultCookieManager( CefRefPtr< CefCompletionCallback > callback )= 0;
Returns the default cookie manager for this object. This will be the global cookie manager if this object is the global request context. Otherwise, this will be the default cookie manager used when this request context does not receive a value via CefRequestContextHandler::GetCookieManager(). If |callback| is non-NULL it will be executed asnychronously on the IO thread after the manager's storage has been initialized.

GetExtension

public virtual CefRefPtr< CefExtension > GetExtension( const CefString& extension_id )= 0;
Returns the extension matching |extension_id| or NULL if no matching extension is accessible in this context (see HasExtension). This method must be called on the browser process UI thread.

GetExtensions

public virtual bool GetExtensions( std::vector< CefString >& extension_ids )= 0;
Retrieve the list of all extensions that this context has access to (see HasExtension). |extension_ids| will be populated with the list of extension ID values. Returns true on success. This method must be called on the browser process UI thread.

GetGlobalContext

public static CefRefPtr< CefRequestContext > GetGlobalContext();
Returns the global context object.

GetHandler

public virtual CefRefPtr< CefRequestContextHandler > GetHandler()= 0;
Returns the handler for this context if any.

GetPreference

public virtual CefRefPtr< CefValue > GetPreference( const CefString& name )= 0;
Returns the value for the preference with the specified |name|. Returns NULL if the preference does not exist. The returned object contains a copy of the underlying preference value and modifications to the returned object will not modify the underlying preference value. This method must be called on the browser process UI thread.

HasExtension

public virtual bool HasExtension( const CefString& extension_id )= 0;
Returns true if this context has access to the extension identified by |extension_id|. This may not be the context that was used to load the extension (see DidLoadExtension). This method must be called on the browser process UI thread.

HasPreference

public virtual bool HasPreference( const CefString& name )= 0;
Returns true if a preference with the specified |name| exists. This method must be called on the browser process UI thread.

IsGlobal

public virtual bool IsGlobal()= 0;
Returns true if this object is the global context. The global context is used by default when creating a browser or URL request with a NULL context argument.

IsSame

public virtual bool IsSame( CefRefPtr< CefRequestContext > other )= 0;
Returns true if this object is pointing to the same context as |that| object.

IsSharingWith

public virtual bool IsSharingWith( CefRefPtr< CefRequestContext > other )= 0;
Returns true if this object is sharing the same storage as |that| object.

LoadExtension

public virtual void LoadExtension( const CefString& root_directory, CefRefPtr< CefDictionaryValue > manifest, CefRefPtr< CefExtensionHandler > handler )= 0;
Load an extension. If extension resources will be read from disk using the default load implementation then |root_directory| should be the absolute path to the extension resources directory and |manifest| should be NULL. If extension resources will be provided by the client (e.g. via CefRequestHandler and/or CefExtensionHandler) then |root_directory| should be a path component unique to the extension (if not absolute this will be internally prefixed with the PK_DIR_RESOURCES path) and |manifest| should contain the contents that would otherwise be read from the "manifest.json" file on disk. The loaded extension will be accessible in all contexts sharing the same storage (HasExtension returns true). However, only the context on which this method was called is considered the loader (DidLoadExtension returns true) and only the loader will receive CefRequestContextHandler callbacks for the extension. CefExtensionHandler::OnExtensionLoaded will be called on load success or CefExtensionHandler::OnExtensionLoadFailed will be called on load failure. If the extension specifies a background script via the "background" manifest key then CefExtensionHandler::OnBeforeBackgroundBrowser will be called to create the background browser. See that method for additional information about background scripts. For visible extension views the client application should evaluate the manifest to determine the correct extension URL to load and then pass that URL to the CefBrowserHost::CreateBrowser* function after the extension has loaded. For example, the client can look for the "browser_action" manifest key as documented at https://developer.chrome.com/extensions/browserAction. Extension URLs take the form "chrome-extension:///". Browsers that host extensions differ from normal browsers as follows: - Can access chrome.* JavaScript APIs if allowed by the manifest. Visit chrome://extensions-support for the list of extension APIs currently supported by CEF. - Main frame navigation to non-extension content is blocked. - Pinch-zooming is disabled. - CefBrowserHost::GetExtension returns the hosted extension. - CefBrowserHost::IsBackgroundHost returns true for background hosts. See https://developer.chrome.com/extensions for extension implementation and usage documentation.

PurgePluginListCache

public virtual void PurgePluginListCache( bool reload_pages )= 0;
Tells all renderer processes associated with this context to throw away their plugin list cache. If |reload_pages| is true they will also reload all pages with plugins. CefRequestContextHandler::OnBeforePluginLoad may be called to rebuild the plugin list cache.

RegisterSchemeHandlerFactory

public virtual bool RegisterSchemeHandlerFactory( const CefString& scheme_name, const CefString& domain_name, CefRefPtr< CefSchemeHandlerFactory > factory )= 0;
Register a scheme handler factory for the specified |scheme_name| and optional |domain_name|. An empty |domain_name| value for a standard scheme will cause the factory to match all domain names. The |domain_name| value will be ignored for non-standard schemes. If |scheme_name| is a built-in scheme and no handler is returned by |factory| then the built-in scheme handler factory will be called. If |scheme_name| is a custom scheme then you must also implement the CefApp::OnRegisterCustomSchemes() method in all processes. This function may be called multiple times to change or remove the factory that matches the specified |scheme_name| and optional |domain_name|. Returns false if an error occurs. This function may be called on any thread in the browser process.

ResolveHost

public virtual void ResolveHost( const CefString& origin, CefRefPtr< CefResolveCallback > callback )= 0;
Attempts to resolve |origin| to a list of associated IP addresses. |callback| will be executed on the UI thread after completion.

ResolveHostCached

public virtual cef_errorcode_t ResolveHostCached( const CefString& origin, std::vector< CefString >& resolved_ips )= 0;
Attempts to resolve |origin| to a list of associated IP addresses using cached data. |resolved_ips| will be populated with the list of resolved IP addresses or empty if no cached data is available. Returns ERR_NONE on success. This method must be called on the browser process IO thread.

SetPreference

public virtual bool SetPreference( const CefString& name, CefRefPtr< CefValue > value, CefString& error )= 0;
Set the |value| associated with preference |name|. Returns true if the value is set successfully and false otherwise. If |value| is NULL the preference will be restored to its default value. If setting the preference fails then |error| will be populated with a detailed description of the problem. This method must be called on the browser process UI thread.

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

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