oracle.cloud.mobile.analytics

Class Event

java.lang.Object

oracle.cloud.mobile.analytics.Event

All Implemented Interfaces:

java.io.Serializable

public final class Event
extends java.lang.Object
implements java.io.Serializable

Represents the name, timestamp, and custom properties of a data object which can be logged with the analytics client using Analytics.logEvent(Event). Example :

 
    Map map = new HashMap();
    map.put("customEventPropertyKey", "customEventPropertyValue");
    Event event = new Event("Mobile SDK Event", new Date(), map);
 

 

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Event(java.lang.String name, java.util.Date timestamp, java.util.Map<java.lang.String,java.lang.String> properties) Creates a new event object with specified name, timestamp and custom properties.

Method Summary

Modifier and Type	Method and Description
void	addProperty(java.lang.String key, java.lang.String value) Adds a property to the existing Map of event properties.
java.lang.String	getName() Returns the name of the event.
java.util.Map<java.lang.String,java.lang.String>	getProperties() Returns properties associated with the event.
java.util.Date	getTimestamp() Returns the date that the event was recorded.
void	setTimestamp(java.util.Date timestamp) Sets the time at which the event was recorded.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Event

public Event(java.lang.String name,
             java.util.Date timestamp,
             java.util.Map<java.lang.String,java.lang.String> properties)

Creates a new event object with specified name, timestamp and custom properties.

Parameters:

name - Name of the event

timestamp - Time the event was recorded

properties - Custom Properties of the event

Method Detail

getProperties

public java.util.Map<java.lang.String,java.lang.String> getProperties()

Returns properties associated with the event.

Returns:

Map containing event properties

getTimestamp

public java.util.Date getTimestamp()

Returns the date that the event was recorded.

Returns:

Event Timestamp

setTimestamp

public void setTimestamp(java.util.Date timestamp)

Sets the time at which the event was recorded.

Parameters:

timestamp - Timestamp

getName

public java.lang.String getName()

Returns the name of the event.

Returns:

Name of the Event

addProperty

public void addProperty(java.lang.String key,
                        java.lang.String value)

Adds a property to the existing Map of event properties.

Parameters:

key - String key

value - Value to be stored against the key