Package org.jivesoftware.smackx.muc

Class DiscussionHistory

  • @Deprecated
public class DiscussionHistory
extends Object
    Deprecated.
    use MucEnterConfiguration instead.
    The DiscussionHistory class controls the number of characters or messages to receive when entering a room. The room will decide the amount of history to return if you don't specify a DiscussionHistory while joining a room.

    You can use some or all of these variable to control the amount of history to receive:

    • maxchars -> total number of characters to receive in the history.
    • maxstanzas -> total number of messages to receive in the history.
    • seconds -> only the messages received in the last "X" seconds will be included in the history.
    • since -> only the messages received since the datetime specified will be included in the history.
    Note: Setting maxchars to 0 indicates that the user requests to receive no history.

    • Constructor Summary

      Constructors 
      Constructor Description
      DiscussionHistory()
      Deprecated.
       

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      int getMaxChars()
      Deprecated.
      Returns the total number of characters to receive in the history.
      int getMaxStanzas()
      Deprecated.
      Returns the total number of messages to receive in the history.
      int getSeconds()
      Deprecated.
      Returns the number of seconds to use to filter the messages received during that time.
      Date getSince()
      Deprecated.
      Returns the since date to use to filter the messages received during that time.
      void setMaxChars​(int maxChars)
      Deprecated.
      Sets the total number of characters to receive in the history.
      void setMaxStanzas​(int maxStanzas)
      Deprecated.
      Sets the total number of messages to receive in the history.
      void setSeconds​(int seconds)
      Deprecated.
      Sets the number of seconds to use to filter the messages received during that time.
      void setSince​(Date since)
      Deprecated.
      Sets the since date to use to filter the messages received during that time.

    • Method Detail

      • getMaxChars

        public int getMaxChars()
        Deprecated.
        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()
        Deprecated.
        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()
        Deprecated.
        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 Date getSince()
        Deprecated.
        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.

      • setMaxChars

        public void setMaxChars​(int maxChars)
        Deprecated.
        Sets the total number of characters to receive in the history.
        Parameters:
        maxChars - the total number of characters to receive in the history.

      • setMaxStanzas

        public void setMaxStanzas​(int maxStanzas)
        Deprecated.
        Sets the total number of messages to receive in the history.
        Parameters:
        maxStanzas - the total number of messages to receive in the history.

      • setSeconds

        public void setSeconds​(int seconds)
        Deprecated.
        Sets 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.
        Parameters:
        seconds - the number of seconds to use to filter the messages received during that time.

      • setSince

        public void setSince​(Date since)
        Deprecated.
        Sets 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.
        Parameters:
        since - the since date to use to filter the messages received during that time.