diff --git a/content/collections/session-replay/en/session-replay-android-plugin.md b/content/collections/session-replay/en/session-replay-android-plugin.md index 9e6ee1170..0bdb1aa45 100644 --- a/content/collections/session-replay/en/session-replay-android-plugin.md +++ b/content/collections/session-replay/en/session-replay-android-plugin.md @@ -5,10 +5,10 @@ title: 'Session Replay Android Plugin' landing: false exclude_from_sitemap: false updated_by: 0c3a318b-936a-4cbd-8fdf-771a90c297f0 -updated_at: 1730234452 +updated_at: 1730306282 instrumentation_guide: true platform: android -public: true +public: false parent: 467a0fe0-6ad9-4375-96a2-eea5b04a7bcf description: 'Choose this option if you use an Amplitude Android SDK to instrument your Android application.' --- @@ -56,8 +56,8 @@ The Session Replay Middleware requires that: ## Quickstart -{{partial:tabs tabs="Plugin, Middleware"}} -{{partial:tab name="Plugin"}} +{{partial:tabs tabs="Kotlin SDK, Legacy SDK"}} +{{partial:tab name="Kotlin SDK"}} Add the [latest version](https://central.sonatype.com/artifact/com.amplitude/plugin-session-replay-android/versions) of the plugin to your project dependencies. ```kotlin @@ -90,7 +90,7 @@ amplitude.add(sessionReplayPlugin) amplitude.flush() ``` {{/partial:tab}} -{{partial:tab name="Middleware"}} +{{partial:tab name="Legacy SDK"}} Add the [latest version](https://central.sonatype.com/artifact/com.amplitude/middleware-session-replay-android/versions) of the session replay middleware to your project dependencies @@ -244,7 +244,7 @@ Session Replay supports attaching to a single instance of the Amplitude SDK. If ### Captured sessions contain limited information -Session Replay requires that the Android SDK send `[Amplitude] Session Start` and `[Amplitude] Session End` events, at a minimum. If you instrument events outside of the Android SDK, Amplitude doesn't tag those events as part of the session replay. This means you can't use tools like Funnel, Segmentation, or Journeys charts to find session replays. You can find session replays with the User Sessions chart or through User Lookup. +Session Replay requires that the Android SDK send at least one event that includes Session Replay ID. If you instrument events outside of the Android SDK, Amplitude doesn't tag those events as part of the session replay. This means you can't use tools like Funnel, Segmentation, or Journeys charts to find session replays. You can find session replays with the User Sessions chart or through User Lookup. If you use a method other than the Android SDK to instrument your events, consider using the [Session Replay Standalone SDK for Android](/docs/session-replay/session-replay-android-standalone/). diff --git a/content/collections/session-replay/en/session-replay-android-standalone.md b/content/collections/session-replay/en/session-replay-android-standalone.md index eaa1e15cb..1ac87f50d 100644 --- a/content/collections/session-replay/en/session-replay-android-standalone.md +++ b/content/collections/session-replay/en/session-replay-android-standalone.md @@ -5,10 +5,10 @@ title: 'Session Replay Android Standalone SDK' landing: false exclude_from_sitemap: false updated_by: 0c3a318b-936a-4cbd-8fdf-771a90c297f0 -updated_at: 1730234432 +updated_at: 1730306287 instrumentation_guide: true platform: android -public: true +public: false parent: 467a0fe0-6ad9-4375-96a2-eea5b04a7bcf description: 'Choose this option if you use a third-party analytics provider to instrument your Android application.' --- diff --git a/content/collections/session-replay/en/session-replay-ios-plugin.md b/content/collections/session-replay/en/session-replay-ios-plugin.md index 214416881..f6f968c16 100644 --- a/content/collections/session-replay/en/session-replay-ios-plugin.md +++ b/content/collections/session-replay/en/session-replay-ios-plugin.md @@ -5,14 +5,14 @@ title: 'Session Replay iOS Plugin' landing: false exclude_from_sitemap: false updated_by: 0c3a318b-936a-4cbd-8fdf-771a90c297f0 -updated_at: 1730234377 +updated_at: 1730306264 instrumentation_guide: true platform: ios -public: true +public: false parent: 467a0fe0-6ad9-4375-96a2-eea5b04a7bcf description: 'Choose this option if you use an Amplitude iOS SDK to instrument your iOS application.' --- -This article covers the installation of Session Replay using the iOS Swift SDK plugin. If your app is already instrumented with the an Amplitude [iOS SDK](/docs/sdks/analytics/ios/ios-swift-sdk), use this option. +This article covers the installation of Session Replay using the iOS plugin. If your app is already instrumented with the an Amplitude [iOS SDK](/docs/sdks/analytics/ios), use this option. If you use Segment through their Analytics-Swift SDK and [Amplitude (Actions) destination](https://segment.com/docs/connections/destinations/catalog/actions-amplitude/), choose the [Segment Plugin](/docs/session-replay/session-replay-ios-segment-integration). @@ -45,7 +45,7 @@ Use the latest version of the Session Replay Middleware above version `{{sdk_ver The Session Replay Middleware requires that: 1. Your application runs on iOS or iPadOS. -2. You are using `8.21.0` or higher of the [(maintenance) Amplitude iOS SDK](/docs/sdks/analytics/ios/ios-sdk). +2. You are using `8.22.0` or higher of the [(maintenance) Amplitude iOS SDK](/docs/sdks/analytics/ios/ios-sdk). 3. You can provide a device ID to the SDK. {{/partial:tab}} @@ -57,8 +57,8 @@ The Session Replay Middleware requires that: Add the [latest version](https://github.com/amplitude/AmplitudeSessionReplay-iOS) of the plugin to your project dependencies. -{{partial:tabs tabs="Plugin, Middleware"}} -{{partial:tab name="Plugin"}} +{{partial:tabs tabs="Swift SDK, Legacy SDK"}} +{{partial:tab name="Swift SDK"}} **Swift Package Manager** Add Session Replay as a dependency in your Package.swift file, or the Package list in Xcode. @@ -99,7 +99,7 @@ amplitude.add(plugin: AmplitudeSwiftSessionReplayPlugin(sampleRate: 1.0)) ``` {{/partial:tab}} -{{partial:tab name="Middleware"}} +{{partial:tab name="Legacy SDK"}} **Swift Package Manager** Add Session Replay as a dependency in your Package.swift file, or the Package list in Xcode. diff --git a/content/collections/session-replay/en/session-replay-ios-segment-integration.md b/content/collections/session-replay/en/session-replay-ios-segment-integration.md index 9ca462a8a..09a5aa3d7 100644 --- a/content/collections/session-replay/en/session-replay-ios-segment-integration.md +++ b/content/collections/session-replay/en/session-replay-ios-segment-integration.md @@ -5,11 +5,11 @@ title: 'Session Replay iOS Segment Integration' landing: false exclude_from_sitemap: false updated_by: 0c3a318b-936a-4cbd-8fdf-771a90c297f0 -updated_at: 1730234404 +updated_at: 1730306275 alpha: true instrumentation_guide: true platform: ios -public: true +public: false parent: 467a0fe0-6ad9-4375-96a2-eea5b04a7bcf description: "Choose this option if you use Segment's Amplitude (Actions) destination to send analytics data to Amplitude." --- diff --git a/content/collections/session-replay/en/session-replay-ios-standalone-sdk.md b/content/collections/session-replay/en/session-replay-ios-standalone-sdk.md index 80ee11071..a8eb2f24d 100644 --- a/content/collections/session-replay/en/session-replay-ios-standalone-sdk.md +++ b/content/collections/session-replay/en/session-replay-ios-standalone-sdk.md @@ -5,11 +5,11 @@ title: 'Session Replay iOS Standalone SDK' landing: false exclude_from_sitemap: false updated_by: 0c3a318b-936a-4cbd-8fdf-771a90c297f0 -updated_at: 1730234357 +updated_at: 1730306269 alpha: true instrumentation_guide: true platform: ios -public: true +public: false parent: 467a0fe0-6ad9-4375-96a2-eea5b04a7bcf description: 'Choose this option if you use an iOS analytics provider other than Amplitude.' --- diff --git a/content/trees/navigation/en/session_replay.yaml b/content/trees/navigation/en/session_replay.yaml index ea8717920..865afe1cc 100644 --- a/content/trees/navigation/en/session_replay.yaml +++ b/content/trees/navigation/en/session_replay.yaml @@ -13,47 +13,17 @@ tree: entry: 467a0fe0-6ad9-4375-96a2-eea5b04a7bcf children: - - id: 26be92c5-cd46-4ff7-9a45-9194697c532a - title: Web - children: - - - id: 2a9877d6-5e50-43d9-a1e0-15862a4279b5 - entry: f4c61e43-7a55-43a3-9dbd-f1ecb2502774 - - - id: 6573c21d-8fc2-4206-96bd-5041b7313ad4 - entry: 99b87b72-07f8-4e08-9dcd-348f3c8976f3 - - - id: 3706eba9-c43a-4725-a801-bf9eac846f49 - entry: d225a8c4-c504-4cbe-b4f3-8709ab43fdc1 - - - id: 25c81e16-709f-42e1-9655-bbb6eb0fc606 - entry: 5416910c-32f8-4e80-be0f-88a10509c029 + id: 2a9877d6-5e50-43d9-a1e0-15862a4279b5 + entry: f4c61e43-7a55-43a3-9dbd-f1ecb2502774 - - id: 3890b43d-83e6-40d5-b938-b82ea1ee9fcc - title: iOS - children: - - - id: 06611ab3-b400-48c9-adac-a3779d286af6 - entry: af03dd4a-f389-4ad1-9a24-6dd1bbcdacbe - - - id: 2081e4f7-cb30-42dc-9935-488d7d06be93 - entry: 70c86f31-42e5-47d4-ab32-698e7513f499 - - - id: 30bc65e7-f417-41ee-bcf0-1675480063c8 - entry: 5b801f67-851c-4adb-acb9-da7df0004348 + id: 6573c21d-8fc2-4206-96bd-5041b7313ad4 + entry: 99b87b72-07f8-4e08-9dcd-348f3c8976f3 + - + id: 3706eba9-c43a-4725-a801-bf9eac846f49 + entry: d225a8c4-c504-4cbe-b4f3-8709ab43fdc1 + - + id: 25c81e16-709f-42e1-9655-bbb6eb0fc606 + entry: 5416910c-32f8-4e80-be0f-88a10509c029 - id: 6dce7130-8885-48eb-80c4-7b634fe560c3 entry: 951b924e-d18a-44cc-b5b0-51142ffb4e75 - - - id: bd1bf29a-6296-4f5b-8d16-7a8dd482f751 - title: Android - children: - - - id: c24645f0-95be-4fc1-bca8-132f8e9a6f01 - entry: c412bf9e-bbad-4063-bcf4-20cf2b3c2a01 - - - id: 52847633-ab28-4a2d-a727-5a629e670616 - entry: cdfdbd9e-d890-41da-8875-ca7a465adfb3 - - - id: d4e26b0b-f1b6-4422-b5f4-1c1c2da169fd - entry: 67dcf1d2-5749-4a4e-a81d-670404e919c3 diff --git a/resources/views/partials/session-replay/_sr-android-mask-data.antlers.html b/resources/views/partials/session-replay/_sr-android-mask-data.antlers.html index c681f8be0..30db6cafa 100644 --- a/resources/views/partials/session-replay/_sr-android-mask-data.antlers.html +++ b/resources/views/partials/session-replay/_sr-android-mask-data.antlers.html @@ -30,13 +30,4 @@ | `mask(view: View)` | To mask text within non-input views, call `SessionReplay.mask(view)` where `view` is a reference to the text input you want to mask. When masked, Session Replay captures masked text as a series of asterisks. | | `block(view: View)` | To block a non-text view, call `SessionReplay.unmask(view)` where `view` is a reference to the View you want to block. Session Replay replaces blocked views with a placeholder of the same dimensions. | -#### Privacy Modifiers for Jetpack Compose - -Three privacy Modifiers are included. `Modifier.ampUnmask().ampMask().ampBlock()`. When combined the most private modifier wins. - -| Method | Description | -|---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `ampUnmask()` | Session Replay masks all text input views by default. When a user enters text into an input view, Session Replay captures asterisks in place of text. To *unmask* a text input, add `Modifier.ampUnmask()` to the Composable you want to unmask. | -| `ampMask()` | To mask text within non-input views, call `Modifier.ampMask()` to the Composable you want to mask. When masked, Session Replay captures masked text as a series of asterisks. | -| `ampBlock()` | To block a non-text view, call `Modifier.ampBlock()` to the Composable you want to block. Session Replay replaces blocked views with a placeholder of the same dimensions. | {{/markdown}} \ No newline at end of file diff --git a/resources/views/partials/session-replay/_sr-android-troubleshooting.antlers.html b/resources/views/partials/session-replay/_sr-android-troubleshooting.antlers.html index aaf584ff9..d77c3b362 100644 --- a/resources/views/partials/session-replay/_sr-android-troubleshooting.antlers.html +++ b/resources/views/partials/session-replay/_sr-android-troubleshooting.antlers.html @@ -1,32 +1,6 @@ {{markdown}} ## Troubleshooting -For more information about individual statuses and errors, see the [Session Replay Ingestion Monitor](/docs/session-replay/ingestion-monitor). - -### Supported view components - -| View Feature | Support Level | Notes | -|---------------------------|---------------|--------------------------------------------------------------------------------------------------------------| -| Layout: position | Full | | -| Layout: dimensions | Full | | -| Layout: padding | Full | | -| Layout: insets | Full | | -| View: background color | Full | | -| View: background drawable | Full | | -| View: background radius | Full | | -| View: scrolling | Partial | | -| View: animations | Partial | Any animations adding/removing views are supported. | -| Images: placeholders | Full | | -| Images: bitmaps | Full | | -| Text: alignment | Full | | -| Text: size | Full | | -| Text: color | Full | | -| Text: font | Full | | -| Text: fontFamily | Full | | -| Text: all caps | Full | | -| Text: compound drawables | Full | | -| Touch: up | Full | | -| Touch: down | Full | | -| Touch: move | Partial | | +For more information about individual statuses and errors, see the [Session Replay Ingestion Monitor](/docs/session-replay/ingestion-monitor). | {{/markdown}} \ No newline at end of file