Contact us
Create app
You're viewing an older version of Vaadin JavaDoc. Please see version 24.7.0 for the latest.
com.vaadin.flow.component.

Interface ReconnectDialogConfiguration

    • Method Summary

      All Methods
      Modifier and Type Method Description
      String getDialogText()

      Gets the text to show in the reconnect dialog when trying to re-establish the server connection.
      String getDialogTextGaveUp()

      Gets the text to show in the reconnect dialog after giving up trying to reconnect (getReconnectAttempts() reached).
      int getReconnectAttempts()

      Gets the number of times to try to reconnect to the server before giving up.
      int getReconnectInterval()

      Gets the interval (in milliseconds) between reconnect attempts.
      void setDialogText​(String dialogText)

      Sets the text to show in the reconnect dialog when trying to re-establish the server connection.
      void setDialogTextGaveUp​(String dialogTextGaveUp)

      Sets the text to show in the reconnect dialog after giving up trying to reconnect (getReconnectAttempts() reached).
      void setReconnectAttempts​(int reconnectAttempts)

      Sets the number of times to try to reconnect to the server before giving up.
      void setReconnectInterval​(int reconnectInterval)

      Sets the interval (in milliseconds) between reconnect attempts.

    • Method Detail

      • getDialogText

        String getDialogText()

        Gets the text to show in the reconnect dialog when trying to re-establish the server connection.

        The default is "Connection lost, trying to reconnect..."

        Returns:

        the text to show in the reconnect dialog

      • setDialogText

        void setDialogText​(String dialogText)

        Sets the text to show in the reconnect dialog when trying to re-establish the server connection.

        Parameters:

        dialogText - the text to show in the reconnect dialog

      • getDialogTextGaveUp

        String getDialogTextGaveUp()

        Gets the text to show in the reconnect dialog after giving up trying to reconnect (getReconnectAttempts() reached).

        The default is "Connection lost"

        Returns:

        the text to show in the reconnect dialog after giving up

      • setDialogTextGaveUp

        void setDialogTextGaveUp​(String dialogTextGaveUp)

        Sets the text to show in the reconnect dialog after giving up trying to reconnect (getReconnectAttempts() reached).

        Parameters:

        dialogTextGaveUp - the text to show in the reconnect dialog after giving up

      • getReconnectAttempts

        int getReconnectAttempts()

        Gets the number of times to try to reconnect to the server before giving up.

        The default is 10000

        Returns:

        the number of times to try to reconnect

      • setReconnectAttempts

        void setReconnectAttempts​(int reconnectAttempts)

        Sets the number of times to try to reconnect to the server before giving up.

        Parameters:

        reconnectAttempts - the number of times to try to reconnect

      • getReconnectInterval

        int getReconnectInterval()

        Gets the interval (in milliseconds) between reconnect attempts.

        The default is 5000

        Returns:

        the interval (in ms) between reconnect attempts

      • setReconnectInterval

        void setReconnectInterval​(int reconnectInterval)

        Sets the interval (in milliseconds) between reconnect attempts.

        Parameters:

        reconnectInterval - the interval (in ms) between reconnect attempts