Interface OpenerService

OpenerService provide an access to existing openers.

interface OpenerService {
    onDidChangeOpeners?: Event<void>;
    addHandler?(openHandler: OpenHandler): Disposable;
    getOpener(uri: URI, options?: OpenerOptions): Promise<OpenHandler>;
    getOpeners(): Promise<OpenHandler[]>;
    getOpeners(uri: URI, options?: OpenerOptions): Promise<OpenHandler[]>;
    removeHandler?(openHandler: OpenHandler): void;
}

Implemented by

DefaultOpenerService

Index

Properties

onDidChangeOpeners?

Methods

addHandler? getOpener getOpeners removeHandler?

Properties

`Optional`onDidChangeOpeners

onDidChangeOpeners?: Event<void>

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

Methods

`Optional`addHandler

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

getOpener

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

getOpeners

getOpeners(): Promise<OpenHandler[]>
Return all registered openers. Never reject.

Returns Promise<OpenHandler[]>
- Defined in packages/core/src/browser/opener-service.ts:67
getOpeners(uri: URI, options?: OpenerOptions): Promise<OpenHandler[]>
Return all openers able to open the given URI for given options ordered according their priority. Never reject.
Parameters
- uri: URI
- Optionaloptions: OpenerOptions
Returns Promise<OpenHandler[]>
- Defined in packages/core/src/browser/opener-service.ts:73

`Optional`removeHandler

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