registerUriHandler method

Disposable registerUriHandler(
  1. UriHandler handler
)

Registers a {@link UriHandleruri handler} capable of handling system-wide {@link Uriuris}. In case there are multiple windows open, the topmost window will handle the uri. A uri handler is scoped to the extension it is contributed from; it will only be able to handle uris which are directed to the extension itself. A uri must respect the following rules:

  • The uri-scheme must be vscode.env.uriScheme;
  • The uri-authority must be the extension id (e.g. my.extension);
  • The uri-path, -query and -fragment parts are arbitrary.

For example, if the my.extension extension registers a uri handler, it will only be allowed to handle uris with the prefix product-name://my.extension.

An extension can only register a single uri handler in its entire activation lifetime.

  • Note: There is an activation event onUri that fires when a uri directed for the current extension is about to be handled.

Implementation

_i4.Disposable registerUriHandler(_i4.UriHandler handler) => _i3.callMethod(
      this,
      'registerUriHandler',
      [handler],
    );