Interface TypingUpdatesBuffer

  • All Implemented Interfaces:

    
    public interface TypingUpdatesBuffer
    
                        

    Designed to buffer typing inputs.

    Its implementation should receive keystroke events by calling TypingUpdatesBuffer.onKeystroke which it will internally buffer and send start and stop typing API calls accordingly. This cuts down on unnecessary API calls.

    For the default implementation see DefaultTypingUpdatesBuffer.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Field Summary

      Fields 
      Modifier and Type Field Description
    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      abstract Unit onKeystroke(String inputText) Should be called on every input change.
      abstract Unit clear() Should send a stop typing event manually.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

    • Method Detail

      • onKeystroke

         abstract Unit onKeystroke(String inputText)

        Should be called on every input change.

        Parameters:
        inputText - the current input text.
      • clear

         abstract Unit clear()

        Should send a stop typing event manually.

        Useful for runtime hygiene such as responding to lifecycle events.