feat(docs): autocapture for iOS #9783
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
contents/docs/integrate/send-events/_snippets/send-events-ios.mdx
Outdated
Show resolved
Hide resolved
Co-authored-by: Manoel Aranda Neto <5731772+marandaneto@users.noreply.github.com>
|
@marandaneto reworked this a bit. I decided skip to include just a single config for now @ivanagas I moved everything to |
| To exclude specific UI elements from Autocapture, add `ph-no-capture` as either an `accessibilityLabel` or `accessibilityIdentifier`. When Autocapture detects this label or identifier anywhere in the view hierarchy, the event will be ignored: | ||
|
|
||
| ```swift | ||
| // This view will be excluded from Autocapture | ||
| let view = UIView() | ||
| view.accessibilityLabel = "ph-no-capture" | ||
| ``` | ||
|
|
||
| > **Important:** By default, PostHog automatically excludes fields detected as sensitive, even without the `ph-no-capture` tag. These include password fields, credit card fields, OTP fields, and any other fields related to Personally Identifiable Information (PII). |
There was a problem hiding this comment.
does the autocapture reuse the checks from session replay? just to be sure this is here in this section and it works for captureElementInteractions as well
There was a problem hiding this comment.
Yeah, that's why I didn't move this inside Autocapture specifically.
Maybe we can change to "To exclude specific UI elements from Autocapture or Session replay ..."
There was a problem hiding this comment.
Also, not sure about the strong disclaimer at the bottom. Maybe we can reword to something like "By default, PostHog makes a best effort to automatically exclude..."?
There was a problem hiding this comment.
we already have posthog.com/contents/docs/session-replay/_snippets/ios-privacy.mdx btw, maybe consider improving that area and linking it back here if possible?
i think there are other areas of the docs mentioning about the ph no capture and what is automatically masked already
There was a problem hiding this comment.
Yeah, we also mention this in posthog.com/contents/tutorials/ios-session-replay.mdx as well. I think since this is not specific to session replay anymore, we can link the other way around. Include this in library docs and link back from session replay?
There was a problem hiding this comment.
I'll merge this PR though to get the docs out, then follow up with a fix for tutorials and ios-privacy
left a few comments, I think you forgot to update a few parts of the docs after removing the |
Co-authored-by: Ian Vanagas <34755028+ivanagas@users.noreply.github.com>
Thank you @ivanagas! I misread the template and thought the complete opposite actually for some reason. I'll keep this in mind for future PRs |
* feat(docs): autocapture for iOS * feat(docs): iOS autocapture docs * Update contents/docs/libraries/ios/index.mdx Co-authored-by: Manoel Aranda Neto <5731772+marandaneto@users.noreply.github.com> * feat(docs): reworked iOS autocapture docs * Apply suggestions from code review Co-authored-by: Ian Vanagas <34755028+ivanagas@users.noreply.github.com> * fix: remove disabling autocapture section * fix: rework all configuration options section * fix: improve preventing sensitive data capture section * fix: reword --------- Co-authored-by: Manoel Aranda Neto <5731772+marandaneto@users.noreply.github.com> Co-authored-by: Ian Vanagas <34755028+ivanagas@users.noreply.github.com>
Changes
Added iOS documentation for Autocapture feature
Relates to: PostHog/posthog-ios#224
Useful resources