org.intellimate.izou.sdk.frameworks.presence.consumer

Interface PresenceEventUser

All Superinterfaces:

ContextProvider

public interface PresenceEventUser
extends ContextProvider

provides various methods to get notified when the presence event got fired.

Version:

1.0

Author:

LeanderK

Method Summary

Modifier and Type	Method and Description
default CompletableFuture<EventModel>	nextLeaving(boolean strict) returns a CompletableFuture, that completes when the next specified leaving-event was fired
default CompletableFuture<EventModel>	nextPresence(boolean strict, boolean known) returns a CompletableFuture, that completes when the next specified presence-event was fired
default CompletableFuture<EventModel>	nextPresence(boolean strict, boolean known, boolean firstEncounter) returns a CompletableFuture, that completes when the next specified presence-event was fired
default EventListenerModel	registerLeavingCallback(java.util.function.Consumer<EventModel> callback, boolean strict) registers the the passed Consumer as a callback which will be called when an leaving event was fired.
default EventListenerModel	registerPresenceCallback(java.util.function.Consumer<EventModel> callback, boolean strict, boolean known) registers the the passed Consumer as a callback which will be called when an presence event was fired.
default EventListenerModel	registerPresenceCallback(java.util.function.Consumer<EventModel> callback, boolean strict, boolean known, boolean firstEncounter) registers the the passed Consumer as a callback which will be called when an presence event was fired.

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

debug, debug, error, error, getContext

Method Detail

registerPresenceCallback

default EventListenerModel registerPresenceCallback(java.util.function.Consumer<EventModel> callback,
                                                    boolean strict,
                                                    boolean known)

registers the the passed Consumer as a callback which will be called when an presence event was fired.

You must unregister the returned EventListenerModel when you are not using the Callback anymore!

Parameters:

callback - the callback to use

strict - whether the callback should only be fired when the addon when the user is very likely near izou

known - whether the callback should only be fired when the person causing the evens is very likely the user

Returns:

the EventListener used to unregister at the Context

registerPresenceCallback

default EventListenerModel registerPresenceCallback(java.util.function.Consumer<EventModel> callback,
                                                    boolean strict,
                                                    boolean known,
                                                    boolean firstEncounter)

registers the the passed Consumer as a callback which will be called when an presence event was fired.

You must unregister the returned EventListenerModel when you are not using the Callback anymore!

Parameters:

callback - the callback to use

strict - whether the callback should only be fired when the addon when the user is very likely near izou

known - whether the callback should only be fired when the person causing the evens is very likely the user

firstEncounter - whether the callback should only be fired when its the first encounter after the user left

Returns:

the EventListener used to unregister at the Context

nextPresence

default CompletableFuture<EventModel> nextPresence(boolean strict,
                                                   boolean known)

returns a CompletableFuture, that completes when the next specified presence-event was fired

Parameters:

strict - whether it is very likely that the user is near

known - whether it is very likely that the person causing the event is the user

Returns:

an instance of CompletableFuture

nextPresence

default CompletableFuture<EventModel> nextPresence(boolean strict,
                                                   boolean known,
                                                   boolean firstEncounter)

returns a CompletableFuture, that completes when the next specified presence-event was fired

Parameters:

strict - whether it is very likely that the user is near

known - whether it is very likely that the person causing the event is the user

firstEncounter - whether any other than the first encounter after the user left should be ignored

Returns:

an instance of CompletableFuture

registerLeavingCallback

default EventListenerModel registerLeavingCallback(java.util.function.Consumer<EventModel> callback,
                                                   boolean strict)

registers the the passed Consumer as a callback which will be called when an leaving event was fired.

You must unregister the returned EventListenerModel when you are not using the Callback anymore!

Parameters:

callback - the callback to use

strict - whether the callback should only be fired when the addon when the user was very likely near izou

Returns:

the EventListener used to unregister at the Context

nextLeaving

default CompletableFuture<EventModel> nextLeaving(boolean strict)

returns a CompletableFuture, that completes when the next specified leaving-event was fired

Parameters:

strict - whether it is very likely that the user was near

Returns:

an instance of CompletableFuture