ly.count.sdk.java

Interface Event

public interface Event

Event interface. By default event is created with count=1 and all other fields empty or 0.

Method Summary

Modifier and Type	Method and Description
Event	addSegment(java.lang.String key, java.lang.String value) Add one segmentation entry to this event
Event	addSegments(java.lang.String... segmentation) Set event segmentation from
void	endAndRecord() Set timed Event duration as difference between moment Event was created and current time in seconds.
boolean	isInvalid() Whether event has been marked as invalid, meaning it won't be recorded
void	record() Add event to the buffer, send it to the server in case number of events in the session is equal or bigger than ConfigCore.eventsBufferSize or wait until next Session.update().
Event	setCount(int count) Overwrite default count=1 for this event
Event	setDuration(double duration) Set event duration
Event	setSegmentation(java.util.Map<java.lang.String,java.lang.String> segmentation) Set event segmentation from a map
Event	setSum(double sum) Set event sum

Method Detail

record

void record()

Add event to the buffer, send it to the server in case number of events in the session is equal or bigger than ConfigCore.eventsBufferSize or wait until next Session.update().

endAndRecord

void endAndRecord()

Set timed Event duration as difference between moment Event was created and current time in seconds. Then add the event to its session (if they're enabled), send it to the server in case number of events in the session is equal or bigger than ConfigCore.eventsBufferSize or wait until next Session.update().

addSegment

Event addSegment(java.lang.String key,
                 java.lang.String value)

Add one segmentation entry to this event

Parameters:

key - key of segment, must not be null or empty

value - value of segment, must not be null or empty

Returns:

this instance for method chaining

addSegments

Event addSegments(java.lang.String... segmentation)

Set event segmentation from

Parameters:

segmentation - set of strings in form of (key1, value1, key2, value2, ...) to set segmentation from; cannot contain nulls or empty strings; must have even length

Returns:

this instance for method chaining

setSegmentation

Event setSegmentation(java.util.Map<java.lang.String,java.lang.String> segmentation)

Set event segmentation from a map

Parameters:

segmentation - map of segment pairs ({key1: value1, key2: value2}

Returns:

this instance for method chaining

setCount

Event setCount(int count)

Overwrite default count=1 for this event

Parameters:

count - event count, cannot be 0

Returns:

this instance for method chaining

setSum

Event setSum(double sum)

Set event sum

Parameters:

sum - event sum

Returns:

this instance for method chaining

setDuration

Event setDuration(double duration)

Set event duration

Parameters:

duration - event duration

Returns:

this instance for method chaining

isInvalid

boolean isInvalid()

Whether event has been marked as invalid, meaning it won't be recorded

Returns:

true if event has been invalidated due to:

• Invalid data supplied (count < 0, NaN as sum, duration < 0, etc.) while in production mode
• Event has been already recorded in session, thus should be discarded