OpenKit public interface

Hierarchy

  • OpenKit

Methods

  • Creates a new session and returns its instance.

    Parameters

    • Optional clientIp: string

      the client's ip

    Returns Session

  • Checks if OpenKit has successfully initialized.

    Returns

    true if OpenKit initialized successfully, false otherwise.

    Returns boolean

  • Shutdown OpenKit. All open session are closed and send to the Beacon.

    Parameters

    • Optional callback: ShutdownCallback

      The callback when the shutdown has finished sending to the Beacon.

    Returns void

  • Waits for the initialization of OpenKit and calls the callback after it finished, or the timeout runs out. If not timeout is passed, it runs until the initialization finished.
    If OpenKit already initialized, the callback runs synchronously.
    The callback is called with {@code true} iff OpenKit initialized successfully and is not Shutdown.

    Parameters

    • callback: InitCallback

      The callback which is executed after initialization, or after the timeout runs out.

    • Optional timeout: number

      The timeout for the initialization

    Returns void

Generated using TypeDoc