JavaScript SDK - метод 'startOfflineRecording'

Подробности о методе 'startOfflineRecording' из SDK OpenReplay

JavaScript SDK ⁠-⁠ метод 'startOfflineRecording'

Запускает запись сессии в офлайн-режиме (ничего не отправляется до тех пор, пока не будет инициирована загрузка) и возвращает методы для управления состоянием записи.

Примечание: временные метки сессии и событий будут извлечены с устройства пользователя и не синхронизируются с нашим бэкендом.

startOfflineRecording(
	startOpts?: Partial<StartOptions>, 
	onSessionSent: () => void
): { saveBuffer, getBuffer, setBuffer }

С помощью startOpts вы можете настраивать различные аспекты записи:

  • userID: string: используется для ручной установки userID для отслеживания пользователя между сессиями. Это строковое значение, и оно может быть любым.
  • metadata: Record<string, string>: ручная установка значений метаданных. Дополнительную информацию об этой функции см. в разделе Метаданные.
  • forceNew: boolean: используется для принудительного создания новой сессии после обновления страницы. По умолчанию установлено значение false, поэтому после обновления сессия сохраняется.
  • sessionHash: string: используется для закреплённых сессий. Полезно, если у вас многосайтовое приложение или если вам нужно перенаправить пользователя за пределы сайта, а затем обратно (например, на платёжный шлюз).
  • onSessionSent: колбэк, который будет вызван после полной загрузки сессии.

Возвращаемое значение

Section titled Возвращаемое значение
  • saveBuffer(): void - Сохраняет текущий буфер в объект localStorage (настраивается в конструкторе); буфер будет автоматически загружен при вызове startOfflineRecording.
  • getBuffer(): Messages[] - Возвращает текущий буфер сообщений.
  • setBuffer(buffer: Messages[]) - Заменяет текущий буфер указанным (если вы используете альтернативные методы временного сохранения).