Packageorg.igniterealtime.xiff.bookmark
Classpublic class UrlBookmark
InheritanceUrlBookmark Inheritance XMLStanza Inheritance ExtensionContainer Inheritance Object
Implements INodeProxy

The url element is designed for bookmarking web pages, i.e., HTTP or HTTPS URLs.

See also

http://xmpp.org/extensions/xep-0048.html#format-url


Public Properties
 PropertyDefined By
  name : String
[read-only] A friendly name for the bookmark.
UrlBookmark
  url : String
[read-only] The HTTP or HTTPS URL of the web page.
UrlBookmark
 Inheritedxml : XML
The XML node that should be used for this stanza's internal XML representation, base of the XMLStanza, XML element.
ExtensionContainer
Public Methods
 MethodDefined By
  
UrlBookmark(url:String, name:String = null)
Bookmark an url.
UrlBookmark
 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
 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
 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
 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 = url
[static]
UrlBookmark
 InheritedFLASH_NS : Namespace
[static]
XMLStanza
 InheritedSTREAM_NS : Namespace
[static]
XMLStanza
Property Detail
nameproperty
name:String  [read-only]

A friendly name for the bookmark.


Implementation
    public function get name():String
urlproperty 
url:String  [read-only]

The HTTP or HTTPS URL of the web page.


Implementation
    public function get url():String
Constructor Detail
UrlBookmark()Constructor
public function UrlBookmark(url:String, name:String = null)

Bookmark an url.

Parameters
url:String — REQUIRED
 
name:String (default = null) — RECOMMENDED
Constant Detail
ELEMENT_NAMEConstant
public static const ELEMENT_NAME:String = url