com.rapidclipse.framework.server.webapi.network

Class Network

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<Network.NetworkTemplateModel>

com.rapidclipse.framework.server.webapi.network.Network

All Implemented Interfaces:

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

@HtmlImport(value="frontend://webapi/network.html")
 @Tag(value="rap-network")
public class Network
extends JavascriptTemplate<Network.NetworkTemplateModel>

This class lets you query the current devices network information. With this information you can for example determin how much data you want to sent to the client if the device is running on save data. You can also register listeners that are notified when this information changes.

Since:

10.02.00

Author:

XDEV Software

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Network.NetworkTemplateModel

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
com.vaadin.flow.shared.Registration	addNetworkInformationListener(com.vaadin.flow.function.SerializableConsumer<NetworkInformation> listener) Add a listener that will be notified when the network information of the current device has changed.
void	clearWatch() Clears the listeners registered with addNetworkInformationListener(SerializableConsumer) and stops the client from sending more network information change events.
static void	getNetworkInformation(Consumer<NetworkInformation> callback) Gather network information from the device and send it to the server via the onInformationReceived callback.

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

Network

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

Method Detail

addNetworkInformationListener

public com.vaadin.flow.shared.Registration addNetworkInformationListener(com.vaadin.flow.function.SerializableConsumer<NetworkInformation> listener)

Add a listener that will be notified when the network information of the current device has changed. The listener can be unregistered with the returned Registration.

Parameters:

listener - The listener that is triggered everytime the network information changes.

getNetworkInformation

public static void getNetworkInformation(Consumer<NetworkInformation> callback)

Gather network information from the device and send it to the server via the onInformationReceived callback.

Parameters:

callback - The callback that consumes the received network information.

clearWatch

public void clearWatch()

Clears the listeners registered with addNetworkInformationListener(SerializableConsumer) and stops the client from sending more network information change events.