JavaScript SDK - метод 'coldStart'

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

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

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

coldStart(startOpts?: Partial<StartOptions>, isConditional?: boolean): Promise<void>

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

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

Примечание: Условная запись поддерживается только в наших редакциях Cloud и Enterprise Edition.

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

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

Этот метод не возвращает никакого значения.