Packageorg.igniterealtime.xiff.data.rpc
Classpublic class RPCExtension
InheritanceRPCExtension Inheritance Extension Inheritance XMLStanza Inheritance ExtensionContainer
ImplementsIExtension

Implements XEP-0009 for XML-RPC over XMPP.

See also

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


Public Properties
 PropertyDefined by
 Inherited_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
 InheritedXMLData : XML
[static]
XMLStanza
 InheritedXMLFactory : XMLDocument
[static]
XMLStanza
Public Methods
 MethodDefined by
  
RPCExtension
 Inherited
ExtensionContainer
 Inherited
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
 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
  
getElementName():String
Interface method, returning the namespace for this extension
RPCExtension
 Inherited
getExtension(name:String):Extension
ExtensionContainer
 Inherited
getNode():XMLNode
XMLStanza
  
getNS():String
Interface method, returning the namespace for this extension
RPCExtension
 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(parent:XMLNode):Boolean
Interface method, returning the namespace for this extension
RPCExtension
 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]
RPCExtension
  NS : String = "jabber:iq:rpc"
[static]
RPCExtension
Property detail
faultproperty
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
faultCodeproperty 
faultCode:Number  [read-only]

A common result from most RPC servers to describe a fault

Implementation
    public function get faultCode():Number
faultStringproperty 
faultString:String  [read-only]

A common result from most RPC servers to describe a fault

Implementation
    public function get faultString():String
isFaultproperty 
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
resultproperty 
result:Array  [read-only]

The result of this remote procedure call. It can contain elements of any type.

Implementation
    public function get result():Array
Constructor detail
RPCExtension()constructor
public function RPCExtension()

Method detail
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.

Parameters
methodName: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

Parameters
node:XMLNode

Returns
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

Returns
String

See also

getNS()method 
public function getNS():String

Interface method, returning the namespace for this extension

Returns
String

See also

serialize()method 
public function serialize(parent:XMLNode):Boolean

Interface method, returning the namespace for this extension

Parameters
parent:XMLNode

Returns
Boolean

See also

Constant detail
ELEMENT_NAMEconstant
public static const ELEMENT_NAME:String = "query"
NSconstant 
public static const NS:String = "jabber:iq:rpc"