Update iOS Session Replay Docs for GA #1952
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jaredmixpanel
requested review from
ishamehramixpanel
and removed request for
a team
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this comment.
Pull Request Overview
This pull request updates the iOS Session Replay documentation to reflect the SDK's General Availability (GA) release, removing beta program disclaimers and updating API references to match the latest SDK version. The documentation has been significantly restructured to improve clarity and provide comprehensive guidance for developers implementing session replay functionality.
- Removed all beta program warnings and disclaimers since the feature is now generally available
- Updated SDK API references including configuration parameter names and initialization patterns
- Added new functionality documentation for manual screenshot capture, identity management, and manual flushing
pages/docs/session-replay/implement-session-replay/session-replay-ios.mdx
Outdated
Show resolved
Hide resolved
pages/docs/session-replay/implement-session-replay/session-replay-ios.mdx
Outdated
Show resolved
Hide resolved
pages/docs/session-replay/implement-session-replay/session-replay-ios.mdx
Show resolved
Hide resolved
Co-authored-by: Copilot <[email protected]>
myronkaifung
approved these changes
Jul 17, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request updates the iOS Session Replay documentation to reflect changes in the SDK's API, improve clarity, and provide additional guidance for developers. Key updates include the removal of outdated beta program disclaimers, adjustments to configuration options, and the addition of new features such as manual screenshot capture and identity management.
Updates to SDK API and Configuration
recordSessionsPercentwithautoStartRecordingSessionsPercentinMPSessionReplayConfigto reflect changes in sampling behavior. Recording now starts automatically if the sampling check passes. [1] [2]autoStartRecording,flushInterval, andenableLogging. Updated default values forautoMaskedViewsto include.map.enableLogginginMPSessionReplayConfiginstead of settingloggingEnabledon the instance.Enhancements to Documentation Clarity
autoStartRecordingis enabled by default. [1] [2]New Features and Examples
.captureScreenshot()and.captureScreenshot(withTouchEvent:)..identify(distinctId:)to update the user ID dynamically..flush().Privacy and Masking Updates
UITextFieldinputs are always masked and cannot be unmasked, while other elements likeUILabelandMKMapViewcan be unmasked usingautoMaskedViews.mpReplaySensitiveto emphasize its use for marking views as "sensitive" or "safe."