com.vaadin.flow.component.page.

Annotation Type Push


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

    Configures server push for a UI. Adding @Push to a UI class configures the UI for automatic push. 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

    • Optional Element Summary

      Optional Elements
      Modifier and Type Optional Element and Description
      Transport transport

      Returns the transport type used for the push for the annotated UI.
      PushMode value

      Returns the PushMode to use for the annotated UI.

    • Element Detail

      • value

        public abstract PushMode value

        Returns the PushMode to use for the annotated 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

        Returns the transport type used for the push for the annotated 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