Skip to main content
Version: 1.x

Interface: IExtension

molecule.model.IExtension

The interface of extension, there need every extension to implement this interface

Properties

categories

Optional categories: IExtensionType[]

The categories of extension

Defined in

model/extension.ts:61


contributes

Optional contributes: IContribute

The main file path of extension Extension system will load the extension by this file

Defined in

model/extension.ts:70


description

Optional description: string

The description of extension

Defined in

model/extension.ts:82


disable

Optional disable: boolean

Whether disable current extension, the extension default status is enable

Defined in

model/extension.ts:94


displayName

Optional displayName: string

The display name of extension

Defined in

model/extension.ts:53


extensionKind

Optional extensionKind: IExtensionType[]

The kind of extension

Defined in

model/extension.ts:65


icon

Optional icon: string | Element

The Icon of extension

Defined in

model/extension.ts:78


id

id: UniqueId

The ID of extension required

Defined in

model/extension.ts:45


main

Optional main: string

The entry of extension

Defined in

model/extension.ts:74


name

name: string

The name of extension

Defined in

model/extension.ts:49


path

Optional path: string

The path of extension

Defined in

model/extension.ts:90


publisher

Optional publisher: string

The publisher of extension

Defined in

model/extension.ts:86


version

Optional version: string

The version of extension

Defined in

model/extension.ts:57

Methods

activate

activate(extensionCtx): void

Do something you want when the Extension is activating. The ExtensionService will call the activate method after added the Extension instance.

Parameters

NameTypeDescription
extensionCtxIExtensionServiceThe Context of Extension instance

Returns

void

Defined in

model/extension.ts:101


dispose

dispose(extensionCtx): void

Do something when the Extension disposing. For example, you can recover the UI state, or remove the Objects in memory.

Parameters

NameTypeDescription
extensionCtxIExtensionServiceThe Context of Extension instance

Returns

void

Defined in

model/extension.ts:107