org.jivesoftware.smackx.bookmark
Class BookmarkedConference

java.lang.Object
  extended by org.jivesoftware.smackx.bookmark.BookmarkedConference
All Implemented Interfaces:
SharedBookmark

public class BookmarkedConference
extends java.lang.Object
implements SharedBookmark

Respresents a Conference Room bookmarked on the server using JEP-0048 Bookmark Storage JEP.

Author:
Derek DeMoro

Method Summary
 boolean equals(java.lang.Object obj)
           
 java.lang.String getJid()
          Returns the full JID of this conference room.
 java.lang.String getName()
          Returns the display label representing the Conference room.
 java.lang.String 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.
 boolean isAutoJoin()
          Returns true if this conference room should be auto-joined on startup.
 boolean isShared()
          Returns true if this bookmark is shared.
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getName

public java.lang.String getName()
Returns the display label representing the Conference room.

Returns:
the name of the conference room.

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.

getJid

public java.lang.String getJid()
Returns the full JID of this conference room. (ex.dev@conference.jivesoftware.com)

Returns:
the full JID of this conference room.

getNickname

public java.lang.String 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.

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.

equals

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

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.