Class: LensExtension<Dependencies>

Common.LensExtension

Type parameters

Name	Type
Dependencies	extends LensExtensionDependencies = LensExtensionDependencies

Hierarchy

• LensExtension

↳ LensExtension

↳ LensExtension

Implements

• LegacyLensExtension

Table of contents

Constructors

• constructor

Properties

• id
• isBundled
• manifest
• manifestPath
• protocolHandlers

Accessors

• description
• isEnabled
• name
• sanitizedExtensionId
• storeName
• version

Methods

• activate
• disable
• enable
• getExtensionFileFolder
• onActivate
• onDeactivate

Constructors

constructor

• new LensExtension<Dependencies>(«destructured»)

Type parameters

Name	Type
Dependencies	extends LensExtensionDependencies = LensExtensionDependencies

Parameters

Name	Type
«destructured»	InstalledExtension

Properties

id

• Readonly id: string

Implementation of

LegacyLensExtension.id

---

isBundled

• Readonly isBundled: boolean

Implementation of

LegacyLensExtension.isBundled

---

manifest

• Readonly manifest: LensExtensionManifest

Implementation of

LegacyLensExtension.manifest

---

manifestPath

• Readonly manifestPath: string

Implementation of

LegacyLensExtension.manifestPath

---

protocolHandlers

• protocolHandlers: ProtocolHandlerRegistration[]

Accessors

description

• get description(): undefined | string

Returns

undefined | string

Implementation of

LegacyLensExtension.description

---

isEnabled

• get isEnabled(): boolean

Returns

boolean

---

name

• get name(): string

Returns

string

Implementation of

LegacyLensExtension.name

---

sanitizedExtensionId

• get sanitizedExtensionId(): string

Returns

string

Implementation of

LegacyLensExtension.sanitizedExtensionId

---

storeName

• get storeName(): string

Returns

string

Implementation of

LegacyLensExtension.storeName

---

version

• get version(): string

Returns

string

Implementation of

LegacyLensExtension.version

Methods

activate

▸ activate(): Promise<void>

Returns

Promise<void>

Implementation of

LegacyLensExtension.activate

---

disable

▸ disable(): Promise<void>

Returns

Promise<void>

Implementation of

LegacyLensExtension.disable

---

enable

▸ enable(): Promise<void>

Returns

Promise<void>

Implementation of

LegacyLensExtension.enable

---

getExtensionFileFolder

▸ getExtensionFileFolder(): Promise<string>

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 obfuscation of the folder name.

Returns

Promise<string>

Implementation of

LegacyLensExtension.getExtensionFileFolder

---

onActivate

▸ Protected onActivate(): void | Promise<void>

Returns

void | Promise<void>

---

onDeactivate

▸ Protected onDeactivate(): void | Promise<void>

Returns

void | Promise<void>