Package backtraceio.library.interfaces
Interface Api
-
- All Known Implementing Classes:
BacktraceApi
public interface Api
API sender interface
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description SummedEventsHandler
enableSummedEvents(BacktraceMetrics backtraceMetrics)
Create metrics events handler for summed eventsUniqueEventsHandler
enableUniqueEvents(BacktraceMetrics backtraceMetrics)
Create metrics events handler for unique eventsvoid
send(BacktraceData data, OnServerResponseEventListener callback)
Send a Backtrace report to Backtrace report submission APIvoid
sendEventsPayload(SummedEventsPayload payload)
Send a Backtrace summed events payload to Backtrace events submission APIvoid
sendEventsPayload(UniqueEventsPayload payload)
Send a Backtrace unique events payload to Backtrace events submission APIvoid
setOnServerError(OnServerErrorEventListener onServerError)
Set an event executed when received bad request, unauthorized request or other information from servervoid
setRequestHandler(RequestHandler requestHandler)
Set custom request method to prepare HTTP request to Backtrace report APIvoid
setSummedEventsOnServerResponse(EventsOnServerResponseEventListener callback)
Set a custom event to trigger when a si,,ed events request gets a response from the Backtrace APIvoid
setSummedEventsRequestHandler(EventsRequestHandler eventsRequestHandler)
Set the request handler for summed eventsvoid
setUniqueEventsOnServerResponse(EventsOnServerResponseEventListener callback)
Set a custom event to trigger when a unique events request gets a response from the Backtrace APIvoid
setUniqueEventsRequestHandler(EventsRequestHandler eventsRequestHandler)
Set the request handler for unique events
-
-
-
Method Detail
-
send
void send(BacktraceData data, OnServerResponseEventListener callback)
Send a Backtrace report to Backtrace report submission API- Parameters:
data
- diagnostic data
-
sendEventsPayload
void sendEventsPayload(UniqueEventsPayload payload)
Send a Backtrace unique events payload to Backtrace events submission API- Parameters:
payload
- unique events payload
-
sendEventsPayload
void sendEventsPayload(SummedEventsPayload payload)
Send a Backtrace summed events payload to Backtrace events submission API- Parameters:
payload
- summed events payload
-
setOnServerError
void setOnServerError(OnServerErrorEventListener onServerError)
Set an event executed when received bad request, unauthorized request or other information from server
-
setRequestHandler
void setRequestHandler(RequestHandler requestHandler)
Set custom request method to prepare HTTP request to Backtrace report API- Parameters:
requestHandler
- event which will be executed instead of default request to Backtrace report API
-
enableUniqueEvents
UniqueEventsHandler enableUniqueEvents(BacktraceMetrics backtraceMetrics)
Create metrics events handler for unique events- Parameters:
backtraceMetrics
- Backtrace metrics object- Returns:
- Reference to the created UniqueEventsHandler
-
enableSummedEvents
SummedEventsHandler enableSummedEvents(BacktraceMetrics backtraceMetrics)
Create metrics events handler for summed events- Parameters:
backtraceMetrics
- Backtrace metrics object- Returns:
- Reference to the created SummedEventsHandler
-
setUniqueEventsRequestHandler
void setUniqueEventsRequestHandler(EventsRequestHandler eventsRequestHandler)
Set the request handler for unique events- Parameters:
eventsRequestHandler
-
-
setUniqueEventsOnServerResponse
void setUniqueEventsOnServerResponse(EventsOnServerResponseEventListener callback)
Set a custom event to trigger when a unique events request gets a response from the Backtrace API- Parameters:
callback
- The custom event to trigger on an API response for a unique events request
-
setSummedEventsRequestHandler
void setSummedEventsRequestHandler(EventsRequestHandler eventsRequestHandler)
Set the request handler for summed events- Parameters:
eventsRequestHandler
-
-
setSummedEventsOnServerResponse
void setSummedEventsOnServerResponse(EventsOnServerResponseEventListener callback)
Set a custom event to trigger when a si,,ed events request gets a response from the Backtrace API- Parameters:
callback
- The custom event to trigger on an API response for a unique events request
-
-