Package com.vaadin.flow.component.page

Annotation Interface Push

@Retention(RUNTIME) @Target(TYPE) @Inherited public @interface Push
Configures automatic server push. The annotation should be placed on your AppShellConfigurator class. 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:

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    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 Details

    • value

      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:
      AUTOMATIC

    • transport

      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:
      WEBSOCKET_XHR