You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|`api-version`| string | no | Protocol version (e.g., `"1.0"`). Ensures compatibility with future enhancements. | Latest version |
58
-
|`user-agent`| string | yes | Identifier for the calling application, used for logging and analytics. | n/a |
59
-
|`x-request-correlation-id`| string | no | Unique identifier for requests, allowing reference to a particular transaction or event chain. | Generated GUID if not provided. |
60
-
|`host`| string (enum) | yes | Specifies the **Snipping Tool action** to perform. Supported values: <br>- `capture` – Opens Snipping Tool to take a screenshot or recording. <br>- `discover` – Queries supported features. |`capture`|
61
-
|`path`| string (enum) | yes | Specifies the **type of media** being captured: <br>- `image` – Screenshot capture. <br>- `video` – Screen recording. | n/a |
62
-
|`enabledModes`| string (list) | no | Controls which snipping or recording modes are **enabled** in the UI. <br> - `RectangleSnip` <br> - `WindowSnip` <br> - `FreeformSnip` <br> - `RectangleRecord` <br> - `SnippingAllModes` (all image modes) <br> - `RecordAllModes` (all recording modes) <br> - `All` (all supported modes) | Defaults to the mode specified in the URI (`path`) |
63
-
|`auto-save`| boolean | no | Determines if the captured **Screenshot or Recording**should be **automatically saved** to the user's device. If `false`, the file is stored temporarily for retrieval via a token. |`false`|
64
-
|`redirect-uri`| URI | yes | Callback URI where the **Snipping Tool response** will be sent. Applications must register a handler for this protocol.| n/a |
|`api-version`| string | no | Protocol version (e.g., `"1.0"`). Ensures compatibility with future enhancements. | Latest version |
58
+
|`user-agent`| string | yes | Identifier for the calling application, used for logging and analytics. | n/a |
59
+
|`x-request-correlation-id`| string | no | Unique identifier for requests, allowing reference to a particular transaction or event chain. | Generated GUID if not provided. |
60
+
|`host`| string (enum) | yes | Specifies the **Snipping Tool action** to perform. Supported values: <br>- `capture` – Opens Snipping Tool to take a screenshot or recording. <br>- `discover` – Queries supported features. |`capture`|
61
+
|`path`| string (enum) | yes | Specifies the **type of media** being captured: <br>- `image` – Screenshot capture. <br>- `video` – Screen recording. | n/a |
62
+
|`enabledModes`| string (list) | no | Controls which snipping or recording modes are **enabled** in the UI. <br> - `RectangleSnip` <br> - `WindowSnip` <br> - `FreeformSnip` <br> - `RectangleRecord` <br> - `SnippingAllModes` (all image modes) <br> - `RecordAllModes` (all recording modes) <br> - `All` (all supported modes) | Defaults to the mode specified in the URI (`path`) |
63
+
|`auto-save`| boolean | no | Determines whether the captured **Screenshot or Recording**is automatically saved to the user's device. If set to `false`, the file is stored temporarily and can only be accessed using the token provided in the response. <br> **Note:** The screenshot or recording will only be automatically saved if the user has enabled the corresponding settings: <br> - **"Automatically save original screenshots"** for screenshots. <br> - **"Automatically save original screen recordings"** for recordings.|`false`|
64
+
|`redirect-uri`| URI | yes | Callback URI where the response will be sent. The calling application must register a handler for this protocol to receive and process the response. | n/a |
0 commit comments