<div align='center'>

<br />

<img src='https://raw.githubusercontent.com/eclipse-theia/theia/master/logo/theia.svg?sanitize=true' alt='theia-ext-logo' width='100px' />

<h2>ECLIPSE THEIA - API SAMPLES</h2>

<hr />

</div>

## Description

The `@theia/api-samples` extension contains programming examples on how to use internal APIs.
The purpose of the extension is to:

- provide developers with real-world coding examples using internal APIs, dependency injection, etc.
- provide easy-to-use and test examples for features when reviewing pull-requests.

The extension is for reference and test purposes only and is not published on `npm` (`private: true`).

### Telemetry sample

The **Telemetry Samples** command category demonstrates reporting events from the frontend to the `sample/console` backend sink. Set `telemetry.telemetryLevel` to `all`, run the started and completed commands, and inspect the backend log for the topic, kind, session, timestamp, and payload. The completed command reports an `error` event with attributes. The `sample/other` event is intentionally outside the sink's interests.

Set `telemetry.telemetryLevel` to `off` to suppress the remote sink, or set `"telemetry.filters": { "sample/console": [] }` to disable it explicitly.

### Sample mock OpenVSX server

These samples contain a mock implementation of an OpenVSX server. This is done
for testing purposes only. It is currently hosted at
`<backend-host>/mock-open-vsx/api/...`.

## Additional Information

- [Theia - GitHub](https://github.com/eclipse-theia/theia)
- [Theia - Website](https://theia-ide.org/)

## License

- [Eclipse Public License 2.0](http://www.eclipse.org/legal/epl-2.0/)
- [一 (Secondary) GNU General Public License, version 2 with the GNU Classpath Exception](https://projects.eclipse.org/license/secondary-gpl-2.0-cp)

## Trademark

"Theia" is a trademark of the Eclipse Foundation
<https://www.eclipse.org/theia>
