Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Please note, this document is in an early draft form. It’s primary purpose is to discover how we will define APIs, rather than discover the detail of a specific API method. In other words, now is not the time to ask “Why doesn’t it support xyz?”, however, it is a good time to ask “If we were to add xyz, where would it live?”

Background


The purpose of the ScreenSnippet API is to allow a user to take screenshots API Design Principles

Our general principles are as follows:

Prior Art Example

Minuet ScreenSnippet API used in Symphony

SSF ScreenSnippet API

The ScreenSnippet API is used to capture a snippet of their desktop (unconstrained by the host application window) , and highlight portions of the captured image and then share the output with their this snippet so it can then be consumed by the host application.  This functionality is similar to the Windows Screen Snippet tool that lets a user captures portions of the Windows Desktop, highlight aspects of the image and then save this image for sharing.

This functionality differs from the Electron BrowserWindow.capturePage API in that Electron is restricted in that it can only capture content from the host application and does not provide any annotation functionality.

API Design Principles

Our general principles are as follows:

Prior Art

Our general principles are as follows:The exact visual style and the extent of the OS-level integration is container dependent and hence out-of-scope of this specification.


Constructor


Notification()


Creates a new instance of the Notification object.