com.vaadin.flow.component.page

Annotation Type Push

@Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface Push

Configures automatic server push for a root navigation target (or custom UI). If some other push mode is desired, it can be passed as a parameter, e.g. @Push(PushMode.MANUAL).

Since:

1.0.

Author:

Vaadin Ltd

See Also:

PushMode, Route, RoutePrefix, RouterLayout

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Transport	transport Transport type used for the push for the annotated root navigation target (or custom UI).
PushMode	value The PushMode to use for the annotated root navigation target (or custom UI).

Element Detail

value

public abstract PushMode value

The PushMode to use for the annotated root navigation target (or custom UI). The default push mode when this annotation is present is PushMode.AUTOMATIC.

Returns:

the push mode to use

Default:

com.vaadin.flow.shared.communication.PushMode.AUTOMATIC

transport

public abstract Transport transport

Transport type used for the push for the annotated root navigation target (or custom UI). The default transport type when this annotation is present is Transport.WEBSOCKET_XHR.

Returns:

the transport type to use

Default:

com.vaadin.flow.shared.ui.Transport.WEBSOCKET_XHR