| Package | org.igniterealtime.xiff.data.search |
| Class | public class SearchExtension |
| Inheritance | SearchExtension Extension XMLStanza ExtensionContainer |
| Implements | IExtension |
See also
| Property | Defined by | ||
|---|---|---|---|
![]() | _exts : Object | ExtensionContainer | |
| instructions : String | SearchExtension | ||
![]() | XMLData : XML [static]
| XMLStanza | |
![]() | XMLFactory : XMLDocument [static]
| XMLStanza | |
| Method | Defined by | ||
|---|---|---|---|
|
SearchExtension(parent:XMLNode = null)
| SearchExtension | ||
![]() | ExtensionContainer | ||
![]() |
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 | ||
![]() |
ensureNode(node:XMLNode, elementName:String):XMLNode
Ensures that a node with a specific element name exists in the stanza.
| XMLStanza | |
![]() |
exists(value:*):Boolean
[static]
A helper method to determine if a value is both not null
and not undefined.
| XMLStanza | |
![]() |
getAllExtensions():Array
| ExtensionContainer | |
![]() |
getAllExtensionsByNS(ns:String):Array
| ExtensionContainer | |
|
getAllItems():Array
| SearchExtension | ||
|
getElementName():String
| SearchExtension | ||
![]() |
getExtension(name:String):Extension
| ExtensionContainer | |
|
getField(name:String):String
| SearchExtension | ||
![]() |
getNode():XMLNode
| XMLStanza | |
|
getNS():String
| SearchExtension | ||
|
getRequiredFieldNames():Array
| SearchExtension | ||
![]() |
remove():void
Removes the extension from its parent.
| Extension | |
![]() |
removeAllExtensions(ns:String):void
| ExtensionContainer | |
![]() |
removeExtension(ext:IExtension):Boolean
| ExtensionContainer | |
![]() |
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 | ||
![]() |
setNode(node:XMLNode):Boolean
Sets the XML node that should be used for this stanza's internal XML representation.
| XMLStanza | |
![]() |
toString():String
Converts the extension stanza XML to a string.
| Extension | |
| Constant | Defined by | ||
|---|---|---|---|
| ELEMENT_NAME : String = "query" [static]
| SearchExtension | ||
| NS : String = "jabber:iq:search" [static]
| SearchExtension | ||
| instructions | property |
instructions:String [read-write]Implementation
public function get instructions():String
public function set instructions(value:String):void
| SearchExtension | () | constructor |
public function SearchExtension(parent:XMLNode = null)Parameters
parent:XMLNode (default = null) — (Optional) The parent node used to build the XML tree.
|
| deserialize | () | method |
public function deserialize(node:XMLNode):BooleanParameters
node:XMLNode |
Boolean |
| enable | () | method |
public static function enable():voidPerforms 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 |
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 |
Boolean |
| setField | () | method |
public function setField(name:String, value:String):voidParameters
name:String |
|
value:String |
| ELEMENT_NAME | constant |
public static const ELEMENT_NAME:String = "query"
| NS | constant |
public static const NS:String = "jabber:iq:search"