Packageorg.igniterealtime.xiff.bookmark
Classpublic class BookmarkPrivatePayload
InheritanceBookmarkPrivatePayload Inheritance XMLStanza Inheritance ExtensionContainer Inheritance Object
Implements IPrivatePayload

XEP-0048: Bookmarks

See also

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


Public Properties
 PropertyDefined By
  groupChatBookmarks : Array
[read-only]
BookmarkPrivatePayload
  urlBookmarks : Array
[read-only] List of UrlBookmarks.
BookmarkPrivatePayload
  xml : XML
[override]
BookmarkPrivatePayload
Public Methods
 MethodDefined By
  
BookmarkPrivatePayload(groupChatBookmarks:Array = null, urlBookmarks:Array = null)
BookmarkPrivatePayload
 Inherited
Add extension to the list of the given namespace and insert to the XML element as a child.
ExtensionContainer
 Inherited
ExtensionContainer
 Inherited
getAllExtensionsByNS(nameSpace:String):Array
ExtensionContainer
 Inherited
getAttribute(name:String):String
Convinience method for getting element value from the XML.
XMLStanza
 Inherited
getChildAttribute(elem:String, name:String):String
Convinience method for getting child element attribute value from the XML.
XMLStanza
 Inherited
getChildField(elem:String, name:String):String
Convinience method for getting child element value from the XML.
XMLStanza
  
BookmarkPrivatePayload
 Inherited
getExtension(elementName:String):IExtension
Get the extension having the given element name.
ExtensionContainer
 Inherited
getField(name:String):String
Convinience method for getting element value from the XML.
XMLStanza
  
getNS():String
BookmarkPrivatePayload
 Inherited
removeAllExtensions(nameSpace:String):void
ExtensionContainer
 Inherited
removeExtension(extension:IExtension):Boolean
ExtensionContainer
 Inherited
removeFields(name:String):void
Helper method for removing all child elements that have the given name.
XMLStanza
  
Removes the bookmark from the list, and returns it
BookmarkPrivatePayload
 Inherited
setAttribute(name:String, value:String):void
Convinience method for setting a value to a element in the XML.
XMLStanza
 Inherited
setChildAttribute(elem:String, name:String, value:String):void
Convinience method for setting an attribute for a child element of the XML.
XMLStanza
 Inherited
setChildField(elem:String, name:String, value:String):void
Convinience method for setting a value for a child element of the XML.
XMLStanza
 Inherited
setField(name:String, value:String):void
Convinience method for setting a value to a element in the XML.
XMLStanza
 Inherited
toString():String
Converts the base stanza XML to a string.
XMLStanza
Public Constants
 ConstantDefined By
 InheritedDEFAULT_NS : Namespace
[static] Default XML namespace.
XMLStanza
  ELEMENT_NAME : String = storage
[static]
BookmarkPrivatePayload
 InheritedFLASH_NS : Namespace
[static]
XMLStanza
  NS : String = storage:bookmarks
[static]
BookmarkPrivatePayload
 InheritedSTREAM_NS : Namespace
[static]
XMLStanza
Property Detail
groupChatBookmarksproperty
groupChatBookmarks:Array  [read-only]


Implementation
    public function get groupChatBookmarks():Array
urlBookmarksproperty 
urlBookmarks:Array  [read-only]

List of UrlBookmarks.


Implementation
    public function get urlBookmarks():Array

See also

xmlproperty 
xml:XML[override]


Implementation
    public function get xml():XML
    public function set xml(value:XML):void
Constructor Detail
BookmarkPrivatePayload()Constructor
public function BookmarkPrivatePayload(groupChatBookmarks:Array = null, urlBookmarks:Array = null)

Parameters
groupChatBookmarks:Array (default = null)
 
urlBookmarks:Array (default = null)
Method Detail
getElementName()method
public function getElementName():String

Returns
String
getNS()method 
public function getNS():String

Returns
String
removeGroupChatBookmark()method 
public function removeGroupChatBookmark(jid:UnescapedJID):GroupChatBookmark

Removes the bookmark from the list, and returns it

Parameters

jid:UnescapedJID

Returns
GroupChatBookmark
Constant Detail
ELEMENT_NAMEConstant
public static const ELEMENT_NAME:String = storage

NSConstant 
public static const NS:String = storage:bookmarks