JavaScript SDK - 'coldStart' メソッド

OpenReplay の SDK の 'coldStart' メソッドの詳細

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: スティッキーセッションに使用します。マルチサイトのアプリケーションの場合や、ユーザーをいったん外部(決済ゲートウェイなど)にリダイレクトして再びサイトに戻す必要がある場合に便利です。
  • isConditional: セッションを自動的に開始する前に、トラッカーがトリガー条件の成立を待つかどうかを決定します。

注記:条件付き録画は、Cloud と Enterprise Edition でのみサポートされています。

このメソッドは値を返しません。