Package | org.igniterealtime.xiff.data.rpc |
Class | public class RPCExtension |
Inheritance | RPCExtension ![]() ![]() ![]() |
Implements | IExtension |
See also
Property | Defined by | ||
---|---|---|---|
![]() | _exts : Object | ExtensionContainer | |
fault : Object [read-only]
The object containing the fault of the remote procedure call.
| RPCExtension | ||
faultCode : Number [read-only]
A common result from most RPC servers to describe a fault
| RPCExtension | ||
faultString : String [read-only]
A common result from most RPC servers to describe a fault
| RPCExtension | ||
isFault : Boolean [read-only]
Check this if property if you wish to determine the remote procedure call produced an error.
| RPCExtension | ||
result : Array [read-only]
The result of this remote procedure call.
| RPCExtension | ||
![]() | XMLData : XML [static]
| XMLStanza | |
![]() | XMLFactory : XMLDocument [static]
| XMLStanza |
Method | Defined by | ||
---|---|---|---|
| RPCExtension | ||
![]() | ExtensionContainer | ||
![]() |
addTextNode(parent:XMLNode, elementName:String, value:String):XMLNode
Adds a simple text node to the parent node specified.
| XMLStanza | |
call(methodName:String, params:Array):void
Place the remote call.
| RPCExtension | ||
deserialize(node:XMLNode):Boolean
Interface method, returning the namespace for this extension
| RPCExtension | ||
enable():void
[static]
Performs the registration of this extension into the extension registry.
| RPCExtension | ||
![]() |
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 | |
getElementName():String
Interface method, returning the namespace for this extension
| RPCExtension | ||
![]() |
getExtension(name:String):Extension
| ExtensionContainer | |
![]() |
getNode():XMLNode
| XMLStanza | |
getNS():String
Interface method, returning the namespace for this extension
| RPCExtension | ||
![]() |
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(parent:XMLNode):Boolean
Interface method, returning the namespace for this extension
| RPCExtension | ||
![]() |
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]
| RPCExtension | ||
NS : String = "jabber:iq:rpc" [static]
| RPCExtension |
fault | property |
fault:Object
[read-only]The object containing the fault of the remote procedure call. This object could have any properties, as fault results are only structurally defined.
Implementation public function get fault():Object
faultCode | property |
faultCode:Number
[read-only]A common result from most RPC servers to describe a fault
Implementation public function get faultCode():Number
faultString | property |
faultString:String
[read-only]A common result from most RPC servers to describe a fault
Implementation public function get faultString():String
isFault | property |
isFault:Boolean
[read-only]Check this if property if you wish to determine the remote procedure call produced an error. If the XMPP stanza never made it to the RPC service, then the error would be on the stanza object instead of this extension.
Implementation public function get isFault():Boolean
result | property |
result:Array
[read-only]The result of this remote procedure call. It can contain elements of any type.
Implementation public function get result():Array
RPCExtension | () | constructor |
public function RPCExtension()
call | () | method |
public function call(methodName:String, params:Array):void
Place the remote call. This method serializes the remote procedure call to XML. The call will be made on the remote machine when the stanza containing this extension is sent to the server. If this extension is being returned, then check the result property instead.
ParametersmethodName:String — The name of the remote procedure to call
|
|
params:Array — A collection of parameters of any type
|
See also
deserialize | () | method |
public function deserialize(node:XMLNode):Boolean
Interface method, returning the namespace for this extension
Parametersnode:XMLNode |
Boolean |
See also
enable | () | method |
public static function enable():void
Performs the registration of this extension into the extension registry.
getElementName | () | method |
public function getElementName():String
Interface method, returning the namespace for this extension
ReturnsString |
See also
getNS | () | method |
public function getNS():String
Interface method, returning the namespace for this extension
ReturnsString |
See also
serialize | () | method |
public function serialize(parent:XMLNode):Boolean
Interface method, returning the namespace for this extension
Parametersparent:XMLNode |
Boolean |
See also
ELEMENT_NAME | constant |
public static const ELEMENT_NAME:String = "query"
NS | constant |
public static const NS:String = "jabber:iq:rpc"