Interface OpenerService

OpenerService provide an access to existing openers.

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

Implemented by

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): Disposable
Add open handler i.e. for custom editors
Parameters
- openHandler: OpenHandler
Returns Disposable
- Defined in packages/core/src/browser/opener-service.ts:83

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>
- Defined in packages/core/src/browser/opener-service.ts:79

getOpeners

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

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

`Optional` removeHandler

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