Package es.situm.sdk.v1

Class SitumEvent

java.lang.Object

es.situm.sdk.v1.SitumEvent

All Implemented Interfaces:

android.os.Parcelable, MapperInterface

public class SitumEvent
extends java.lang.Object
implements android.os.Parcelable, MapperInterface

An event: POI with radius, conversion area and asociated statistics. It is intended for usage in marketing apps

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T extends java.lang.Object>, android.os.Parcelable.Creator<T extends java.lang.Object>

Field Summary

Fields

Modifier and Type	Field	Description
static android.os.Parcelable.Creator<SitumEvent>	CREATOR

Fields inherited from interface es.situm.sdk.model.MapperInterface

ACCESSIBILITY_MODE, ACCURACY, ADDRESS, ALTITUDE, BEARING, BEARING_FROM, BEARING_QUALITY, BOUNDS, BOUNDS_ROTATED, BUILDING, BUILDING_IDENTIFIER, BUILDING_NAME, CARTESIAN_BEARING, CARTESIAN_COORDINATE, CENTER, CLOSEST_LOCATION_IN_ROUTE, CODE, CONVERSION, COORDINATE, CREATED_AT, CURRENT_INDICATION, CURRENT_STEP_INDEX, CUSTOM_FIELDS, dateFormat, DEGREES, DEGREES_CLOCKWISE, DEVICE_ID, DIMENSIONS, DISTANCE, DISTANCE_TO_CHANGE_FLOOR_THRESHOLD, DISTANCE_TO_CHANGE_INDICATION_THRESHOLD, DISTANCE_TO_CLOSEST_POINT_IN_ROUTE, DISTANCE_TO_END_STEP, DISTANCE_TO_GOAL, DISTANCE_TO_GOAL_THRESHOLD, DISTANCE_TO_IGNORE_FIRST_INDICATION, DISTANCE_TO_NEXT_LEVEL, EDGES, EVENTS, EXCLUDED_TAGS, EXTERNAL_NAVIGATION_PAYLOAD, EXTERNAL_NAVIGATION_TYPE, FIRST_STEP, FLOOR, FLOOR_IDENTIFIER, FLOORS, FOREGROUND_SERVICE_NOTIFICATION_MESSAGE, FOREGROUND_SERVICE_NOTIFICATION_SHOW_STOP_ACTION, FOREGROUND_SERVICE_NOTIFICATION_STOP_ACTION_TEXT, FOREGROUND_SERVICE_NOTIFICATION_TAP_ACTION, FOREGROUND_SERVICE_NOTIFICATION_TITLE, FROM, GEOFENCES, HAS_BEARING, HAS_CARTESIAN_BEARING, HEIGHT, HUMAN_READABLE_MESSAGE, ID, IDENTIFIER, IGNORE_LOW_QUALITY_LOCATIONS, INCLUDED_TAGS, INDICATION_TYPE, INDICATIONS, INDICATIONS_INTERVAL, INDOOR_POIS, INFO_HTML, IS_FIRST, IS_INDOOR, IS_LAST, IS_OUTDOOR, IS_PUBLIC, LAST_STEP, LATITUDE, LONGITUDE, MAP_URL, MINIMIZE_FLOOR_CHANGES, NAME, NEEDED_LEVEL_CHANGE, NEXT_INDICATION, NEXT_LEVEL, NODES, NORTH_EAST, NORTH_WEST, ORIENTATION, ORIENTATION_TYPE, OUTDOOR_BUILDING_DETECTOR_BLE, OUTDOOR_POIS, OUTSIDE_ROUTE_THRESHOLD, PICTURE_THUMB_URL, PICTURE_URL, POI_CATEGORIES, POI_CATEGORY, POI_CATEGORY_CODE, POI_CATEGORY_ICON_SELECTED, POI_CATEGORY_ICON_UNSELECTED, POI_CATEGORY_IDENTIFIER, POI_CATEGORY_IDENTIFIERS, POI_CATEGORY_iNAME, POI_CATEGORY_NAME, POI_NAME, POI_TO, POI_TO_IDENTIFIER, POINTS, POLYGON_POINTS, POSITION, PROVIDER, QUALITY, RADIANS, RADIANS_MINUS_PI_PI, RADIUS, ROTATION, ROUND_INDICATIONS_STEP, ROUTE, ROUTE_STEP, SCALE, SEGMENTS, SOUTH_EAST, SOUTH_WEST, STATUS_NAME, STATUS_ORDINAL, STEP_IDX_DESTINATION, STEP_IDX_ORIGIN, STEPS, TIME_TO_END_STEP, TIME_TO_FIRST_INDICATION, TIME_TO_GOAL, TIME_TO_IGNORE_UNEXPECTED_FLOOR_CHANGES, TIMESTAMP, TO, TO_LEGACY, TRIGGER, UPDATED_AT, USER_IDENTIFIER, WIDTH, X, Y

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor	Description
SitumEvent()

Method Summary

Modifier and Type	Method	Description
int	describeContents()
int	getBuildingId()	Deprecated. Use getTrigger()
Circle	getConversion()	Returns the conversion area of the event.
SitumConversionArea	getConversionArea()	Deprecated. Use getConversion()
java.util.Map<java.lang.String,java.lang.String>	getCustomFields()	Obtain a map with the custom fields for the current event.
int	getFloor_id()	Deprecated. Use getTrigger()
java.lang.String	getHtml()
int	getId()
java.lang.String	getName()
float	getRadius()	Deprecated. Use getTrigger()
Circle	getTrigger()	Returns the trigger area of the event
float	getX()	Deprecated. Use getTrigger()
float	getY()	Deprecated. Use getTrigger()
boolean	notifyClicked(android.content.Context applicationContext, java.lang.String phoneid)	Deprecated. use CommunicationManager.eventClicked(EventOccurrence, Map, Handler) instead
boolean	notifyConverted(android.content.Context context, java.lang.String phoneid)	Deprecated. use CommunicationManager.eventConverted(EventOccurrence, Map, Handler) instead
boolean	notifySeen(android.content.Context context, java.lang.String phoneId)	Deprecated. use CommunicationManager.eventSeen(SitumEvent, Map, Handler) instead
void	setId(int id)	Just for internal SDK use.
java.util.Map<java.lang.String,java.lang.Object>	toMap()	Method to transform object into Map
java.lang.String	toString()
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CREATOR

public static final android.os.Parcelable.Creator<SitumEvent> CREATOR

Constructor Detail

SitumEvent

public SitumEvent()

Method Detail

notifySeen

@Deprecated
public boolean notifySeen(android.content.Context context,
                          java.lang.String phoneId)

Deprecated.

use CommunicationManager.eventSeen(SitumEvent, Map, Handler) instead

Parameters:

context - Application context for sending the notification

phoneId - Phone identifier+

notifyClicked

@Deprecated
public boolean notifyClicked(android.content.Context applicationContext,
                             java.lang.String phoneid)

Deprecated.

use CommunicationManager.eventClicked(EventOccurrence, Map, Handler) instead

Parameters:

applicationContext - Application context for sending the notification

phoneid - Phone identifier

notifyConverted

@Deprecated
public boolean notifyConverted(android.content.Context context,
                               java.lang.String phoneid)

Deprecated.

use CommunicationManager.eventConverted(EventOccurrence, Map, Handler) instead

Notify a conversion

Parameters:

context - Application context for sending the notification

phoneid - Phone identifier

getBuildingId

public int getBuildingId()

Deprecated.

Use getTrigger()

getId

public int getId()

setId

public void setId(int id)

Just for internal SDK use.

getFloor_id

public int getFloor_id()

Deprecated.

Use getTrigger()

getX

public float getX()

Deprecated.

Use getTrigger()

getY

public float getY()

Deprecated.

Use getTrigger()

getRadius

public float getRadius()

Deprecated.

Use getTrigger()

getName

public java.lang.String getName()

getHtml

public java.lang.String getHtml()

getConversionArea

public SitumConversionArea getConversionArea()

Deprecated.

Use getConversion()

getConversion

@Nullable
public Circle getConversion()

Returns the conversion area of the event. It will be null if no conversion area is defined.

getTrigger

public Circle getTrigger()

Returns the trigger area of the event

getCustomFields

@NonNull
public java.util.Map<java.lang.String,java.lang.String> getCustomFields()

Obtain a map with the custom fields for the current event. The returned map never is null but can be empty if not custom fields are specified in the dashboard

Returns:

Map with the custom fields for the current event

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable

toMap

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

Description copied from interface: MapperInterface

Method to transform object into Map

Specified by:

toMap in interface MapperInterface

Returns:

Map with the information of the object mapped