Method Detail

• enable

   abstract void enable()

  Enables metrics with BacktraceClient's credentials.

• enable

   abstract void enable(String defaultUniqueEventName)

  Enables metrics with BacktraceClient's credentials and a custom session user identifier.

  Parameters:

  defaultUniqueEventName - custom session user identifier

• enable

   abstract void enable(BacktraceMetricsSettings settings)

  Enable metrics

  Parameters:

  settings - for Backtrace metrics

• enable

   abstract void enable(BacktraceMetricsSettings settings, String defaultUniqueEventName)

  Enable metrics

  Parameters:

  settings - for Backtrace metrics

  defaultUniqueEventName - custom session user identifier

• send

   abstract void send()

  Send all outgoing messages (unique and summed) currently queued

• addUniqueEvent

   abstract boolean addUniqueEvent(String name)

  Add a unique event, such as UserID, SteamID and other attributes that uniquely identify auser. This list is persistent, meaning that events will not be removed upon Send(), as theyare for summed events. For non-standard unique events, server side configuration needs to bedone.Please refer to the online documentation at Error-Free Metrics

  Parameters:

  name - the name of the Unique event

• addUniqueEvent

   abstract boolean addUniqueEvent(String name, Map<String, Object> attributes)

  Add a unique event, such as UserID, SteamID and other attributes that uniquely identify auser. This list is persistent, meaning that events will not be removed upon Send(), as theyare for summed events. For non-standard unique events, server side configuration needs to bedone.Please refer to the online documentation at Error-Free Metrics

  Parameters:

  name - the name of the Unique event

  attributes - linked attributes which will update this unique event on update

• getUniqueEvents

   abstract ConcurrentLinkedDeque<UniqueEvent> getUniqueEvents()

  Get the pending list of unique events

• addSummedEvent

   abstract boolean addSummedEvent(String metricGroupName)

  Adds a summed event to the outgoing queue.

  Parameters:

  metricGroupName - name of the metric group to be incremented.

• addSummedEvent

   abstract boolean addSummedEvent(String metricGroupName, Map<String, Object> attributes)

  Adds a summed event to the outgoing queue.

  Parameters:

  metricGroupName - name of the metric group to be incremented.

  attributes - Custom attributes to add.

• getSummedEvents

   abstract ConcurrentLinkedDeque<SummedEvent> getSummedEvents()

  Get the pending list of summed events

• setMaximumNumberOfEvents

   abstract void setMaximumNumberOfEvents(int maximumNumberOfEvents)

  Set the maximum number of events to store. Once the maximum is hit we will send events tothe API

  Parameters:

  maximumNumberOfEvents - Maximum number of events to store before sending events tothe API

• count

   abstract int count()

  Return the total number of events in store

• sendStartupEvent

   abstract void sendStartupEvent()

  Send the startup event

• setUniqueEventsRequestHandler

   abstract void setUniqueEventsRequestHandler(EventsRequestHandler eventsRequestHandler)

  Custom request handler for sending Backtrace unique events to server

  Parameters:

  eventsRequestHandler - object with method which will be executed

• setSummedEventsRequestHandler

   abstract void setSummedEventsRequestHandler(EventsRequestHandler eventsRequestHandler)

  Custom request handler for sending Backtrace summed events to server

  Parameters:

  eventsRequestHandler - object with method which will be executed

• setUniqueEventsOnServerResponse

   abstract void setUniqueEventsOnServerResponse(EventsOnServerResponseEventListener callback)

  Custom callback to be executed on server response to a unique events submission request

  Parameters:

  callback - object with method which will be executed

• setSummedEventsOnServerResponse

   abstract void setSummedEventsOnServerResponse(EventsOnServerResponseEventListener callback)

  Custom callback to be executed on server response to a summed events submission request

  Parameters:

  callback - object with method which will be executed