Class Replay

name

Static id

flush

• flush(options?): Promise<void>

• If not in "session" recording mode, flush event buffer which will create a new replay. Unless continueRecording is false, the replay will continue to record and behave as a "session"-based replay.

  Otherwise, queue up a flush.

  Parameters

  • Optional options: SendBufferedReplayOptions

  Returns Promise<void>

getReplayId

• getReplayId(): undefined | string

• Get the current session ID.

  Returns undefined | string

setupOnce

• setupOnce(): void

• Setup and initialize replay container

  Returns void

start

• start(): void

• Start a replay regardless of sampling rate. Calling this will always create a new session. Will throw an error if replay is already in progress.

  Creates or loads a session, attaches listeners to varying events (DOM, PerformanceObserver, Recording, Sentry SDK, etc)

  Returns void

startBuffering

• startBuffering(): void

• Start replay buffering. Buffers until flush() is called or, if replaysOnErrorSampleRate > 0, until an error occurs.

  Returns void

stop

• stop(): Promise<void>

• Currently, this needs to be manually called (e.g. for tests). Sentry SDK does not support a teardown

  Returns Promise<void>