com.rapidclipse.framework.server.webapi.online

Class Online

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.polymertemplate.AbstractTemplate<M>

com.vaadin.flow.component.polymertemplate.PolymerTemplate<M>

com.rapidclipse.framework.server.webapi.JavascriptTemplate<Online.OnlineTemplateModel>

com.rapidclipse.framework.server.webapi.online.Online

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, Serializable

@HtmlImport(value="frontend://webapi/online.html")
 @Tag(value="rap-online")
public class Online
extends JavascriptTemplate<Online.OnlineTemplateModel>

With this class you can check the current online status of the device. More importantly you can register listeners for when the device goes online or offline.

Since:

10.02.00

Author:

XDEV Software

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Online.OnlineTemplateModel

Constructor Summary

Constructors

Constructor and Description
Online(com.vaadin.flow.component.HasElement parent)

Method Summary

Modifier and Type	Method and Description
com.vaadin.flow.shared.Registration	addOnlineListener(com.vaadin.flow.function.SerializableConsumer<OnlineState> onOnline) Register an online listener.
static void	getOnlineState(com.vaadin.flow.function.SerializableConsumer<OnlineState> onStateReceived) Get the current OnLine state of the device (The state can not be retrieved while the client is offline).
void	unregisterAllOnlineListeners() This method can be used to unregister previously registered onOnLine listeners.

Methods inherited from class com.rapidclipse.framework.server.webapi.JavascriptTemplate

clearConsumers, notifyConsumers, registerConsumer, registerConsumer, unregisterAllConsumers, unregisterAllConsumers

Methods inherited from class com.vaadin.flow.component.polymertemplate.PolymerTemplate

getChildren

Methods inherited from class com.vaadin.flow.component.polymertemplate.AbstractTemplate

getModel, getModelType, getModelType, getStateNode, initModel, isSupportedClass

Methods inherited from class com.vaadin.flow.component.Component

addListener, fireEvent, from, get, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getUI, hasListener, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, set, setElement, setId, setVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Constructor Detail

Online

public Online(com.vaadin.flow.component.HasElement parent)

Method Detail

addOnlineListener

public com.vaadin.flow.shared.Registration addOnlineListener(com.vaadin.flow.function.SerializableConsumer<OnlineState> onOnline)

Register an online listener. This listener is triggered when the client comes back online after being offline or vice versa. To unregister this event you can either use the returned Registration or by calling unregisterAllOnlineListeners().

unregisterAllOnlineListeners

public void unregisterAllOnlineListeners()

This method can be used to unregister previously registered onOnLine listeners. This will also stop the client from sending more events to the server. To register an onOnLine listener you can call the #addOnLineListener(Runnable) method.

getOnlineState

public static void getOnlineState(com.vaadin.flow.function.SerializableConsumer<OnlineState> onStateReceived)

Get the current OnLine state of the device (The state can not be retrieved while the client is offline).

Parameters:

onStateReceived - The callback triggered when the state is received. It consumes the current onLine state.