Class AuEcho


  • public class AuEcho
    extends AuResponse
    A response to ask client to send a dummy request back to the server.

    It is used by UiEngine to solve a special case.

    There are two formats

    • data[0]: desktop Id
    • data[0]: the component's UUID
      data[1]: the event name
      data[2]: the extra data
    Since:
    3.0.0
    Author:
    tomyeh
    • Constructor Detail

      • AuEcho

        public AuEcho​(Desktop desktop)
        Constructs an echo response with the specified desktop.
        Parameters:
        desktop - the desktop to send the echo response to. If null, the echo response is sent to each desktop in the same browser window.
        Since:
        3.0.0
      • AuEcho

        public AuEcho()
        Constructs an echo response for each desktop in the same browser window
      • AuEcho

        public AuEcho​(Component comp,
                      java.lang.String evtnm,
                      java.lang.String data)
        Constructs an echo response that will cause an event to fire when the client echoes back.

        It is the same as AuEcho(comp, evtnm, (Object)data).

        Since:
        3.0.2
      • AuEcho

        public AuEcho​(Component comp,
                      java.lang.String evtnm,
                      java.lang.Object data)
        Constructs an echo response that will cause an event to fire when the client echoes back.
        Parameters:
        comp - the component to echo the event to (never null).
        evtnm - the event name
        data - the extra information, or null if not available
        Since:
        5.0.4
    • Method Detail

      • getData

        public static java.lang.Object getData​(Component comp,
                                               java.lang.Object key)
        Retrieves the data associated with an echo event. Notice that the data will be removed, so the next call always returns null.
        Since:
        5.0.4