Skip to content

Commit b9251b2

Browse files
authored
Merge pull request #21944 from ellisong/NR-441709-session-replay
chore: Clarify pause and start functionality
2 parents 2807161 + 8b45b1d commit b9251b2

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

src/content/docs/browser/new-relic-browser/browser-apis/pauseReplay.mdx

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ Browser API used to force a replay to pause recording.
2929

3030
If a replay is not already in progress, this API method will have no effect.
3131

32+
If the browser session is still valid, you can resume a paused replay by calling the [`newrelic.recordReplay()`](/docs/browser/new-relic-browser/browser-apis/recordReplay) API method.
33+
3234
## Use Cases
3335

3436
* You want to manually trigger a replay to stop recording on certain site pages or under certain conditions, such as a healthcare page, credit card info page, etc.
@@ -40,3 +42,10 @@ If a replay is not already in progress, this API method will have no effect.
4042
```js
4143
newrelic.pauseReplay()
4244
```
45+
46+
### Resuming a paused replay
47+
48+
```js
49+
newrelic.pauseReplay()
50+
newrelic.recordReplay()
51+
```

src/content/docs/browser/new-relic-browser/browser-apis/recordReplay.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@ Browser API used to force a replay to start recording.
3535

3636
If a replay is already in progress, or not all of the above criteria are met, this API method will have no effect.
3737

38+
For information about pausing and resuming a replay, refer to [`newrelic.pauseReplay()`](/docs/browser/new-relic-browser/browser-apis/pauseReplay)
39+
3840
## Use Cases
3941

4042
* You want to manually trigger a replay to record on certain site pages or under certain conditions, regardless of the sampling settings.
@@ -44,5 +46,5 @@ If a replay is already in progress, or not all of the above criteria are met, th
4446
### Forcing a replay to start recording
4547

4648
```js
47-
newrelic.recordReplay()
49+
newrelic.recordReplay()
4850
```

0 commit comments

Comments
 (0)