Class DefaultOpenerService

OpenerService provide an access to existing openers.

Implements

OpenerService

Index

Constructors

Properties

customEditorOpenHandlers handlersProvider onDidChangeOpeners onDidChangeOpenersEmitter

Methods

addHandler getHandlers getOpener getOpeners prioritize removeHandler

Constructors

constructor

new DefaultOpenerService(handlersProvider): DefaultOpenerService
Parameters
- handlersProvider: ContributionProvider<OpenHandler>
Returns DefaultOpenerService
- Defined in packages/core/src/browser/opener-service.ts:120

Properties

`Protected` `Readonly` customEditorOpenHandlers

customEditorOpenHandlers: OpenHandler[] = []

`Protected` `Readonly` handlersProvider

handlersProvider: ContributionProvider<OpenHandler>

`Readonly` onDidChangeOpeners

onDidChangeOpeners: Event<void> = ...

Event that fires when a new opener is added or removed.

`Protected` `Readonly` onDidChangeOpenersEmitter

onDidChangeOpenersEmitter: Emitter<void> = ...

Methods

addHandler

addHandler(openHandler): Disposable
Add open handler i.e. for custom editors
Parameters
- openHandler: OpenHandler
Returns Disposable
Implementation of OpenerService.addHandler
- Defined in packages/core/src/browser/opener-service.ts:125

`Protected` getHandlers

getHandlers(): OpenHandler[]
Returns OpenHandler[]
- Defined in packages/core/src/browser/opener-service.ts:162

getOpener

getOpener(uri, options?): Promise<OpenHandler>
Return an opener with the higher priority for the given URI. Reject if such does not exist.
Parameters
- uri: URI
- Optional options: OpenerOptions
Returns Promise<OpenHandler>
Implementation of OpenerService.getOpener
- Defined in packages/core/src/browser/opener-service.ts:139

getOpeners

getOpeners(uri?, options?): Promise<OpenHandler[]>
Return all registered openers. Never reject.
Parameters
- Optional uri: URI
- Optional options: OpenerOptions
Returns Promise<OpenHandler[]>
Implementation of OpenerService.getOpeners
- Defined in packages/core/src/browser/opener-service.ts:147

`Protected` prioritize

prioritize(uri, options?): Promise<OpenHandler[]>
Parameters
- uri: URI
- Optional options: OpenerOptions
Returns Promise<OpenHandler[]>
- Defined in packages/core/src/browser/opener-service.ts:151

removeHandler

removeHandler(openHandler): void
Remove open handler
Parameters
- openHandler: OpenHandler
Returns void
Implementation of OpenerService.removeHandler
- Defined in packages/core/src/browser/opener-service.ts:134