Extensions (fable-electron-docs-api)

Extensions Type

Namespace: Fable.Electron
Assembly: Fable.Electron.dll
Parent Module: Main
Base Type: obj
All Interfaces: EventEmitter

⚠ Process Availability: Main ✔ | Renderer ❌ | Utility ❌ | Exported ❌

Instance members

Instance member	Description
`this.getAllExtensions ()` Full Usage: `this.getAllExtensions ()` Returns: `Extension[]` Modifiers: inline	A list of all loaded extensions.> [!NOTE] This API cannot be called before the ready event of the app module is emitted. Returns: `Extension[]`
`this.getExtension extensionId` Full Usage: `this.getExtension extensionId` Parameters: extensionId : `string` Returns: `Option<Extension>` Modifiers: inline	The loaded extension with the given ID.> [!NOTE] This API cannot be called before the ready event of the app module is emitted. extensionId : `string` Returns: `Option<Extension>`
`this.loadExtension (path, ?options)` Full Usage: `this.loadExtension (path, ?options)` Parameters: path : `string` ?options : `Options` Returns: `Promise<Extension>` Modifiers: inline	resolves when the extension is loaded.This method will raise an exception if the extension could not be loaded. If there are warnings when installing the extension (e.g. if the extension requests an API that Electron does not support) then they will be logged to the console.Note that Electron does not support the full range of Chrome extensions APIs. See Supported Extensions APIs for more details on what is supported.Note that in previous versions of Electron, extensions that were loaded would be remembered for future runs of the application. This is no longer the case: loadExtension must be called on every boot of your app if you want the extension to be loaded.This API does not support loading packed (.crx) extensions.> [!NOTE] This API cannot be called before the ready event of the app module is emitted.> [!NOTE] Loading extensions into in-memory (non-persistent) sessions is not supported and will throw an error. path : `string` ?options : `Options` Returns: `Promise<Extension>`
`this.offExtensionLoaded handler` Full Usage: `this.offExtensionLoaded handler` Parameters: handler : `IOnExtensionLoaded -> unit` Modifiers: inline	Emitted after an extension is loaded. This occurs whenever an extension is added to the "enabled" set of extensions. This includes:* Extensions being loaded from Extensions.loadExtension.* Extensions being reloaded: * from a crash. * if the extension requested it (chrome.runtime.reload()). handler : `IOnExtensionLoaded -> unit`
`this.offExtensionLoaded handler` Full Usage: `this.offExtensionLoaded handler` Parameters: handler : `Event -> Extension -> unit` Modifiers: inline	Emitted after an extension is loaded. This occurs whenever an extension is added to the "enabled" set of extensions. This includes:* Extensions being loaded from Extensions.loadExtension.* Extensions being reloaded: * from a crash. * if the extension requested it (chrome.runtime.reload()). handler : `Event -> Extension -> unit`
`this.offExtensionReady handler` Full Usage: `this.offExtensionReady handler` Parameters: handler : `IOnExtensionReady -> unit` Modifiers: inline	Emitted after an extension is loaded and all necessary browser state is initialized to support the start of the extension's background page. handler : `IOnExtensionReady -> unit`
`this.offExtensionReady handler` Full Usage: `this.offExtensionReady handler` Parameters: handler : `Event -> Extension -> unit` Modifiers: inline	Emitted after an extension is loaded and all necessary browser state is initialized to support the start of the extension's background page. handler : `Event -> Extension -> unit`
`this.offExtensionUnloaded handler` Full Usage: `this.offExtensionUnloaded handler` Parameters: handler : `IOnExtensionUnloaded -> unit` Modifiers: inline	Emitted after an extension is unloaded. This occurs when Session.removeExtension is called. handler : `IOnExtensionUnloaded -> unit`
`this.offExtensionUnloaded handler` Full Usage: `this.offExtensionUnloaded handler` Parameters: handler : `Event -> Extension -> unit` Modifiers: inline	Emitted after an extension is unloaded. This occurs when Session.removeExtension is called. handler : `Event -> Extension -> unit`
`this.onExtensionLoaded handler` Full Usage: `this.onExtensionLoaded handler` Parameters: handler : `IOnExtensionLoaded -> unit` Modifiers: inline	Emitted after an extension is loaded. This occurs whenever an extension is added to the "enabled" set of extensions. This includes:* Extensions being loaded from Extensions.loadExtension.* Extensions being reloaded: * from a crash. * if the extension requested it (chrome.runtime.reload()). handler : `IOnExtensionLoaded -> unit`
`this.onExtensionLoaded handler` Full Usage: `this.onExtensionLoaded handler` Parameters: handler : `Event -> Extension -> unit` Modifiers: inline	Emitted after an extension is loaded. This occurs whenever an extension is added to the "enabled" set of extensions. This includes:* Extensions being loaded from Extensions.loadExtension.* Extensions being reloaded: * from a crash. * if the extension requested it (chrome.runtime.reload()). handler : `Event -> Extension -> unit`
`this.onExtensionReady handler` Full Usage: `this.onExtensionReady handler` Parameters: handler : `IOnExtensionReady -> unit` Modifiers: inline	Emitted after an extension is loaded and all necessary browser state is initialized to support the start of the extension's background page. handler : `IOnExtensionReady -> unit`
`this.onExtensionReady handler` Full Usage: `this.onExtensionReady handler` Parameters: handler : `Event -> Extension -> unit` Modifiers: inline	Emitted after an extension is loaded and all necessary browser state is initialized to support the start of the extension's background page. handler : `Event -> Extension -> unit`
`this.onExtensionUnloaded handler` Full Usage: `this.onExtensionUnloaded handler` Parameters: handler : `IOnExtensionUnloaded -> unit` Modifiers: inline	Emitted after an extension is unloaded. This occurs when Session.removeExtension is called. handler : `IOnExtensionUnloaded -> unit`
`this.onExtensionUnloaded handler` Full Usage: `this.onExtensionUnloaded handler` Parameters: handler : `Event -> Extension -> unit` Modifiers: inline	Emitted after an extension is unloaded. This occurs when Session.removeExtension is called. handler : `Event -> Extension -> unit`
`this.onceExtensionLoaded handler` Full Usage: `this.onceExtensionLoaded handler` Parameters: handler : `IOnExtensionLoaded -> unit` Modifiers: inline	Emitted after an extension is loaded. This occurs whenever an extension is added to the "enabled" set of extensions. This includes:* Extensions being loaded from Extensions.loadExtension.* Extensions being reloaded: * from a crash. * if the extension requested it (chrome.runtime.reload()). handler : `IOnExtensionLoaded -> unit`
`this.onceExtensionLoaded handler` Full Usage: `this.onceExtensionLoaded handler` Parameters: handler : `Event -> Extension -> unit` Modifiers: inline	Emitted after an extension is loaded. This occurs whenever an extension is added to the "enabled" set of extensions. This includes:* Extensions being loaded from Extensions.loadExtension.* Extensions being reloaded: * from a crash. * if the extension requested it (chrome.runtime.reload()). handler : `Event -> Extension -> unit`
`this.onceExtensionReady handler` Full Usage: `this.onceExtensionReady handler` Parameters: handler : `IOnExtensionReady -> unit` Modifiers: inline	Emitted after an extension is loaded and all necessary browser state is initialized to support the start of the extension's background page. handler : `IOnExtensionReady -> unit`
`this.onceExtensionReady handler` Full Usage: `this.onceExtensionReady handler` Parameters: handler : `Event -> Extension -> unit` Modifiers: inline	Emitted after an extension is loaded and all necessary browser state is initialized to support the start of the extension's background page. handler : `Event -> Extension -> unit`
`this.onceExtensionUnloaded handler` Full Usage: `this.onceExtensionUnloaded handler` Parameters: handler : `IOnExtensionUnloaded -> unit` Modifiers: inline	Emitted after an extension is unloaded. This occurs when Session.removeExtension is called. handler : `IOnExtensionUnloaded -> unit`
`this.onceExtensionUnloaded handler` Full Usage: `this.onceExtensionUnloaded handler` Parameters: handler : `Event -> Extension -> unit` Modifiers: inline	Emitted after an extension is unloaded. This occurs when Session.removeExtension is called. handler : `Event -> Extension -> unit`
`this.removeExtension extensionId` Full Usage: `this.removeExtension extensionId` Parameters: extensionId : `string` Modifiers: inline	Unloads an extension.> [!NOTE] This API cannot be called before the ready event of the app module is emitted. extensionId : `string`