| Package | org.igniterealtime.xiff.bookmark |
| Class | public class BookmarkPrivatePayload |
| Inheritance | BookmarkPrivatePayload  XMLStanza ExtensionContainer Object |
| Implements | IPrivatePayload |
See also
| Property | Defined By | ||
|---|---|---|---|
| groupChatBookmarks : Array [read-only] | BookmarkPrivatePayload | ||
| urlBookmarks : Array [read-only]
List of UrlBookmarks. | BookmarkPrivatePayload | ||
| xml : XML [override] | BookmarkPrivatePayload | ||
| Method | Defined By | ||
|---|---|---|---|
BookmarkPrivatePayload(groupChatBookmarks:Array = null, urlBookmarks:Array = null) | BookmarkPrivatePayload | ||
 |
Add extension to the list of the given namespace and insert to the XML element as a child. | ExtensionContainer | |
| getAllExtensions():Array | ExtensionContainer | |
| getAllExtensionsByNS(nameSpace:String):Array | ExtensionContainer | |
| getAttribute(name:String):String
Convinience method for getting element value from the XML. | XMLStanza | |
| getChildAttribute(elem:String, name:String):String
Convinience method for getting child element attribute value from the XML. | XMLStanza | |
| getChildField(elem:String, name:String):String
Convinience method for getting child element value from the XML. | XMLStanza | |
getElementName():String | BookmarkPrivatePayload | ||
| getExtension(elementName:String):IExtension
Get the extension having the given element name. | ExtensionContainer | |
| getField(name:String):String
Convinience method for getting element value from the XML. | XMLStanza | |
getNS():String | BookmarkPrivatePayload | ||
| removeAllExtensions(nameSpace:String):void | ExtensionContainer | |
| removeExtension(extension:IExtension):Boolean | ExtensionContainer | |
| 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 | ||
| setAttribute(name:String, value:String):void
Convinience method for setting a value to a element in the XML. | XMLStanza | |
| setChildAttribute(elem:String, name:String, value:String):void
Convinience method for setting an attribute for a child element of the XML. | XMLStanza | |
| setChildField(elem:String, name:String, value:String):void
Convinience method for setting a value for a child element of the XML. | XMLStanza | |
| setField(name:String, value:String):void
Convinience method for setting a value to a element in the XML. | XMLStanza | |
| toString():String
Converts the base stanza XML to a string. | XMLStanza | |
| Constant | Defined By | ||
|---|---|---|---|
| DEFAULT_NS : Namespace [static]
Default XML namespace. | XMLStanza | |
| ELEMENT_NAME : String = storage [static] | BookmarkPrivatePayload | ||
| FLASH_NS : Namespace [static]
| XMLStanza | |
| NS : String = storage:bookmarks [static] | BookmarkPrivatePayload | ||
| STREAM_NS : Namespace [static]
| XMLStanza | |
| groupChatBookmarks | property |
Hide Inherited Public Methods
Show Inherited Public MethodsgroupChatBookmarks:Array [read-only] public function get groupChatBookmarks():Array| urlBookmarks | property |
urlBookmarks:Array [read-only] List of UrlBookmarks.
public function get urlBookmarks():ArraySee also
| xml | property |
xml:XML[override] public function get xml():XML public function set xml(value:XML):void| BookmarkPrivatePayload | () | Constructor |
public function BookmarkPrivatePayload(groupChatBookmarks:Array = null, urlBookmarks:Array = null)Parameters
groupChatBookmarks:Array (default = null) | |
urlBookmarks:Array (default = null) |
| getElementName | () | method |
public function getElementName():StringReturnsString |
| getNS | () | method |
public function getNS():StringReturnsString |
| removeGroupChatBookmark | () | method |
public function removeGroupChatBookmark(jid:UnescapedJID):GroupChatBookmarkRemoves the bookmark from the list, and returns it
Parameters
jid:UnescapedJID |
GroupChatBookmark — |
| ELEMENT_NAME | Constant |
public static const ELEMENT_NAME:String = storage| NS | Constant |
public static const NS:String = storage:bookmarks