JavaScript SDK - Methode 'coldStart'

Details zur Methode 'coldStart' aus dem OpenReplay SDK

JavaScript SDK ⁠-⁠ Methode 'coldStart'

Beginnt, Nachrichten zu puffern, ohne die eigentliche Sitzung zu starten. Der Puffer behält die Ereignisse der letzten 30 Sekunden. Sie können die Sitzung durch den Aufruf von start() oder über einen bedingten Trigger aktivieren.

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

Mit startOpts können Sie verschiedene Aspekte der Aufzeichnung anpassen:

  • userID: string: Dient dazu, die userID manuell festzulegen, um den Benutzer sitzungsübergreifend zu verfolgen. Es ist ein String-Wert und kann beliebig gewählt werden.
  • metadata: Record<string, string>: Legt die Metadatenwerte manuell fest. Mehr dazu finden Sie im Abschnitt Metadaten.
  • forceNew: boolean: Erzwingt nach einem Seiten-Refresh eine neue Sitzung. Standardmäßig ist der Wert false, sodass die Sitzung nach einem Refresh erhalten bleibt.
  • sessionHash: string: Wird für Sticky Sessions verwendet. Nützlich, wenn Sie eine Multi-Site-Anwendung betreiben oder den Benutzer nach außen und anschließend wieder zurück auf Ihre Website leiten müssen (etwa zu einem Zahlungsanbieter).
  • isConditional: Legt fest, ob der Tracker darauf warten soll, dass die Trigger-Bedingung erfüllt ist, bevor die Sitzung automatisch gestartet wird.

Hinweis: Die bedingte Aufzeichnung wird nur in unseren Angeboten Cloud und Enterprise Edition unterstützt.

Diese Methode gibt keinen Wert zurück.