Skip to content
This repository was archived by the owner on Aug 14, 2024. It is now read-only.

Commit 0470d6d

Browse files
authored
feat: Update screenshot feature detail (#563)
1 parent 59ea5e6 commit 0470d6d

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

src/docs/sdk/features.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -143,15 +143,17 @@ useful because attachments could quickly eat up the users' disk space. Furthermo
143143

144144
## Screenshots
145145

146-
When the user opts-in, if technically possible, take a screenshot of the application and include as an [attachment](#attachments) to the [envelope](/sdk/envelopes/) with the event.
146+
When the user opts-in, if technically possible, take a screenshot of the application during a crash or error and include it as an [attachment](#attachments) to the [envelope](/sdk/envelopes/) with the event.
147147

148148
This feature only applies to SDKs with a user interface, such as Mobile and Desktop.
149149
In some environments such as native iOS, taking a screenshot requires the UI thread and in the event of a crash, that might not be available. So inherently this feature will be a best effort solution.
150+
Also, some environments don`t allow access to the UI or some features during a hard crash, iOS, for example, doesn't allow running Objective-C code after a signal break, therefore no hard crash screenshot capture will be possible.
150151
It's advised to provide this feature through a single option called `attachScreenshot`. That's the preferred way but in platforms such as Flutter, a wrapping widget is required so documentation can point users to that instead of the suggested option name.
151152

152153
The feature is achieved by adding an attachment with:
153154

154-
* File name `screenshot.jpg` or `screenshot.png`
155+
* File name `screenshot.jpg` or `screenshot.png`
156+
* Subsequent screenshots in the same event should be named `screenshot-n`, where n is the screenshot number starting with 2
155157
* Image size, if possible should stay below 2 MB but quality/size could be configurable
156158
* `ContentType: image/jpg` or `ContentType: image/png`
157159

0 commit comments

Comments
 (0)