| Package | org.igniterealtime.xiff.data.rpc |
| Class | public class RPCExtension |
| Inheritance | RPCExtension  Extension XMLStanza ExtensionContainer Object |
| Implements | IExtension |
The protocol supports all syntax and semantics of XML-RPC except that it uses XMPP instead of HTTP as the underlying transport.
See also
| Property | Defined 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 | ||
| Method | Defined By | ||
|---|---|---|---|
RPCExtension(parent:XML = null) | RPCExtension | ||
 |
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 | ||
| getAllExtensions():Array | ExtensionContainer | |
| getAllExtensionsByNS(nameSpace:String):Array | ExtensionContainer | |
| getAttribute(name:String):String
Convinience method for getting element value from the XML. | XMLStanza | |
| getChildAttribute(elem:String, name:String):String
Convinience method for getting child element attribute value from the XML. | XMLStanza | |
| getChildField(elem:String, name:String):String
Convinience method for getting child element value from the XML. | XMLStanza | |
getElementName():String
Interface method, returning the namespace for this extension
| RPCExtension | ||
| getExtension(elementName:String):IExtension
Get the extension having the given element name. | ExtensionContainer | |
| 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 | ||
| remove():void
Removes the extension from its parent. | Extension | |
| removeAllExtensions(nameSpace:String):void | ExtensionContainer | |
| removeExtension(extension:IExtension):Boolean | ExtensionContainer | |
| removeFields(name:String):void
Helper method for removing all child elements that have the given name. | XMLStanza | |
| setAttribute(name:String, value:String):void
Convinience method for setting a value to a element in the XML. | XMLStanza | |
| setChildAttribute(elem:String, name:String, value:String):void
Convinience method for setting an attribute for a child element of the XML. | XMLStanza | |
| setChildField(elem:String, name:String, value:String):void
Convinience method for setting a value for a child element of the XML. | XMLStanza | |
| setField(name:String, value:String):void
Convinience method for setting a value to a element in the XML. | XMLStanza | |
| toString():String
Converts the base stanza XML to a string. | XMLStanza | |
| Constant | Defined By | ||
|---|---|---|---|
| DEFAULT_NS : Namespace [static]
Default XML namespace. | XMLStanza | |
| ELEMENT_NAME : String = query [static] | RPCExtension | ||
| FLASH_NS : Namespace [static]
| XMLStanza | |
| NS : String = jabber:iq:rpc [static] | RPCExtension | ||
| STREAM_NS : Namespace [static]
| XMLStanza | |
| fault | property |
Hide Inherited Public Methods
Show Inherited Public Methodsfault: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.
public function get fault():Object| faultCode | property |
faultCode:Number [read-only] A common result from most RPC servers to describe a fault
public function get faultCode():Number| faultString | property |
faultString:String [read-only] A common result from most RPC servers to describe a fault
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.
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.
public function get result():Array| xml | property |
xml:XML[override] Interface method, returning the namespace for this extension
public function get xml():XML public function set xml(value:XML):voidSee also
| RPCExtension | () | Constructor |
public function RPCExtension(parent:XML = null)Parameters
parent:XML (default = null) |
| call | () | method |
public function call(methodName:String, params:Array):voidPlace 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():StringInterface method, returning the namespace for this extension
ReturnsString |
See also
| getNS | () | method |
public function getNS():StringInterface method, returning the namespace for this extension
ReturnsString |
See also
| ELEMENT_NAME | Constant |
public static const ELEMENT_NAME:String = query| NS | Constant |
public static const NS:String = jabber:iq:rpc