Interface OpenHandler

OpenHandler should be implemented to provide a new opener.

interface OpenHandler {
    iconClass?: string;
    id: string;
    label?: string;
    canHandle(uri: URI, options?: OpenerOptions): MaybePromise<number>;
    open(uri: URI, options?: OpenerOptions): MaybePromise<undefined | object>;
}

Implemented by

Index

Properties

iconClass? id label?

Methods

Properties

`Optional` `Readonly`iconClass

iconClass?: string

A css icon class of this handler.

`Readonly`id

id: string

A unique id of this handler.

`Optional` `Readonly`label

label?: string

A human-readable name of this handler.

Methods

canHandle

canHandle(uri: URI, options?: OpenerOptions): MaybePromise<number>
Test whether this handler can open the given URI for given options. Return a nonzero number if this handler can open; otherwise it cannot. Never reject.

A returned value indicating a priority of this handler.
Parameters
- uri: URI
- Optionaloptions: OpenerOptions
Returns MaybePromise<number>
- Defined in packages/core/src/browser/opener-service.ts:49

open

open(uri: URI, options?: OpenerOptions): MaybePromise<undefined | object>
Open a widget for the given URI and options. Resolve to an opened widget or undefined, e.g. if a page is opened. Never reject if canHandle return a positive number; otherwise should reject.
Parameters
- uri: URI
- Optionaloptions: OpenerOptions
Returns MaybePromise<undefined | object>
- Defined in packages/core/src/browser/opener-service.ts:55