Packageorg.igniterealtime.xiff.data.stream
Classpublic class IBBExtension
InheritanceIBBExtension Inheritance Extension Inheritance XMLStanza Inheritance ExtensionContainer Inheritance Object
Subclasses IBBCloseExtension, IBBDataExtension, IBBOpenExtension

XEP-0047: In-Band Bytestreams, Version 2.0 (2012-06-22)

Base class of all IBB classes that are using same namespace. Do not use this directly.

Generally, in-band bytestreams SHOULD be used only as a last resort. SOCKS5 Bytestreams will almost always be preferable, but are not implemented in XIFF...

See also

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


Public Properties
 PropertyDefined By
  sid : String
The REQUIRED 'sid' attribute defines a unique session ID for this IBB session (which MUST match the NMTOKEN datatype).
IBBExtension
 Inheritedxml : XML
[override] Override in order to take care of setting the Namespace and checking for containing extensions.
Extension
Public Methods
 MethodDefined By
  
IBBExtension(parent:XML = null)
IBBExtension
 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
  
getNS():String
IBBExtension
 Inherited
remove():void
Removes the extension from its parent.
Extension
 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
 InheritedFLASH_NS : Namespace
[static]
XMLStanza
  NS : String = http://jabber.org/protocol/ibb
[static]
IBBExtension
 InheritedSTREAM_NS : Namespace
[static]
XMLStanza
Property Detail
sidproperty
sid:String

The REQUIRED 'sid' attribute defines a unique session ID for this IBB session (which MUST match the NMTOKEN datatype).

All of the extending classes require this property to be set.


Implementation
    public function get sid():String
    public function set sid(value:String):void
Constructor Detail
IBBExtension()Constructor
public function IBBExtension(parent:XML = null)

Parameters
parent:XML (default = null)
Method Detail
getNS()method
public function getNS():String

Returns
String
Constant Detail
NSConstant
public static const NS:String = http://jabber.org/protocol/ibb