Packageorg.igniterealtime.xiff.data.forms
Classpublic class FormReported
InheritanceFormReported Inheritance XMLStanza Inheritance ExtensionContainer Inheritance Object
Implements INodeProxy

In some contexts (e.g., the results of a search request), it may be necessary to communicate multiple items. Therefore, a data form of type "result" MAY contain two child elements not described in the basic syntax:
  1. One and only reported element, which can be understood as a "table header" describing the data to follow.
  2. Zero or more item elements, which can be understood as "table cells" containing data (if any) that matches the request.

See also

http://xmpp.org/extensions/xep-0004.html#protocol-results


Public Properties
 PropertyDefined By
  fields : Array
Item interface to array of fields if they are contained in a "field" element
FormReported
 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
  
FormReported(parent:XML = null)
FormReported
 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 = reported
[static]
FormReported
 InheritedFLASH_NS : Namespace
[static]
XMLStanza
 InheritedSTREAM_NS : Namespace
[static]
XMLStanza
Property Detail
fieldsproperty
fields:Array

Item interface to array of fields if they are contained in a "field" element


Implementation
    public function get fields():Array
    public function set fields(value:Array):void
Constructor Detail
FormReported()Constructor
public function FormReported(parent:XML = null)

Parameters
parent:XML (default = null)
Constant Detail
ELEMENT_NAMEConstant
public static const ELEMENT_NAME:String = reported