Package org.jivesoftware.smackx.bookmarks

Class BookmarkedConference

  • All Implemented Interfaces:
    SharedBookmark
    public class BookmarkedConference
extends java.lang.Object
implements SharedBookmark
    Represents a Conference Room bookmarked on the server using XEP-0048 Bookmark Storage XEP.

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected BookmarkedConference​(java.lang.String name, org.jxmpp.jid.EntityBareJid jid, boolean autoJoin, org.jxmpp.jid.parts.Resourcepart nickname, java.lang.String password)  
      protected BookmarkedConference​(org.jxmpp.jid.EntityBareJid jid)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      org.jxmpp.jid.EntityBareJid getJid()
      Returns the full JID of this conference room.
      java.lang.String getName()
      Returns the display label representing the Conference room.
      org.jxmpp.jid.parts.Resourcepart getNickname()
      Returns the nickname to use when joining this conference room.
      java.lang.String getPassword()
      Returns the password to use when joining this conference room.
      int hashCode()  
      boolean isAutoJoin()
      Returns true if this conference room should be auto-joined on startup.
      boolean isShared()
      Returns true if this bookmark is shared.
      protected void setAutoJoin​(boolean autoJoin)  
      protected void setName​(java.lang.String name)  
      protected void setNickname​(org.jxmpp.jid.parts.Resourcepart nickname)  
      protected void setPassword​(java.lang.String password)  
      protected void setShared​(boolean isShared)  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • BookmarkedConference

        protected BookmarkedConference​(org.jxmpp.jid.EntityBareJid jid)

      • BookmarkedConference

        protected BookmarkedConference​(java.lang.String name,
                               org.jxmpp.jid.EntityBareJid jid,
                               boolean autoJoin,
                               org.jxmpp.jid.parts.Resourcepart nickname,
                               java.lang.String password)

    • Method Detail

      • getName

        public java.lang.String getName()
        Returns the display label representing the Conference room.
        Returns:
        the name of the conference room.

      • setName

        protected void setName​(java.lang.String name)

      • isAutoJoin

        public boolean isAutoJoin()
        Returns true if this conference room should be auto-joined on startup.
        Returns:
        true if room should be joined on startup, otherwise false.

      • setAutoJoin

        protected void setAutoJoin​(boolean autoJoin)

      • getJid

        public org.jxmpp.jid.EntityBareJid getJid()
        Returns the full JID of this conference room. (ex.dev@conference.jivesoftware.com)
        Returns:
        the full JID of this conference room.

      • getNickname

        public org.jxmpp.jid.parts.Resourcepart getNickname()
        Returns the nickname to use when joining this conference room. This is an optional value and may return null.
        Returns:
        the nickname to use when joining, null may be returned.

      • setNickname

        protected void setNickname​(org.jxmpp.jid.parts.Resourcepart nickname)

      • getPassword

        public java.lang.String getPassword()
        Returns the password to use when joining this conference room. This is an optional value and may return null.
        Returns:
        the password to use when joining this conference room, null may be returned.

      • setPassword

        protected void setPassword​(java.lang.String password)

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • setShared

        protected void setShared​(boolean isShared)

      • isShared

        public boolean isShared()
        Description copied from interface: SharedBookmark
        Returns true if this bookmark is shared.
        Specified by:
        isShared in interface SharedBookmark
        Returns:
        returns true if this bookmark is shared.