@launchdarkly/observability + @launchdarkly/session-replay
    Preparing search index...

    Class RecordSDK

    Implements

    Index

    Constructors

    constructor

    Properties

    _backendUrl _eventBytesSinceSnapshot _hasPreviouslyInitialized _integrations _isCrossOriginIframe _isOnLocalHost _lastSnapshotTime _lastVisibilityChangeTime _onToggleFeedbackFormVisibility _optionsInternal _recordingStartTime _recordStop _worker appVersion debugOptions enableCanvasRecording enableSegmentIntegration environment events firstloadVersion graphqlSDK hasPushedData hasSessionUnloaded inlineImages inlineStylesheet inlineVideos isRunningOnHighlight listeners logger manualStopped options organizationID privacySetting pushPayloadTimerId ready reloaded samplingStrategy serviceName sessionData sessionShortcut state

    Methods

    _initMembers _reset _save _sendPayload _setupCrossOriginIframe _setupCrossOriginIframeParent _setupWindowListeners _visibilityHandler addCustomEvent addProperties addSessionFeedback getCurrentSessionURL getCurrentSessionURLWithTimestamp getHooks getRecordingState getSession identify register snapshot start stop track

    Constructors

    Properties

    _backendUrl

    _backendUrl: string

    _eventBytesSinceSnapshot

    _eventBytesSinceSnapshot: number

    _hasPreviouslyInitialized

    _hasPreviouslyInitialized: boolean

    _integrations

    _integrations: IntegrationClient[] = []

    _isCrossOriginIframe

    _isCrossOriginIframe: boolean

    _isOnLocalHost

    _isOnLocalHost: boolean

    _lastSnapshotTime

    _lastSnapshotTime: number

    _lastVisibilityChangeTime

    _lastVisibilityChangeTime: number

    _onToggleFeedbackFormVisibility

    _onToggleFeedbackFormVisibility: () => void

    _optionsInternal

    _optionsInternal: Omit<RecordOptions, "firstloadVersion">

    _recordingStartTime

    _recordingStartTime: number

    _recordStop

    _recordStop: undefined | listenerHandler

    _worker

    _worker: HighlightClientRequestWorker
    appVersion: undefined | string

    The end-user's app version. This isn't Highlight's version.

    debugOptions: DebugOptions
    enableCanvasRecording: boolean
    enableSegmentIntegration: boolean
    environment: string
    events: eventWithTime[]
    firstloadVersion: string
    graphqlSDK: {
        addSessionFeedback(
            variables: AddSessionFeedbackMutationVariables,
            requestHeaders?: GraphQLClientRequestHeaders,
        ): Promise<AddSessionFeedbackMutation>;
        addSessionProperties(
            variables: AddSessionPropertiesMutationVariables,
            requestHeaders?: GraphQLClientRequestHeaders,
        ): Promise<AddSessionPropertiesMutation>;
        GetSamplingConfig(
            variables: GetSamplingConfigQueryVariables,
            requestHeaders?: GraphQLClientRequestHeaders,
        ): Promise<GetSamplingConfigQuery>;
        identifySession(
            variables: IdentifySessionMutationVariables,
            requestHeaders?: GraphQLClientRequestHeaders,
        ): Promise<IdentifySessionMutation>;
        Ignore(
            variables: IgnoreQueryVariables,
            requestHeaders?: GraphQLClientRequestHeaders,
        ): Promise<IgnoreQuery>;
        initializeSession(
            variables: InitializeSessionMutationVariables,
            requestHeaders?: GraphQLClientRequestHeaders,
        ): Promise<InitializeSessionMutation>;
        pushMetrics(
            variables: PushMetricsMutationVariables,
            requestHeaders?: GraphQLClientRequestHeaders,
        ): Promise<PushMetricsMutation>;
        PushPayload(
            variables: PushPayloadMutationVariables,
            requestHeaders?: GraphQLClientRequestHeaders,
        ): Promise<PushPayloadMutation>;
        PushSessionEvents(
            variables: PushSessionEventsMutationVariables,
            requestHeaders?: GraphQLClientRequestHeaders,
        ): Promise<PushSessionEventsMutation>;
    }
    hasPushedData: boolean
    hasSessionUnloaded: boolean
    inlineImages: boolean
    inlineStylesheet: boolean
    inlineVideos: boolean
    isRunningOnHighlight: boolean

    Determines if the client is running on a Highlight property (e.g. frontend).

    listeners: listenerHandler[]
    logger: Logger
    manualStopped: boolean
    options: HighlightClassOptions
    organizationID: string

    Verbose project ID that is exposed to users. Legacy users may still be using ints.

    privacySetting: PrivacySettingOption
    pushPayloadTimerId: undefined | Timeout
    ready: boolean
    reloaded: boolean
    samplingStrategy: SamplingStrategy
    serviceName: string
    sessionData: SessionData
    sessionShortcut: SessionShortcutOptions
    state: "NotRecording" | "Recording"

    Methods

    _initMembers

    _reset

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

      Parameters

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

      Returns Promise<void>

    _save

    _sendPayload

    _setupCrossOriginIframe

    _setupCrossOriginIframeParent

    _setupWindowListeners

    _visibilityHandler

    • 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

    • Parameters

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

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods