Package backtraceio.library.services

Class BacktraceApi

java.lang.Object
backtraceio.library.services.BacktraceApi
All Implemented Interfaces:
Api
public class BacktraceApi extends Object implements Api
Backtrace Api class that allows to send data to Backtrace endpoints

  • Constructor Details

    • BacktraceApi

      public BacktraceApi(BacktraceCredentials credentials)
      Create a new instance of Backtrace API
      Parameters:
      credentials - API credentials

  • Method Details

    • setUniqueEventsRequestHandler

      public void setUniqueEventsRequestHandler(EventsRequestHandler uniqueEventsRequestHandler)
      Description copied from interface: Api
      Set the request handler for unique events
      Specified by:
      setUniqueEventsRequestHandler in interface Api

    • setSummedEventsRequestHandler

      public void setSummedEventsRequestHandler(EventsRequestHandler summedEventsRequestHandler)
      Description copied from interface: Api
      Set the request handler for summed events
      Specified by:
      setSummedEventsRequestHandler in interface Api

    • setUniqueEventsOnServerResponse

      public void setUniqueEventsOnServerResponse(EventsOnServerResponseEventListener callback)
      Description copied from interface: Api
      Set a custom event to trigger when a unique events request gets a response from the Backtrace API
      Specified by:
      setUniqueEventsOnServerResponse in interface Api
      Parameters:
      callback - The custom event to trigger on an API response for a unique events request

    • setSummedEventsOnServerResponse

      public void setSummedEventsOnServerResponse(EventsOnServerResponseEventListener callback)
      Description copied from interface: Api
      Set a custom event to trigger when a si,,ed events request gets a response from the Backtrace API
      Specified by:
      setSummedEventsOnServerResponse in interface Api
      Parameters:
      callback - The custom event to trigger on an API response for a unique events request

    • setOnServerError

      public void setOnServerError(OnServerErrorEventListener onServerError)
      Description copied from interface: Api
      Set an event executed when received bad request, unauthorized request or other information from server
      Specified by:
      setOnServerError in interface Api

    • setRequestHandler

      public void setRequestHandler(RequestHandler requestHandler)
      Description copied from interface: Api
      Set custom request method to prepare HTTP request to Backtrace report API
      Specified by:
      setRequestHandler in interface Api
      Parameters:
      requestHandler - event which will be executed instead of default request to Backtrace report API

    • enableUniqueEvents

      public UniqueEventsHandler enableUniqueEvents(BacktraceMetrics backtraceMetrics)
      Description copied from interface: Api
      Create metrics events handler for unique events
      Specified by:
      enableUniqueEvents in interface Api
      Parameters:
      backtraceMetrics - Backtrace metrics object
      Returns:
      Reference to the created UniqueEventsHandler

    • enableSummedEvents

      public SummedEventsHandler enableSummedEvents(BacktraceMetrics backtraceMetrics)
      Description copied from interface: Api
      Create metrics events handler for summed events
      Specified by:
      enableSummedEvents in interface Api
      Parameters:
      backtraceMetrics - Backtrace metrics object
      Returns:
      Reference to the created SummedEventsHandler

    • send

      public void send(BacktraceData data, OnServerResponseEventListener callback)
      Sending synchronously a diagnostic report data to Backtrace server API.
      Specified by:
      send in interface Api
      Parameters:
      data - diagnostic data

    • sendEventsPayload

      public void sendEventsPayload(UniqueEventsPayload payload)
      Description copied from interface: Api
      Send a Backtrace unique events payload to Backtrace events submission API
      Specified by:
      sendEventsPayload in interface Api
      Parameters:
      payload - unique events payload

    • sendEventsPayload

      public void sendEventsPayload(SummedEventsPayload payload)
      Description copied from interface: Api
      Send a Backtrace summed events payload to Backtrace events submission API
      Specified by:
      sendEventsPayload in interface Api
      Parameters:
      payload - summed events payload