Package org.jivesoftware.smackx.muc.packet

Class MUCInitialPresence.History

  • All Implemented Interfaces:
    org.jivesoftware.smack.packet.Element, org.jivesoftware.smack.packet.NamedElement
    Enclosing class:
    MUCInitialPresence
    public static class MUCInitialPresence.History
extends java.lang.Object
implements org.jivesoftware.smack.packet.NamedElement
    The History class controls the number of characters or messages to receive when entering a room.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ELEMENT  

    • Constructor Summary

      Constructors 
      Constructor Description
      History​(int maxChars, int maxStanzas, int seconds, java.util.Date since)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getElementName()  
      int getMaxChars()
      Returns the total number of characters to receive in the history.
      int getMaxStanzas()
      Returns the total number of messages to receive in the history.
      int getSeconds()
      Returns the number of seconds to use to filter the messages received during that time.
      java.util.Date getSince()
      Returns the since date to use to filter the messages received during that time.
      org.jivesoftware.smack.util.XmlStringBuilder toXML​(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface org.jivesoftware.smack.packet.Element

        toXML, toXML

    • Constructor Detail

      • History

        public History​(int maxChars,
               int maxStanzas,
               int seconds,
               java.util.Date since)

    • Method Detail

      • getMaxChars

        public int getMaxChars()
        Returns the total number of characters to receive in the history.
        Returns:
        total number of characters to receive in the history.

      • getMaxStanzas

        public int getMaxStanzas()
        Returns the total number of messages to receive in the history.
        Returns:
        the total number of messages to receive in the history.

      • getSeconds

        public int getSeconds()
        Returns the number of seconds to use to filter the messages received during that time. In other words, only the messages received in the last "X" seconds will be included in the history.
        Returns:
        the number of seconds to use to filter the messages received during that time.

      • getSince

        public java.util.Date getSince()
        Returns the since date to use to filter the messages received during that time. In other words, only the messages received since the datetime specified will be included in the history.
        Returns:
        the since date to use to filter the messages received during that time.

      • toXML

        public org.jivesoftware.smack.util.XmlStringBuilder toXML​(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace)
        Specified by:
        toXML in interface org.jivesoftware.smack.packet.Element

      • getElementName

        public java.lang.String getElementName()
        Specified by:
        getElementName in interface org.jivesoftware.smack.packet.NamedElement