Skip to content

android replay not experimental #12250

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 6, 2025
Merged

android replay not experimental #12250

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 7 additions & 10 deletions docs/platforms/android/session-replay/privacy/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,8 @@ By default, our Session Replay SDK masks all text content, images, webviews, and
To disable the default masking behavior (not to be used on applications with sensitive data):

```kotlin
options.experimental.sessionReplay.maskAllText = false
options.experimental.sessionReplay.maskAllImages = false
// if you're on version < 7.15.0
// options.experimental.sessionReplay.redactAllText = false
// options.experimental.sessionReplay.redactAllImages = false
options.sessionReplay.maskAllText = false
options.sessionReplay.maskAllImages = false
```

```XML {filename:AndroidManifest.xml}
Expand All @@ -34,7 +31,7 @@ options.experimental.sessionReplay.maskAllImages = false
|![session replay unmasked](./img/session-replay.jpg) |![session replay masked](./img/session-replay-redacted.jpg) |


_Make sure your Sentry Android SDK version is at least 7.15.0._
_Make sure your Sentry Android SDK version is at least 7.20.0._

## Mask by View Class

Expand All @@ -47,8 +44,8 @@ Let's say you have:
You can set the options like this:

```kotlin
options.experimental.sessionReplay.addMaskViewClass("com.example.MyCustomView")
options.experimental.sessionReplay.addUnmaskViewClass("com.example.MyCustomTextView")
options.sessionReplay.addMaskViewClass("com.example.MyCustomView")
options.sessionReplay.addUnmaskViewClass("com.example.MyCustomTextView")
```

<Note>
Expand All @@ -62,8 +59,8 @@ If you're using a code obfuscation tool (R8/ProGuard), adjust your proguard rule
The masking behavior applies to classes and their subclasses. This means if you add a view via `addMaskViewClass` (for example, `TextView`, which is the default behavior), its respective subclasses (`RadioButton`, `CheckBox`, `EditText`, and so on) will also be masked. For example, you can do the following:

```kotlin
options.experimental.sessionReplay.addMaskViewClass("android.widget.TextView") // mask TextView and all its subclasses
options.experimental.sessionReplay.addUnmaskViewClass("android.widget.RadioButton") // but unmask RadioButton and all its subclasses
options.sessionReplay.addMaskViewClass("android.widget.TextView") // mask TextView and all its subclasses
options.sessionReplay.addUnmaskViewClass("android.widget.RadioButton") // but unmask RadioButton and all its subclasses
```

## Mask by View Instance
Expand Down
Loading