Packageorg.igniterealtime.xiff.bookmark
Classpublic class BookmarkManager
InheritanceBookmarkManager Inheritance flash.events.EventDispatcher

XEP-0048: Bookmarks

See also

http://xmpp.org/extensions/xep-0048.html

Public Properties
 PropertyDefined By
  bookmarks : BookmarkPrivatePayload
[read-only]
BookmarkManager
Public Methods
 MethodDefined By
  
BookmarkManager(privateDataManager:PrivateDataManager)
BookmarkManager
  
addGroupChatBookmark(serverBookmark:GroupChatBookmark):void
BookmarkManager
  
fetchBookmarks():void
BookmarkManager
  
getGroupChatBookmark(jid:UnescapedJID):GroupChatBookmark
Get a group chat bookmark with the given JID
BookmarkManager
  
isGroupChatBookmarked(jid:UnescapedJID):Boolean
Does there exist a group chat bookmark with the given JID
BookmarkManager
  
removeGroupChatBookmark(jid:UnescapedJID):void
Remove
BookmarkManager
  
setAutoJoin(jid:UnescapedJID, state:Boolean):void
Set autoJoin for the given bookmark JID
BookmarkManager
Events
 Event Summary Defined By
  
bookmarkRetrieved
BookmarkManager
  
groupchatBookmarkAdded
 BookmarkManager
  
groupchatBookmarkRemoved
 BookmarkManager
Property Detail
bookmarksproperty
bookmarks:BookmarkPrivatePayload  [read-only]


Implementation
    public function get bookmarks():BookmarkPrivatePayload
Constructor Detail
BookmarkManager()Constructor
public function BookmarkManager(privateDataManager:PrivateDataManager)

Parameters
privateDataManager:PrivateDataManager
Method Detail
addGroupChatBookmark()method
public function addGroupChatBookmark(serverBookmark:GroupChatBookmark):void

Parameters

serverBookmark:GroupChatBookmark

fetchBookmarks()method 
public function fetchBookmarks():void

getGroupChatBookmark()method 
public function getGroupChatBookmark(jid:UnescapedJID):GroupChatBookmark

Get a group chat bookmark with the given JID

Parameters

jid:UnescapedJID

Returns
GroupChatBookmark —
isGroupChatBookmarked()method 
public function isGroupChatBookmarked(jid:UnescapedJID):Boolean

Does there exist a group chat bookmark with the given JID

Parameters

jid:UnescapedJID

Returns
Boolean —
removeGroupChatBookmark()method 
public function removeGroupChatBookmark(jid:UnescapedJID):void

Remove

Parameters

jid:UnescapedJID

setAutoJoin()method 
public function setAutoJoin(jid:UnescapedJID, state:Boolean):void

Set autoJoin for the given bookmark JID

Parameters

jid:UnescapedJID
 
state:Boolean

Event Detail
bookmarkRetrieved Event
Event Object Type: org.igniterealtime.xiff.events.BookmarkRetrievedEvent
BookmarkRetrievedEvent.type property = org.igniterealtime.xiff.events.BookmarkRetrievedEvent.BOOKMARK_RETRIEVED

groupchatBookmarkAdded Event  
Event Object Type: org.igniterealtime.xiff.events.BookmarkChangedEvent
BookmarkChangedEvent.type property = org.igniterealtime.xiff.events.BookmarkChangedEvent.GROUPCHAT_BOOKMARK_ADDED

groupchatBookmarkRemoved Event  
Event Object Type: org.igniterealtime.xiff.events.BookmarkChangedEvent
BookmarkChangedEvent.type property = org.igniterealtime.xiff.events.BookmarkChangedEvent.GROUPCHAT_BOOKMARK_REMOVED





Thu Aug 23 2012, 12:09 AM +03:00