Class RecordSDK

constructor

• new RecordSDK(options: HighlightClassOptions): RecordSDK

  Parameters

  • options: HighlightClassOptions

  Returns RecordSDK

_backendUrl

_eventBytesSinceSnapshot

_hasPreviouslyInitialized

_integrations

_isCrossOriginIframe

_isOnLocalHost

_lastSnapshotTime

_lastVisibilityChangeTime

_onToggleFeedbackFormVisibility

_optionsInternal

_recordingStartTime

_recordStop

_worker

appVersion

debugOptions

enableCanvasRecording

enableSegmentIntegration

environment

events

firstloadVersion

hasPushedData

hasSessionUnloaded

inlineImages

inlineStylesheet

inlineVideos

isRunningOnHighlight

listeners

logger

manualStopped

options

organizationID

privacySetting

pushPayloadTimerId

ready

reloaded

samplingStrategy

serviceName

sessionData

sessionShortcut

state

styleSheetResyncInterval

_initMembers

• _initMembers(options: HighlightClassOptions): void

  Parameters

  • options: HighlightClassOptions

  Returns void

_reset

• _reset(
      __namedParameters: { forceNew?: boolean; sessionKey?: string },
  ): Promise<void>

  Parameters

  • __namedParameters: { forceNew?: boolean; sessionKey?: string }

  Returns Promise<void>

_save

• _save(): Promise<void>

  Returns Promise<void>

_sendPayload

• _sendPayload(
      __namedParameters: {
          sendFn?: (
              payload: PushSessionEventsMutationVariables,
          ) => Promise<number>;
      },
  ): Promise<void>

  Parameters

  • __namedParameters: { sendFn?: (payload: PushSessionEventsMutationVariables) => Promise<number> }

  Returns Promise<void>

_setupCrossOriginIframe

• _setupCrossOriginIframe(): Promise<void>

  Returns Promise<void>

_setupCrossOriginIframeParent

• _setupCrossOriginIframeParent(): void

  Returns void

_setupWindowListeners

• _setupWindowListeners(): void

  Returns void

_visibilityHandler

• _visibilityHandler(hidden: boolean): Promise<void>

  Parameters

  • hidden: boolean

  Returns Promise<void>

addCustomEvent

• addCustomEvent<T>(tag: string, payload: T): void

  This proxy should be used instead of rrweb's native addCustomEvent. The proxy makes sure recording has started before emitting a custom event.

  Type Parameters

  • T

  Parameters

  • tag: string
  • payload: T

  Returns void

addProperties

• addProperties(properties_obj?: {}, typeArg?: PropertyType): void

  Parameters

  • properties_obj: {} = {}
  • OptionaltypeArg: PropertyType

  Returns void

addSessionFeedback

• addSessionFeedback(
      _feedback: {
          timestamp: string;
          user_email?: string;
          user_name?: string;
          verbatim: string;
      },
  ): void

  Parameters

  • _feedback: { timestamp: string; user_email?: string; user_name?: string; verbatim: string }

  Returns void

  Deprecated

  Session feedback is no longer supported. This is a no-op.

addSessionProperties

• addSessionProperties(properties: { [key: string]: any }): void

  Add custom session-level properties. These are attached to the current session and are searchable, but do not create timeline Track events.

  Parameters

  • properties: { [key: string]: any }

  Returns void

getCurrentSessionURL

• getCurrentSessionURL(): null | string

  Returns null | string

getCurrentSessionURLWithTimestamp

• getCurrentSessionURLWithTimestamp(): string

  Returns the current timestamp for the current session.

  Returns string

getHooks

• getHooks(metadata: LDPluginEnvironmentMetadata): Hook[]

  Parameters

  • metadata: LDPluginEnvironmentMetadata

  Returns Hook[]

getRecordingState

• getRecordingState(): "NotRecording" | "Recording"

  Returns "NotRecording" | "Recording"

getSession

• getSession(): null | SessionDetails

  Returns null | SessionDetails

identify

• identify(user_identifier: string, user_object?: {}, source?: Source): void

  Parameters

  • user_identifier: string
  • user_object: {} = {}
  • Optionalsource: Source

  Returns void

register

• register(client: LDClient, metadata: LDPluginEnvironmentMetadata): void

  Parameters

  • client: LDClient
  • metadata: LDPluginEnvironmentMetadata

  Returns void

snapshot

• snapshot(element: HTMLCanvasElement): Promise<void>

  Snapshot an HTML element in WebGL manual snapshotting mode. See https://www.highlight.io/docs/getting-started/browser/replay-configuration/canvas#manual-snapshotting for more information.

  Parameters

  • element: HTMLCanvasElement

  Returns Promise<void>

start

• start(options?: StartOptions): Promise<void>

  Start the session when running in manualStart mode. Can be used to force start a new session. Can safely be called before the SDK has initialized (e.g. before the plugin registers): the call resolves once the SDK is attached and started, without throwing.

  Parameters

  • Optionaloptions: StartOptions

    the session start options.

  Returns Promise<void>

stop

• stop(manual?: boolean): void

  Stops Highlight from recording.

  Parameters

  • Optionalmanual: boolean

    The end user requested to stop recording.

  Returns void

track

• track(event: string, metadata?: Metadata): void

  Parameters

  • event: string
  • Optionalmetadata: Metadata

  Returns void