Package com.vaadin.flow.component

Interface PollNotifier

All Superinterfaces:

Serializable

All Known Implementing Classes:

JavaScriptBootstrapUI, UI, WebComponentUI

public interface PollNotifier
extends Serializable

The interface for adding and removing PollEvent listeners.

By implementing this interface, a class publicly announces that it is able to send PollEvents whenever the client sends a periodic poll message to the client, to check for asynchronous server-side modifications.

Since:

1.0

See Also:

UI.setPollInterval(int)

Method Summary

Modifier and Type	Method	Description
default Registration	addPollListener(ComponentEventListener<PollEvent> listener)	Add a poll listener.

Method Detail

addPollListener

default Registration addPollListener(ComponentEventListener<PollEvent> listener)

Add a poll listener.

The listener is called whenever the client polls the server for asynchronous UI updates.

Parameters:

listener - the listener to add

Returns:

a handle that can be used for removing the listener

See Also:

UI.setPollInterval(int)