Packageorg.igniterealtime.xiff.data.search
Classpublic class SearchExtension
InheritanceSearchExtension Inheritance Extension Inheritance XMLStanza Inheritance ExtensionContainer
ImplementsIExtension

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

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


Public Properties
 PropertyDefined by
 Inherited_exts : Object
ExtensionContainer
  instructions : String
SearchExtension
 InheritedXMLData : XML
[static]
XMLStanza
 InheritedXMLFactory : XMLDocument
[static]
XMLStanza
Public Methods
 MethodDefined by
  
SearchExtension(parent:XMLNode = null)
SearchExtension
 Inherited
ExtensionContainer
 Inherited
addTextNode(parent:XMLNode, elementName:String, value:String):XMLNode
Adds a simple text node to the parent node specified.
XMLStanza
  
deserialize(node:XMLNode):Boolean
SearchExtension
  
enable():void
[static] Performs the registration of this extension into the extension registry.
SearchExtension
 Inherited
ensureNode(node:XMLNode, elementName:String):XMLNode
Ensures that a node with a specific element name exists in the stanza.
XMLStanza
 Inherited
exists(value:*):Boolean
[static] A helper method to determine if a value is both not null and not undefined.
XMLStanza
 Inherited
ExtensionContainer
 Inherited
getAllExtensionsByNS(ns:String):Array
ExtensionContainer
  
getAllItems():Array
SearchExtension
  
getElementName():String
SearchExtension
 Inherited
getExtension(name:String):Extension
ExtensionContainer
  
getField(name:String):String
SearchExtension
 Inherited
getNode():XMLNode
XMLStanza
  
getNS():String
SearchExtension
  
SearchExtension
 Inherited
remove():void
Removes the extension from its parent.
Extension
 Inherited
removeAllExtensions(ns:String):void
ExtensionContainer
 Inherited
ExtensionContainer
 Inherited
replaceTextNode(parent:XMLNode, original:XMLNode, elementName:String, value:String):XMLNode
Replaces one node in the stanza with another simple text node.
XMLStanza
  
serialize(parentNode:XMLNode):Boolean
SearchExtension
  
setField(name:String, value:String):void
SearchExtension
 Inherited
setNode(node:XMLNode):Boolean
Sets the XML node that should be used for this stanza's internal XML representation.
XMLStanza
 Inherited
toString():String
Converts the extension stanza XML to a string.
Extension
Public Constants
 ConstantDefined by
  ELEMENT_NAME : String = "query"
[static]
SearchExtension
  NS : String = "jabber:iq:search"
[static]
SearchExtension
Property detail
instructionsproperty
instructions:String  [read-write]Implementation
    public function get instructions():String
    public function set instructions(value:String):void
Constructor detail
SearchExtension()constructor
public function SearchExtension(parent:XMLNode = null)

Parameters
parent:XMLNode (default = null) — (Optional) The parent node used to build the XML tree.
Method detail
deserialize()method
public function deserialize(node:XMLNode):BooleanParameters
node:XMLNode

Returns
Boolean
enable()method 
public static function enable():void

Performs the registration of this extension into the extension registry.

getAllItems()method 
public function getAllItems():Array

Returns
Array
getElementName()method 
public function getElementName():String

Returns
String
getField()method 
public function getField(name:String):StringParameters
name:String

Returns
String
getNS()method 
public function getNS():String

Returns
String
getRequiredFieldNames()method 
public function getRequiredFieldNames():Array

Returns
Array
serialize()method 
public function serialize(parentNode:XMLNode):BooleanParameters
parentNode:XMLNode

Returns
Boolean
setField()method 
public function setField(name:String, value:String):voidParameters
name:String
 
value:String
Constant detail
ELEMENT_NAMEconstant
public static const ELEMENT_NAME:String = "query"
NSconstant 
public static const NS:String = "jabber:iq:search"