Package backtraceio.library.interfaces
Interface Api
- All Known Implementing Classes:
BacktraceApi
public interface Api
API sender interface
-
Method Summary
Modifier and TypeMethodDescriptionenableSummedEvents
(BacktraceMetrics backtraceMetrics) Create metrics events handler for summed eventsenableUniqueEvents
(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
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
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 Details
-
send
Send a Backtrace report to Backtrace report submission API- Parameters:
data
- diagnostic data
-
sendEventsPayload
Send a Backtrace unique events payload to Backtrace events submission API- Parameters:
payload
- unique events payload
-
sendEventsPayload
Send a Backtrace summed events payload to Backtrace events submission API- Parameters:
payload
- summed events payload
-
setOnServerError
Set an event executed when received bad request, unauthorized request or other information from server -
setRequestHandler
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
Create metrics events handler for unique events- Parameters:
backtraceMetrics
- Backtrace metrics object- Returns:
- Reference to the created UniqueEventsHandler
-
enableSummedEvents
Create metrics events handler for summed events- Parameters:
backtraceMetrics
- Backtrace metrics object- Returns:
- Reference to the created SummedEventsHandler
-
setUniqueEventsRequestHandler
Set the request handler for unique events- Parameters:
eventsRequestHandler
-
-
setUniqueEventsOnServerResponse
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
Set the request handler for summed events- Parameters:
eventsRequestHandler
-
-
setSummedEventsOnServerResponse
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
-