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:用于粘性会话(sticky sessions)。如果你有多站点应用,或者你需要将用户重定向到站点外部然后再返回站点(例如重定向到支付网关),则此选项非常有用。
  • isConditional:决定追踪器是否应等待触发条件满足后再自动启动会话。

注意:条件录制仅在我们的 Cloud 和 Enterprise Edition 版本中受支持。

此方法不返回任何值。