Packageorg.igniterealtime.xiff.data.rpc
Classpublic class RPCExtension
InheritanceRPCExtension Inheritance Extension Inheritance XMLStanza Inheritance ExtensionContainer Inheritance Object
Implements IExtension

Implements XEP-0009 for XML-RPC over XMPP.

The protocol supports all syntax and semantics of XML-RPC except that it uses XMPP instead of HTTP as the underlying transport.

See also

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


Public Properties
 PropertyDefined By
  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
  xml : XML
[override] Interface method, returning the namespace for this extension
RPCExtension
Public Methods
 MethodDefined By
  
RPCExtension(parent:XML = null)
RPCExtension
 Inherited
Add extension to the list of the given namespace and insert to the XML element as a child.
ExtensionContainer
  
call(methodName:String, params:Array):void
Place the remote call.
RPCExtension
 Inherited
ExtensionContainer
 Inherited
getAllExtensionsByNS(nameSpace:String):Array
ExtensionContainer
 Inherited
getAttribute(name:String):String
Convinience method for getting element value from the XML.
XMLStanza
 Inherited
getChildAttribute(elem:String, name:String):String
Convinience method for getting child element attribute value from the XML.
XMLStanza
 Inherited
getChildField(elem:String, name:String):String
Convinience method for getting child element value from the XML.
XMLStanza
  
Interface method, returning the namespace for this extension
RPCExtension
 Inherited
getExtension(elementName:String):IExtension
Get the extension having the given element name.
ExtensionContainer
 Inherited
getField(name:String):String
Convinience method for getting element value from the XML.
XMLStanza
  
getNS():String
Interface method, returning the namespace for this extension
RPCExtension
 Inherited
remove():void
Removes the extension from its parent.
Extension
 Inherited
removeAllExtensions(nameSpace:String):void
ExtensionContainer
 Inherited
removeExtension(extension:IExtension):Boolean
ExtensionContainer
 Inherited
removeFields(name:String):void
Helper method for removing all child elements that have the given name.
XMLStanza
 Inherited
setAttribute(name:String, value:String):void
Convinience method for setting a value to a element in the XML.
XMLStanza
 Inherited
setChildAttribute(elem:String, name:String, value:String):void
Convinience method for setting an attribute for a child element of the XML.
XMLStanza
 Inherited
setChildField(elem:String, name:String, value:String):void
Convinience method for setting a value for a child element of the XML.
XMLStanza
 Inherited
setField(name:String, value:String):void
Convinience method for setting a value to a element in the XML.
XMLStanza
 Inherited
toString():String
Converts the base stanza XML to a string.
XMLStanza
Public Constants
 ConstantDefined By
 InheritedDEFAULT_NS : Namespace
[static] Default XML namespace.
XMLStanza
  ELEMENT_NAME : String = query
[static]
RPCExtension
 InheritedFLASH_NS : Namespace
[static]
XMLStanza
  NS : String = jabber:iq:rpc
[static]
RPCExtension
 InheritedSTREAM_NS : Namespace
[static]
XMLStanza
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
xmlproperty 
xml:XML[override]

Interface method, returning the namespace for this extension


Implementation
    public function get xml():XML
    public function set xml(value:XML):void

See also

Constructor Detail
RPCExtension()Constructor
public function RPCExtension(parent:XML = null)

Parameters
parent:XML (default = null) — (Optional) The containing XML for this extension
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

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

Constant Detail
ELEMENT_NAMEConstant
public static const ELEMENT_NAME:String = query

NSConstant 
public static const NS:String = jabber:iq:rpc