Class: LensMainExtension#
Hierarchy#
- LensExtension
↳ LensMainExtension
Index#
Constructors#
Properties#
Accessors#
Methods#
- addCatalogSource
- disable
- enable
- getExtensionFileFolder
- navigate
- onActivate
- onDeactivate
- removeCatalogSource
- toggle
- whenEnabled
Constructors#
constructor#
+ new LensMainExtension(__namedParameters: object): LensMainExtension
Inherited from LensMainExtension.constructor
Defined in src/extensions/lens-extension.ts:52
Parameters:
▪ __namedParameters: object
| Name | Type |
|---|---|
id |
string |
isBundled |
boolean |
manifest |
LensExtensionManifest |
manifestPath |
string |
Returns: LensMainExtension
Properties#
[Disposers]#
• [Disposers]: function & Extendable‹function› = disposer()
Inherited from LensMainExtension.[Disposers]
Defined in src/extensions/lens-extension.ts:52
appMenus#
• appMenus: MenuRegistration[] = []
Defined in src/extensions/lens-main-extension.ts:31
id#
• id: LensExtensionId
Inherited from LensMainExtension.id
Defined in src/extensions/lens-extension.ts:44
isBundled#
• isBundled: boolean
Inherited from LensMainExtension.isBundled
Defined in src/extensions/lens-extension.ts:47
manifest#
• manifest: LensExtensionManifest
Inherited from LensMainExtension.manifest
Defined in src/extensions/lens-extension.ts:45
manifestPath#
• manifestPath: string
Inherited from LensMainExtension.manifestPath
Defined in src/extensions/lens-extension.ts:46
protocolHandlers#
• protocolHandlers: ProtocolHandlerRegistration[] = []
Inherited from LensMainExtension.protocolHandlers
Defined in src/extensions/lens-extension.ts:49
Accessors#
description#
• get description(): string
Inherited from LensMainExtension.description
Defined in src/extensions/lens-extension.ts:70
Returns: string
name#
• get name(): string
Inherited from LensMainExtension.name
Defined in src/extensions/lens-extension.ts:62
Returns: string
version#
• get version(): string
Inherited from LensMainExtension.version
Defined in src/extensions/lens-extension.ts:66
Returns: string
Methods#
addCatalogSource#
▸ addCatalogSource(id: string, source: IObservableArray‹CatalogEntity›): void
Defined in src/extensions/lens-main-extension.ts:44
Parameters:
| Name | Type |
|---|---|
id |
string |
source |
IObservableArray‹CatalogEntity› |
Returns: void
disable#
▸ disable(): Promise‹void›
Inherited from LensMainExtension.disable
Defined in src/extensions/lens-extension.ts:94
Returns: Promise‹void›
enable#
▸ enable(): Promise‹void›
Inherited from LensMainExtension.enable
Defined in src/extensions/lens-extension.ts:86
Returns: Promise‹void›
getExtensionFileFolder#
▸ getExtensionFileFolder(): Promise‹string›
Inherited from LensMainExtension.getExtensionFileFolder
Defined in src/extensions/lens-extension.ts:81
getExtensionFileFolder returns the path to an already created folder. This folder is for the sole use of this extension.
Note: there is no security done on this folder, only obfiscation of the folder name.
Returns: Promise‹string›
navigate#
▸ navigate‹P›(pageId?: string, params?: P, frameId?: number): Promise‹void›
Defined in src/extensions/lens-main-extension.ts:33
Type parameters:
▪ P: object
Parameters:
| Name | Type |
|---|---|
pageId? |
string |
params? |
P |
frameId? |
number |
Returns: Promise‹void›
Protected onActivate#
▸ onActivate(): void
Inherited from LensMainExtension.onActivate
Defined in src/extensions/lens-extension.ts:134
Returns: void
Protected onDeactivate#
▸ onDeactivate(): void
Inherited from LensMainExtension.onDeactivate
Defined in src/extensions/lens-extension.ts:138
Returns: void
removeCatalogSource#
▸ removeCatalogSource(id: string): void
Defined in src/extensions/lens-main-extension.ts:48
Parameters:
| Name | Type |
|---|---|
id |
string |
Returns: void
toggle#
▸ toggle(enable?: boolean): void
Inherited from LensMainExtension.toggle
Defined in src/extensions/lens-extension.ts:102
Parameters:
| Name | Type |
|---|---|
enable? |
boolean |
Returns: void
whenEnabled#
▸ whenEnabled(handlers: function): Promise‹(Anonymous function)›
Inherited from LensMainExtension.whenEnabled
Defined in src/extensions/lens-extension.ts:110
Parameters:
▪ handlers: function
▸ (): Promise‹Function[]›
Returns: Promise‹(Anonymous function)›