Chromium Embedded Framework (CEF)  109.0.1+gcd5e37a+chromium-109.0.5414.8
CefExtension Class Referenceabstract

Object representing an extension. More...

#include "include/cef_extension.h"

Inheritance diagram for CefExtension:
CefBaseRefCounted

Public Member Functions

virtual CefString GetIdentifier ()=0
 Returns the unique extension identifier. More...
 
virtual CefString GetPath ()=0
 Returns the absolute path to the extension directory on disk. More...
 
virtual CefRefPtr< CefDictionaryValueGetManifest ()=0
 Returns the extension manifest contents as a CefDictionaryValue object. More...
 
virtual bool IsSame (CefRefPtr< CefExtension > that)=0
 Returns true if this object is the same extension as |that| object. More...
 
virtual CefRefPtr< CefExtensionHandlerGetHandler ()=0
 Returns the handler for this extension. More...
 
virtual CefRefPtr< CefRequestContextGetLoaderContext ()=0
 Returns the request context that loaded this extension. More...
 
virtual bool IsLoaded ()=0
 Returns true if this extension is currently loaded. More...
 
virtual void Unload ()=0
 Unload this extension if it is not an internal extension and is currently loaded. More...
 
- Public Member Functions inherited from CefBaseRefCounted
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...
 

Additional Inherited Members

- Protected Member Functions inherited from CefBaseRefCounted
virtual ~CefBaseRefCounted ()
 

Detailed Description

Object representing an extension.

Methods may be called on any thread unless otherwise indicated.

Member Function Documentation

◆ GetHandler()

virtual CefRefPtr<CefExtensionHandler> CefExtension::GetHandler ( )
pure virtual

Returns the handler for this extension.

Will return NULL for internal extensions or if no handler was passed to CefRequestContext::LoadExtension.

◆ GetIdentifier()

virtual CefString CefExtension::GetIdentifier ( )
pure virtual

Returns the unique extension identifier.

This is calculated based on the extension public key, if available, or on the extension path. See https://developer.chrome.com/extensions/manifest/key for details.

◆ GetLoaderContext()

virtual CefRefPtr<CefRequestContext> CefExtension::GetLoaderContext ( )
pure virtual

Returns the request context that loaded this extension.

Will return NULL for internal extensions or if the extension has been unloaded. See the CefRequestContext::LoadExtension documentation for more information about loader contexts. Must be called on the browser process UI thread.

◆ GetManifest()

virtual CefRefPtr<CefDictionaryValue> CefExtension::GetManifest ( )
pure virtual

Returns the extension manifest contents as a CefDictionaryValue object.

See https://developer.chrome.com/extensions/manifest for details.

◆ GetPath()

virtual CefString CefExtension::GetPath ( )
pure virtual

Returns the absolute path to the extension directory on disk.

This value will be prefixed with PK_DIR_RESOURCES if a relative path was passed to CefRequestContext::LoadExtension.

◆ IsLoaded()

virtual bool CefExtension::IsLoaded ( )
pure virtual

Returns true if this extension is currently loaded.

Must be called on the browser process UI thread.

◆ IsSame()

virtual bool CefExtension::IsSame ( CefRefPtr< CefExtension that)
pure virtual

Returns true if this object is the same extension as |that| object.

Extensions are considered the same if identifier, path and loader context match.

◆ Unload()

virtual void CefExtension::Unload ( )
pure virtual

Unload this extension if it is not an internal extension and is currently loaded.

Will result in a call to CefExtensionHandler::OnExtensionUnloaded on success.


The documentation for this class was generated from the following file: