-
- All Implemented Interfaces:
-
backtraceio.library.interfaces.Api
public class BacktraceApi implements Api
Backtrace Api class that allows to send data to Backtrace endpoints
-
-
Field Summary
Fields Modifier and Type Field Description private OnServerErrorEventListeneronServerErrorprivate RequestHandlerrequestHandlerprivate EventsRequestHandleruniqueEventsRequestHandlerprivate EventsRequestHandlersummedEventsRequestHandler
-
Constructor Summary
Constructors Constructor Description BacktraceApi(BacktraceCredentials credentials)Create a new instance of Backtrace API
-
Method Summary
Modifier and Type Method Description voidsetOnServerError(OnServerErrorEventListener onServerError)Set an event executed when received bad request, unauthorized request or other informationfrom server voidsetRequestHandler(RequestHandler requestHandler)Set custom request method to prepare HTTP request to Backtrace report API voidsetUniqueEventsRequestHandler(EventsRequestHandler uniqueEventsRequestHandler)Set the request handler for unique events voidsetSummedEventsRequestHandler(EventsRequestHandler summedEventsRequestHandler)Set the request handler for summed events voidsetUniqueEventsOnServerResponse(EventsOnServerResponseEventListener callback)Set a custom event to trigger when a unique events request gets a response from the Backtrace API voidsetSummedEventsOnServerResponse(EventsOnServerResponseEventListener callback)Set a custom event to trigger when a si,,ed events request gets a response from the Backtrace API UniqueEventsHandlerenableUniqueEvents(BacktraceMetrics backtraceMetrics)Create metrics events handler for unique events SummedEventsHandlerenableSummedEvents(BacktraceMetrics backtraceMetrics)Create metrics events handler for summed events voidsend(BacktraceData data, OnServerResponseEventListener callback)Sending synchronously a diagnostic report data to Backtrace server API. voidsendEventsPayload(UniqueEventsPayload payload)Send a Backtrace unique events payload to Backtrace events submission API voidsendEventsPayload(SummedEventsPayload payload)Send a Backtrace summed events payload to Backtrace events submission API -
-
Constructor Detail
-
BacktraceApi
BacktraceApi(BacktraceCredentials credentials)
Create a new instance of Backtrace API- Parameters:
credentials- API credentials
-
-
Method Detail
-
setOnServerError
void setOnServerError(OnServerErrorEventListener onServerError)
Set an event executed when received bad request, unauthorized request or other informationfrom 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
-
setUniqueEventsRequestHandler
void setUniqueEventsRequestHandler(EventsRequestHandler uniqueEventsRequestHandler)
Set the request handler for unique events
-
setSummedEventsRequestHandler
void setSummedEventsRequestHandler(EventsRequestHandler summedEventsRequestHandler)
Set the request handler for summed events
-
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
-
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
-
enableUniqueEvents
UniqueEventsHandler enableUniqueEvents(BacktraceMetrics backtraceMetrics)
Create metrics events handler for unique events
- Parameters:
backtraceMetrics- Backtrace metrics object
-
enableSummedEvents
SummedEventsHandler enableSummedEvents(BacktraceMetrics backtraceMetrics)
Create metrics events handler for summed events
- Parameters:
backtraceMetrics- Backtrace metrics object
-
send
void send(BacktraceData data, OnServerResponseEventListener callback)
Sending synchronously a diagnostic report data to Backtrace server 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
-
-
-
-