| Package | org.igniterealtime.xiff.data.stream |
| Class | public class IBBExtension |
| Inheritance | IBBExtension Extension XMLStanza ExtensionContainer Object |
| Subclasses | IBBCloseExtension, IBBDataExtension, IBBOpenExtension |
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
| Property | Defined By | ||
|---|---|---|---|
| sid : String
The REQUIRED 'sid' attribute defines a unique session
ID for this IBB session (which MUST match the NMTOKEN
datatype). | IBBExtension | ||
![]() | xml : XML [override]
Override in order to take care of setting the Namespace and
checking for containing extensions. | Extension | |
| Method | Defined By | ||
|---|---|---|---|
IBBExtension(parent:XML = null) | IBBExtension | ||
![]() |
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 | |
![]() | 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 | IBBExtension | ||
![]() | remove():void
Removes the extension from its parent. | Extension | |
![]() | 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 | |
![]() | 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 | |
![]() | FLASH_NS : Namespace [static]
| XMLStanza | |
| NS : String = http://jabber.org/protocol/ibb [static] | IBBExtension | ||
![]() | STREAM_NS : Namespace [static]
| XMLStanza | |
| sid | property |
sid:StringThe 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.
public function get sid():String public function set sid(value:String):void| IBBExtension | () | Constructor |
public function IBBExtension(parent:XML = null)Parameters
parent:XML (default = null) |
| getNS | () | method |
public function getNS():StringReturnsString |
| NS | Constant |
public static const NS:String = http://jabber.org/protocol/ibb