Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ForensicsProvider

This class provides a tracking provider that can be used for Lead Forensics, the website does not contain a lot of information but you can find the site here:

Example usage:

new ForensicsProvider({
  trackingId: '00000',
}
class

ForensicsProvider

Hierarchy

Implements

  • IDisposable

Index

Constructors

constructor

Properties

Protected logger

logger: debug

This is the logger instance that can be used to trigger namespaced logs.

Protected providerOptions

providerOptions: IForensicsProviderOptions

This is the configuration object that contains all the base information required for initializing the provider.

providerReady

providerReady: Promise<void>

This promise will be resolved or rejected once the provider is ready for usage.

Protected providerReadyRejectMethod

providerReadyRejectMethod: function

This is the reject method that should be triggered if the provider loadings fails for what ever reason.

Type declaration

    • (): void
    • Returns void

Protected providerReadyResolveMethod

providerReadyResolveMethod: function

This is the resolve method that should be triggered once the provider is ready for usage.

Type declaration

    • (): void
    • Returns void

Methods

dispose

  • dispose(): void
  • Destruct this class.

    Returns void

Protected handleApiFailed

  • handleApiFailed(): void

Protected handleApiLoaded

  • handleApiLoaded(): void

Protected init

  • init(): void
  • The init method that initializes the tracking provider

    Returns void

isDisposed

  • isDisposed(): boolean
  • After dispose has been called, this method returns true. Use this method to determine whether dispose() should be run again.

    Returns boolean

Protected loadApi

  • loadApi(url: string): void
  • Method to actually load the API

    Parameters

    • url: string

      This is the url that needs to be loaded before the API is initialized.

    Returns void

trackEvent

  • trackEvent(): Promise<void>
  • The method that actually triggers the tracking of the event

    Returns Promise<void>

trackPageView

  • trackPageView(): Promise<void>
  • The method that actually triggers the tracking of the page view

    Returns Promise<void>

Generated using TypeDoc