org.intellimate.izou.sdk.frameworks.presence.events

Class PresenceEvent

java.lang.Object

org.intellimate.izou.sdk.events.Event

org.intellimate.izou.sdk.frameworks.presence.events.PresenceEvent

All Implemented Interfaces:

EventModel<Event>, Identifiable

public class PresenceEvent
extends Event

this event indicates presence

Version:

1.0

Author:

LeanderK

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIRST_ENCOUNTER_DESCRIPTOR Means that the Addon encountered the user the first time IN THE SPECIFIED MODE (Strict/General) since he left.
static String	GENERAL_DESCRIPTOR this event does not mean the user is able to notice anything (can be used for warm-up), it indicates he might be
static String	ID it means that the addon can guarantee that the user entered an area near izou
static String	KNOWN_DESCRIPTOR it means that the user entered an area near izou
static String	STRICT_DESCRIPTOR it means that the addon can guarantee that the user entered an area near izou
static String	UNKNOWN_DESCRIPTOR it means that someone entered an area near izou, but it is not clear if it is the user,

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PresenceEvent(Identification source, List<String> descriptors) Creates a new Event Object

Method Summary

Modifier and Type	Method and Description
static Optional<PresenceEvent>	createPresenceEvent(Identification source, boolean strict, boolean known, boolean firstEncounter, List<String> descriptors) creates a new PresenceEvent
static Optional<PresenceEvent>	createPresenceEvent(Identification source, boolean strict, boolean known, boolean firstEncounter, List<String> descriptors, Long timePassed) creates a new PresenceEvent

Methods inherited from class org.intellimate.izou.sdk.events.Event

addDescriptor, addEventLifeCycleListener, addResource, addResources, containsDescriptor, createEvent, createEvent, getAllInformations, getDescriptors, getEventBehaviourController, getID, getListResourceContainer, getSource, getType, lifecycleCallback, replaceDescriptors, setDescriptors, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.intellimate.izou.identification.Identifiable

isOwner

Field Detail

GENERAL_DESCRIPTOR

public static final String GENERAL_DESCRIPTOR

this event does not mean the user is able to notice anything (can be used for warm-up), it indicates he might be

See Also:

Constant Field Values

STRICT_DESCRIPTOR

public static final String STRICT_DESCRIPTOR

it means that the addon can guarantee that the user entered an area near izou

See Also:

Constant Field Values

UNKNOWN_DESCRIPTOR

public static final String UNKNOWN_DESCRIPTOR

it means that someone entered an area near izou, but it is not clear if it is the user,

See Also:

Constant Field Values

KNOWN_DESCRIPTOR

public static final String KNOWN_DESCRIPTOR

it means that the user entered an area near izou

See Also:

Constant Field Values

FIRST_ENCOUNTER_DESCRIPTOR

public static final String FIRST_ENCOUNTER_DESCRIPTOR

Means that the Addon encountered the user the first time IN THE SPECIFIED MODE (Strict/General) since he left.

See Also:

Constant Field Values

ID

public static final String ID

it means that the addon can guarantee that the user entered an area near izou

See Also:

Constant Field Values

Constructor Detail

PresenceEvent

protected PresenceEvent(Identification source,
                        List<String> descriptors)
                 throws IllegalArgumentException

Creates a new Event Object

Parameters:

source - the source of the Event, most likely a this reference.

descriptors - the descriptors to initialize the Event with

Throws:

IllegalArgumentException - if one of the Arguments is null or empty

Method Detail

createPresenceEvent

public static Optional<PresenceEvent> createPresenceEvent(Identification source,
                                                          boolean strict,
                                                          boolean known,
                                                          boolean firstEncounter,
                                                          List<String> descriptors)

creates a new PresenceEvent

Parameters:

source - the caller

strict - whether the addon can guarantee that the user is around

known - true if the addon knows if the person encountered is the (main) user

firstEncounter - if the user was first encountered in the specified mode

descriptors - the descriptors

Returns:

the optional PresenceEvent

createPresenceEvent

public static Optional<PresenceEvent> createPresenceEvent(Identification source,
                                                          boolean strict,
                                                          boolean known,
                                                          boolean firstEncounter,
                                                          List<String> descriptors,
                                                          Long timePassed)

creates a new PresenceEvent

Parameters:

source - the caller

strict - whether the addon can guarantee that the user is around

known - true if the addon knows if the person encountered is the (main) user

firstEncounter - if the user was first encountered in the specified mode

descriptors - the descriptors

timePassed - the time passed in seconds since the user was last encountered

Returns:

the optional PresenceEvent