JavaScript SDK - 'start' 메서드

OpenReplay SDK의 'start' 메서드에 대한 자세한 설명

JavaScript SDK ⁠-⁠ 'start' 메서드

이 메서드는 트래커를 시작하는 데 사용합니다. 트래커가 시작되면 세션 녹화가 시작됩니다.

start(startOpts?: Partial<StartOptions>): Promise<StartPromiseReturn>

start 메서드는 녹화의 여러 측면을 사용자 지정할 수 있는 선택적 매개변수를 받습니다:

  • userID: string: 사용자 ID를 수동으로 설정하여 세션 간에 사용자를 추적할 때 사용합니다. 원하는 어떤 문자열 값이든 사용할 수 있습니다.
  • metadata: Record<string, string>: 메타데이터 값을 수동으로 설정합니다. 이 기능에 대한 자세한 내용은 메타데이터 섹션을 확인하세요.
  • forceNew: boolean: 페이지 새로 고침 후 새 세션을 강제로 시작할 때 사용합니다. 기본값은 false이므로 새로 고침 후에도 세션이 유지됩니다.
  • sessionToken: string: 일부 통합에서 사용됩니다.
  • assistOnly: boolean: 세션 데이터를 백엔드로 전송하지 않는 Assist 전용 모드로 트래커를 실행합니다(EE 에디션 기능).
  • startCallback?: (result: StartPromiseReturn) => void: 트래커가 시작되거나 시작에 실패했을 때 호출되는 콜백입니다. 성공 또는 실패 정보를 반환합니다.

시작되면 이 메서드는 다음을 포함하는 세션 정보 객체를 담은 프로미스를 반환합니다:

  • sessionID: string: 시작된 세션의 ID를 나타내는 문자열 값입니다.
  • sessionToken: string: 세션의 토큰입니다.
  • userUUID: string: 사용자의 고유 식별자입니다.

StartPromiseReturn은 다음 중 하나일 수 있습니다:

// Successful start
interface OnStartInfo {
  sessionID: string;
  sessionToken: string;
  userUUID: string;
}

const SuccessfulStart = (body: OnStartInfo): SuccessfulStart => ({
  ...body,
  success: true,
});

// Unsuccessful start
const UnsuccessfulStart = (reason: string): UnsuccessfulStart => ({
  reason,
  success: false,
});

// Type for start promise return
export type StartPromiseReturn = SuccessfulStart | UnsuccessfulStart;
  • 성공한 경우: 성공하면 프로미스가 sessionID, sessionToken, userUUID를 반환합니다.
  • 실패한 경우: 실패하면 reason과 success: false를 반환합니다.