Package | org.igniterealtime.xiff.data.search |
Class | public class SearchExtension |
Inheritance | SearchExtension ![]() ![]() ![]() ![]() |
Implements | IExtension |
Implements jabber:iq:search namespace. Use this to perform user searches.
Send an empty IQ.TYPE_GET packet with this extension and the return will either be a conflict, or the fields you will need to fill out.
Send a IQ.TYPE_SET packet to the server and with the fields that are listed in getRequiredFieldNames set on this extension.
Check the result and re-establish the connection with the new account.
See also
Property | Defined By | ||
---|---|---|---|
fields : Array [write-only] | SearchExtension | ||
instructions : String
Use null to remove. | SearchExtension | ||
items : Array [read-only]
List of SearchItem in this query. | SearchExtension | ||
xml : XML [override] | SearchExtension |
Method | Defined By | ||
---|---|---|---|
SearchExtension(parent:XML = null) | SearchExtension | ||
![]() |
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 | SearchExtension | ||
![]() | 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 | SearchExtension | ||
getRequiredFieldNames():Array
TODO rename to getter
| SearchExtension | ||
![]() | 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 = query [static] | SearchExtension | ||
![]() | FLASH_NS : Namespace [static]
| XMLStanza | |
NS : String = jabber:iq:search [static] | SearchExtension | ||
![]() | STREAM_NS : Namespace [static]
| XMLStanza |
fields | property |
fields:Array
[write-only] public function set fields(value:Array):void
instructions | property |
instructions:String
Use null
to remove.
public function get instructions():String
public function set instructions(value:String):void
items | property |
items:Array
[read-only] List of SearchItem in this query.
public function get items():Array
xml | property |
xml:XML
[override] public function get xml():XML
public function set xml(value:XML):void
SearchExtension | () | Constructor |
public function SearchExtension(parent:XML = null)
Parameters
parent:XML (default = null ) — (Optional) The parent node used to build the XML tree.
|
getElementName | () | method |
public function getElementName():String
ReturnsString |
getNS | () | method |
public function getNS():String
ReturnsString |
getRequiredFieldNames | () | method |
public function getRequiredFieldNames():Array
TODO rename to getter
ReturnsArray |
ELEMENT_NAME | Constant |
public static const ELEMENT_NAME:String = query
NS | Constant |
public static const NS:String = jabber:iq:search