From 24efec90beb0414ef81ed70215a69f88eb00e09c Mon Sep 17 00:00:00 2001 From: Tim Fish Date: Tue, 2 Aug 2022 01:39:57 +0100 Subject: [PATCH] Add `screenshot` context --- src/docs/sdk/event-payloads/contexts.mdx | 29 ++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/src/docs/sdk/event-payloads/contexts.mdx b/src/docs/sdk/event-payloads/contexts.mdx index f151c4b790..2df5de79e6 100644 --- a/src/docs/sdk/event-payloads/contexts.mdx +++ b/src/docs/sdk/event-payloads/contexts.mdx @@ -502,6 +502,35 @@ The `type` and default key is `"culture"`. : _Optional_. The timezone of the locale. For example, `Europe/Vienna`. +## Screenshot Context + +The Screenshots Context carries information about screenshots that have been included with an +event as attachments. + +The `type` and default key is `"screenshot"`. + +Each key of `screenshot` should match the filename of an attachment. An SDK can +include any additional information to helps determine the state of an windows +and which screenshot is most relevant to the event. + +Example: + +```json +{ + "contexts": { + "screenshot": { + "screenshot.png": { + "focus": true + }, + "screenshot-1.png": { + "focus": false, + "errored": true, + } + } + } +} +``` + ## Examples The following example illustrates the contexts part of the event payload and omits other attributes for simplicity.