Builder for an OpenKit instance.

Hierarchy

  • OpenKitBuilder

Constructors

  • Creates a new OpenKitBuilder

    Parameters

    • beaconURL: string

      The url to the beacon endpoint

    • applicationId: string

      The id of the custom application

    • deviceId: number

      The id of the current device, which must be a decimal number in the range of Number.MIN_SAFE_INTEGER to Number.MAX_SAFE_INTEGER. If the number is outside of this range, not decimal or invalid it will be hashed.

    Returns OpenKitBuilder

Methods

  • Build and initialize an OpenKit instance.

    Returns

    The OpenKit instance.

    Returns OpenKit

  • Builds and gets the current configuration.

    Returns

    the current configuration

    Returns Readonly<Configuration>

  • Defines the version of the application.

    Returns

    The current OpenKitBuilder

    Parameters

    • appVersion: string

      The application version

    Returns OpenKitBuilder

  • Sets the flag if crash reporting is enabled

    Off (0) - No crashes are reported OptOutCrashes = (1) - No crashes are reported OptInCrashes = (2) - Crashes are reported

    If an invalid value is passed, it is ignored.

    Parameters

    Returns OpenKitBuilder

  • Sets the data collection level.

    Depending on the chosen level the amount and granularity of data sent is controlled. Off (0) - no data collected Performance (1) - only performance related data is collected UserBehavior (2) - all available RUM data including performance related data is collected..

    If an invalid value is passed, it is ignored.

    Default value is UserBehavior (2)

    Returns

    The current OpenKitBuilder

    Parameters

    Returns OpenKitBuilder

  • Sets the default log level if the default logger factory is used.

    Parameters

    • logLevel: LogLevel

      The loglevel for the default logger factory.

    Returns OpenKitBuilder

  • Sets the manufacturer of the device. If the argument is not a string or empty string, it is ignored.

    Parameters

    • manufacturer: string

      The manufacturer of the device

    Returns OpenKitBuilder

  • Sets the modelId of the device. If the argument is not a string or empty string, it is ignored.

    Parameters

    • modelId: string

      The model id of the device

    Returns OpenKitBuilder

  • Sets the operating system information. Defaults to 'OpenKit'.

    Returns

    The current OpenKitBuilder

    Parameters

    • operatingSystem: string

      The operating system

    Returns OpenKitBuilder

  • Sets the screen orientation. Allowed values are Orientation.Portrait ('p') and Orientation.Landscape ('l'). All other values are ignored.

    Parameters

    • orientation: Orientation

      The orientation. 'p' || 'l'.

    Returns OpenKitBuilder

  • Sets the screen resolution. If the width or height are not positive finite numbers, both are ignored.

    Parameters

    • width: number

      The width of the screen

    • height: number

      The height of the screen

    Returns OpenKitBuilder

  • Sets the user language. If the language is not a string or empty string, it is ignored. Currently, there are no restrictions on RFC/ISO codes.

    Parameters

    • language: string

      The user language

    Returns OpenKitBuilder

Generated using TypeDoc