Skip to main content

Interface: IExtension

model.IExtension

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

Table of contents

Properties

Methods

Properties

categories

Optional categories: IExtensionType[]

The categories of extension

Defined in

src/model/extension.ts:74


contributes

Optional contributes: IContribute

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

Defined in

src/model/extension.ts:83


description

Optional description: string

The description of extension

Defined in

src/model/extension.ts:95


disable

Optional disable: boolean

Whether disable current extension, the extension default status is enable

Defined in

src/model/extension.ts:107


displayName

Optional displayName: string

The display name of extension

Defined in

src/model/extension.ts:66


extensionKind

Optional extensionKind: IExtensionType[]

The kind of extension

Defined in

src/model/extension.ts:78


icon

Optional icon: string | Element

The Icon of extension

Defined in

src/model/extension.ts:91


id

id: UniqueId

The ID of extension required

Defined in

src/model/extension.ts:58


main

Optional main: string

The entry of extension

Defined in

src/model/extension.ts:87


name

name: string

The name of extension

Defined in

src/model/extension.ts:62


path

Optional path: string

The path of extension

Defined in

src/model/extension.ts:103


publisher

Optional publisher: string

The publisher of extension

Defined in

src/model/extension.ts:99


version

Optional version: string

The version of extension

Defined in

src/model/extension.ts:70

Methods

activate

activate(appContext, extensionContext): void

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

Parameters

NameTypeDescription
appContextAppContextThe application context
extensionContextExtensionContextThe extension context

Returns

void

Defined in

src/model/extension.ts:115


dispose

dispose(appContext): void

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

Parameters

NameTypeDescription
appContextAppContextThe application context

Returns

void

Defined in

src/model/extension.ts:121