Package | org.igniterealtime.xiff.data.stream |
Class | public class IBBOpenExtension |
Inheritance | IBBOpenExtension ![]() ![]() ![]() ![]() ![]() |
Implements | IExtension |
Open the communication
It is RECOMMENDED to send IBB data using IQ stanzas instead of message stanzas because IQ stanzas provide feedback to the sender regarding delivery to the recipient).
See also
Property | Defined By | ||
---|---|---|---|
blockSize : uint
The REQUIRED 'block-size' attribute defines the maximum
size in bytes of each data chunk (which MUST NOT be
greater than 65535). | IBBOpenExtension | ||
![]() | sid : String
The REQUIRED 'sid' attribute defines a unique session
ID for this IBB session (which MUST match the NMTOKEN
datatype). | IBBExtension | |
stanza : String
The OPTIONAL 'stanza' attribute defines whether the
data will be sent using IQ stanzas or
Message stanzas. | IBBOpenExtension | ||
![]() | xml : XML [override]
Override in order to take care of setting the Namespace and
checking for containing extensions. | Extension |
Method | Defined By | ||
---|---|---|---|
IBBOpenExtension(parent:XML = null)
The recommended values for blockSize (4096) and
stanza ("iq") are set by default. | IBBOpenExtension | ||
![]() |
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 | IBBOpenExtension | ||
![]() | 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 | |
ELEMENT_NAME : String = open [static] | IBBOpenExtension | ||
![]() | FLASH_NS : Namespace [static]
| XMLStanza | |
![]() | NS : String = http://jabber.org/protocol/ibb [static] | IBBExtension | |
![]() | STREAM_NS : Namespace [static]
| XMLStanza |
blockSize | property |
blockSize:uint
The REQUIRED 'block-size' attribute defines the maximum size in bytes of each data chunk (which MUST NOT be greater than 65535).
The default value is 4096
.
public function get blockSize():uint
public function set blockSize(value:uint):void
stanza | property |
stanza:String
The OPTIONAL 'stanza' attribute defines whether the
data will be sent using IQ
stanzas or
Message
stanzas.
The default value is iq
.
public function get stanza():String
public function set stanza(value:String):void
IBBOpenExtension | () | Constructor |
public function IBBOpenExtension(parent:XML = null)
The recommended values for blockSize
(4096) and
stanza
("iq") are set by default.
parent:XML (default = null )
|
getElementName | () | method |
public function getElementName():String
ReturnsString |
ELEMENT_NAME | Constant |
public static const ELEMENT_NAME:String = open