Chromium Embedded Framework (CEF)
117.1.0+ga287baf+chromium-117.0.5938.62
|
A request context provides request handling for a set of related browser or URL request objects. More...
#include "include/cef_request_context.h"
Public Member Functions | |
virtual bool | IsSame (CefRefPtr< CefRequestContext > other)=0 |
Returns true if this object is pointing to the same context as |that| object. More... | |
virtual bool | IsSharingWith (CefRefPtr< CefRequestContext > other)=0 |
Returns true if this object is sharing the same storage as |that| object. More... | |
virtual bool | IsGlobal ()=0 |
Returns true if this object is the global context. More... | |
virtual CefRefPtr< CefRequestContextHandler > | GetHandler ()=0 |
Returns the handler for this context if any. More... | |
virtual CefString | GetCachePath ()=0 |
Returns the cache path for this object. More... | |
virtual CefRefPtr< CefCookieManager > | GetCookieManager (CefRefPtr< CefCompletionCallback > callback)=0 |
Returns the cookie manager for this object. More... | |
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|. More... | |
virtual bool | ClearSchemeHandlerFactories ()=0 |
Clear all registered scheme handler factories. More... | |
virtual void | ClearCertificateExceptions (CefRefPtr< CefCompletionCallback > callback)=0 |
Clears all certificate exceptions that were added as part of handling CefRequestHandler::OnCertificateError(). More... | |
virtual void | ClearHttpAuthCredentials (CefRefPtr< CefCompletionCallback > callback)=0 |
Clears all HTTP authentication credentials that were added as part of handling GetAuthCredentials. More... | |
virtual void | CloseAllConnections (CefRefPtr< CefCompletionCallback > callback)=0 |
Clears all active and idle connections that Chromium currently has. More... | |
virtual void | ResolveHost (const CefString &origin, CefRefPtr< CefResolveCallback > callback)=0 |
Attempts to resolve |origin| to a list of associated IP addresses. More... | |
virtual void | LoadExtension (const CefString &root_directory, CefRefPtr< CefDictionaryValue > manifest, CefRefPtr< CefExtensionHandler > handler)=0 |
Load an extension. More... | |
virtual bool | DidLoadExtension (const CefString &extension_id)=0 |
Returns true if this context was used to load the extension identified by |extension_id|. More... | |
virtual bool | HasExtension (const CefString &extension_id)=0 |
Returns true if this context has access to the extension identified by |extension_id|. More... | |
virtual bool | GetExtensions (std::vector< CefString > &extension_ids)=0 |
Retrieve the list of all extensions that this context has access to (see HasExtension). More... | |
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). More... | |
virtual CefRefPtr< CefMediaRouter > | GetMediaRouter (CefRefPtr< CefCompletionCallback > callback)=0 |
Returns the MediaRouter object associated with this context. More... | |
virtual CefRefPtr< CefValue > | GetWebsiteSetting (const CefString &requesting_url, const CefString &top_level_url, cef_content_setting_types_t content_type)=0 |
Returns the current value for |content_type| that applies for the specified URLs. More... | |
virtual void | SetWebsiteSetting (const CefString &requesting_url, const CefString &top_level_url, cef_content_setting_types_t content_type, CefRefPtr< CefValue > value)=0 |
Sets the current value for |content_type| for the specified URLs in the default scope. More... | |
virtual cef_content_setting_values_t | GetContentSetting (const CefString &requesting_url, const CefString &top_level_url, cef_content_setting_types_t content_type)=0 |
Returns the current value for |content_type| that applies for the specified URLs. More... | |
virtual void | SetContentSetting (const CefString &requesting_url, const CefString &top_level_url, cef_content_setting_types_t content_type, cef_content_setting_values_t value)=0 |
Sets the current value for |content_type| for the specified URLs in the default scope. More... | |
![]() | |
virtual bool | HasPreference (const CefString &name)=0 |
Returns true if a preference with the specified |name| exists. More... | |
virtual CefRefPtr< CefValue > | GetPreference (const CefString &name)=0 |
Returns the value for the preference with the specified |name|. More... | |
virtual CefRefPtr< CefDictionaryValue > | GetAllPreferences (bool include_defaults)=0 |
Returns all preferences as a dictionary. More... | |
virtual bool | CanSetPreference (const CefString &name)=0 |
Returns true if the preference with the specified |name| can be modified using SetPreference. More... | |
virtual bool | SetPreference (const CefString &name, CefRefPtr< CefValue > value, CefString &error)=0 |
Set the |value| associated with preference |name|. More... | |
![]() | |
virtual void | AddRef () const =0 |
Called to increment the reference count for the object. More... | |
virtual bool | Release () const =0 |
Called to decrement the reference count for the object. More... | |
virtual bool | HasOneRef () const =0 |
Returns true if the reference count is 1. More... | |
virtual bool | HasAtLeastOneRef () const =0 |
Returns true if the reference count is at least 1. More... | |
Static Public Member Functions | |
static CefRefPtr< CefRequestContext > | GetGlobalContext () |
Returns the global context object. More... | |
static CefRefPtr< CefRequestContext > | CreateContext (const CefRequestContextSettings &settings, CefRefPtr< CefRequestContextHandler > handler) |
Creates a new context object with the specified |settings| and optional |handler|. More... | |
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|. More... | |
![]() | |
static CefRefPtr< CefPreferenceManager > | GetGlobalPreferenceManager () |
Returns the global preference manager object. More... | |
Additional Inherited Members | |
![]() | |
virtual | ~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.
|
pure virtual |
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.
|
pure virtual |
Clears all HTTP authentication credentials that were added as part of handling GetAuthCredentials.
If |callback| is non-NULL it will be executed on the UI thread after completion.
|
pure virtual |
Clear all registered scheme handler factories.
Returns false on error. This function may be called on any thread in the browser process.
|
pure virtual |
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.
|
static |
Creates a new context object that shares storage with |other| and uses an optional |handler|.
|
static |
Creates a new context object with the specified |settings| and optional |handler|.
|
pure virtual |
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.
|
pure virtual |
Returns the cache path for this object.
If empty an "incognito mode" in-memory cache is being used.
|
pure virtual |
Returns the current value for |content_type| that applies for the specified URLs.
If both URLs are empty the default value will be returned. Returns CEF_CONTENT_SETTING_VALUE_DEFAULT if no value is configured. Must be called on the browser process UI thread.
|
pure virtual |
Returns the cookie manager for this object.
If |callback| is non-NULL it will be executed asnychronously on the UI thread after the manager's storage has been initialized.
|
pure virtual |
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.
|
pure virtual |
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.
|
static |
Returns the global context object.
|
pure virtual |
Returns the handler for this context if any.
|
pure virtual |
Returns the MediaRouter object associated with this context.
If |callback| is non-NULL it will be executed asnychronously on the UI thread after the manager's context has been initialized.
|
pure virtual |
Returns the current value for |content_type| that applies for the specified URLs.
If both URLs are empty the default value will be returned. Returns nullptr if no value is configured. Must be called on the browser process UI thread.
|
pure virtual |
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.
|
pure virtual |
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.
|
pure virtual |
Returns true if this object is pointing to the same context as |that| object.
|
pure virtual |
Returns true if this object is sharing the same storage as |that| object.
|
pure virtual |
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://<extension_id>/<path>".
Browsers that host extensions differ from normal browsers as follows:
See https://developer.chrome.com/extensions for extension implementation and usage documentation.
|
pure virtual |
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.
|
pure virtual |
Attempts to resolve |origin| to a list of associated IP addresses.
|callback| will be executed on the UI thread after completion.
|
pure virtual |
Sets the current value for |content_type| for the specified URLs in the default scope.
If both URLs are empty, and the context is not incognito, the default value will be set. Pass CEF_CONTENT_SETTING_VALUE_DEFAULT for |value| to use the default value for this content type.
WARNING: Incorrect usage of this method may cause instability or security issues in Chromium. Make sure that you first understand the potential impact of any changes to |content_type| by reviewing the related source code in Chromium. For example, if you plan to modify CEF_CONTENT_SETTING_TYPE_POPUPS, first review and understand the usage of ContentSettingsType::POPUPS in Chromium: https://source.chromium.org/search?q=ContentSettingsType::POPUPS
|
pure virtual |
Sets the current value for |content_type| for the specified URLs in the default scope.
If both URLs are empty, and the context is not incognito, the default value will be set. Pass nullptr for |value| to remove the default value for this content type.
WARNING: Incorrect usage of this method may cause instability or security issues in Chromium. Make sure that you first understand the potential impact of any changes to |content_type| by reviewing the related source code in Chromium. For example, if you plan to modify CEF_CONTENT_SETTING_TYPE_POPUPS, first review and understand the usage of ContentSettingsType::POPUPS in Chromium: https://source.chromium.org/search?q=ContentSettingsType::POPUPS