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

    Class Highlight

    Index

    Constructors

    constructor

    Properties

    _backendUrl _counters _eventBytesSinceSnapshot _firstLoadListeners _gauges _hasPreviouslyInitialized _histograms _integrations _isCrossOriginIframe _isOnLocalHost _lastSnapshotTime _lastVisibilityChangeTime _onToggleFeedbackFormVisibility _optionsInternal _recordingStartTime _recordStop _up_down_counters _worker appVersion debugOptions enableCanvasRecording enablePerformanceRecording 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 consumeCustomError consumeError getCurrentSessionTimestamp getCurrentSessionURL getCurrentSessionURLWithTimestamp identify initialize log pushCustomError recordCount recordGauge recordHistogram recordIncr recordUpDownCounter registerLD snapshot stopRecording submitViewportMetrics create

    Constructors

    Properties

    _backendUrl

    _backendUrl: string

    _counters

    _counters: Map<string, Counter<Attributes>> = ...

    _eventBytesSinceSnapshot

    _eventBytesSinceSnapshot: number

    _firstLoadListeners

    _firstLoadListeners: FirstLoadListeners

    _gauges

    _gauges: Map<string, Gauge<Attributes>> = ...

    _hasPreviouslyInitialized

    _hasPreviouslyInitialized: boolean

    _histograms

    _histograms: Map<string, Histogram<Attributes>> = ...

    _integrations

    _integrations: IntegrationClient[] = []

    _isCrossOriginIframe

    _isCrossOriginIframe: boolean

    _isOnLocalHost

    _isOnLocalHost: boolean

    _lastSnapshotTime

    _lastSnapshotTime: number

    _lastVisibilityChangeTime

    _lastVisibilityChangeTime: number

    _onToggleFeedbackFormVisibility

    _onToggleFeedbackFormVisibility: () => void

    _optionsInternal

    _optionsInternal: HighlightClassOptionsInternal

    _recordingStartTime

    _recordingStartTime: number

    _recordStop

    _recordStop: undefined | listenerHandler

    _up_down_counters

    _up_down_counters: Map<string, UpDownCounter<Attributes>> = ...

    _worker

    _worker: HighlightClientRequestWorker
    appVersion: undefined | string

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

    debugOptions: DebugOptions
    enableCanvasRecording: boolean
    enablePerformanceRecording: 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

    • Parameters

      • error: Error
      • __namedParameters: { message?: string; payload?: object; source?: string; type?: ErrorMessageType }

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods