Main PagePackagesClass TreeIndexHelp
Previous | Next
Frames | No Frames
Summary: Field | Property | Contructor | Method
Detail: Field | Property | Contructor | Method
org.jivesoftware.xiff.data.rpc

class RPCExtension

Object | +--org.jivesoftware.xiff.data.XMLStanza | +--org.jivesoftware.xiff.data.Extension | +--org.jivesoftware.xiff.data.rpc.RPCExtension
Implemented Interfaces: IExtension, ISerializable
class RPCExtension extends Extension
Implements JEP-0009 for XML-RPC over XMPP.

Field Summary

public static ELEMENT: String
public static NS: String
Static class variables to be overridden in subclasses;
Fields inherited from class org.jivesoftware.xiff.data.XMLStanza
XMLFactory

Property Summary

public 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.
public faultCode: Number (read-only)
A common result from most RPC servers to describe a fault
public faultString: String (read-only)
A common result from most RPC servers to describe a fault
public 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 result: Array (read-only)
The result of this remote procedure call. It can contain elements of any type.

Method Summary

public 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.
public deserialize ( node: XMLNode ): Boolean
Interface method, returning the namespace for this extension
public static enable ( ): Void
Performs the registration of this extension into the extension registry.
public getElementName ( ): String
Interface method, returning the namespace for this extension
public getNS ( ): String
Interface method, returning the namespace for this extension
public serialize ( parent: XMLNode ): Boolean
Interface method, returning the namespace for this extension
Methods inherited from class org.jivesoftware.xiff.data.Extension
remove, toString
Methods inherited from class org.jivesoftware.xiff.data.XMLStanza
addTextNode, ensureNode, getNode, replaceTextNode, setNode

Field Documentation

ELEMENT

public static var ELEMENT: String

    NS

    public static var NS: String
    Static class variables to be overridden in subclasses;

      Property Documentation

      fault

      public 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.

        faultCode

        public faultCode: Number (read-only)
        A common result from most RPC servers to describe a fault

          faultString

          public faultString: String (read-only)
          A common result from most RPC servers to describe a fault

            isFault

            public 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.
            • Value:
              True if the remote procedure call produced an error

            result

            public result: Array (read-only)
            The result of this remote procedure call. It can contain elements of any type.
            • Value:
              Array of demarshalled results from the remote procedure

            Method Documentation

            call

            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.

            deserialize

            public function deserialize (
            node: XMLNode): Boolean
            Interface method, returning the namespace for this extension

            enable

            public static function enable (
            ): Void
            Performs the registration of this extension into the extension registry.

              getElementName

              public function getElementName (
              ): String
              Interface method, returning the namespace for this extension

              getNS

              public function getNS (
              ): String
              Interface method, returning the namespace for this extension

              serialize

              public function serialize (
              parent: XMLNode): Boolean
              Interface method, returning the namespace for this extension
              The documentation was generated from the following file:
              • RPCExtension.as, Last Modified: 3/10/2005 10:13:18 PM
              Copyright © 2004 Mirell Development | Created with AS2Doc | 6/14/2005 9:32:28 AM