org.intellimate.izou.sdk.frameworks.presence.provider

Interface PresenceProvider

All Superinterfaces:

ContextProvider, EventListenerModel, Identifiable, PresenceResourceHelper, ResourceUser

All Known Subinterfaces:

PresenceHelper, PresenceResourceProvider

All Known Implementing Classes:

PresenceConstant

public interface PresenceProvider
extends PresenceResourceHelper, Identifiable, EventListenerModel, ResourceUser

util class to provide information about the type of presence this addon can guarantee. You have to register the class implementing this interface as a EventListenerModel

Version:

1.0

Author:

LeanderK

Method Summary

Modifier and Type	Method and Description
default void	eventFired(EventModel event) Invoked when an activator-event occurs.
PresenceIndicatorLevel	getLevel() gets the PresenceIndicatorLevel of the addon (mainly used for communication between presence-providing addons)
boolean	isFirstEncountering() returns true if the user is first encountered in the current mode
boolean	isKnown() whether it is known that the user caused the presence
boolean	isPresent() returns true if the user might be/is present
boolean	isStrict() true if the addon can guarantee that the user is around, false if not
void	setGlobalPresent(boolean present) when this method is called the present-status was changed
void	setGlobalStrictPresent(boolean present) when this method is called, the strict-present status was changed

Methods inherited from interface org.intellimate.izou.sdk.frameworks.presence.resources.PresenceResourceHelper

getIsPresent, nonStrictAvailable

Methods inherited from interface org.intellimate.izou.sdk.util.ResourceUser

generateResource, generateResource

Methods inherited from interface org.intellimate.izou.sdk.util.ContextProvider

debug, debug, error, error, getContext

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

getID, isOwner

Method Detail

isStrict

boolean isStrict()

true if the addon can guarantee that the user is around, false if not

Returns:

true if it can guarantee it, false if not

getLevel

PresenceIndicatorLevel getLevel()

gets the PresenceIndicatorLevel of the addon (mainly used for communication between presence-providing addons)

Returns:

the Level

isPresent

boolean isPresent()

returns true if the user might be/is present

Returns:

true if present

isKnown

boolean isKnown()

whether it is known that the user caused the presence

Returns:

true if known, false if not

setGlobalPresent

void setGlobalPresent(boolean present)

when this method is called the present-status was changed

Parameters:

present - true if present, false if not

isFirstEncountering

boolean isFirstEncountering()

returns true if the user is first encountered in the current mode

setGlobalStrictPresent

void setGlobalStrictPresent(boolean present)

when this method is called, the strict-present status was changed

Parameters:

present - true if present, false if not

eventFired

default void eventFired(EventModel event)

Invoked when an activator-event occurs.

Specified by:

eventFired in interface EventListenerModel

Parameters:

event - an instance of Event