Class xmlrpcmsg

Object
   |
   +--xmlrpcmsg

Direct Known Subclasses:

jsonrpcmsg

class xmlrpcmsg

Defined in xmlrpc_lib.js

Constructor Detail

xmlrpcmsg

xmlrpcmsg(<string> meth, <array> pars)

Parameters:
meth - Name of the method to be invoked
pars - list of parameters for method call (xmlrpcval objects)

addParam

boolean addParam(<xmlrpcval> par)

Add a parameter to the list of parameters to be used upon method invocation

Parameters:
par -

Returns:
false on failure (when parameter par is not of correct type)

getNumParams

integer getNumParams()

Returns the number of parameters in the messge.

Returns:
the number of parameters currently set

getParam

xmlrpcval getParam(<integer> i)

Returns the nth parameter in the message. The index zero-based.

Parameters:
i - the index of the parameter to fetch (zero based)

Returns:
the i-th parameter (undefined if index i is bigger than current number of params)

method

string method(<string> meth)

Gets/sets the xmlrpc method to be invoked

Parameters:
meth - the method to be set (leave empty not to set it)

Returns:
the method that will be invoked

parseResponse

xmlrpcresp parseResponse(<string> data, <boolean|string> headers_processed, <string> return_type)

Parse the xmlrpc response contained in the string data and return an xmlrpcresp object.

Parameters:
data - the xmlrpc response, eventually including http headers
headers_processed - When true prevents parsing HTTP headers for interpretation of content-encoding and consequent decoding. If a string, it is assumed to be the complete set of http headers, separated from response body. Defaults to false
return_type - decides return type, i.e. content of response.value(). Either 'xmlrpcvals' (default), 'xml' or 'jsvals'

serialize

string serialize(charset_encoding)

Returns xml representation of the message. XML prologue included

Parameters:
cahrset_encoding - The charset to be used for serialization. If null, US-ASCII is assumed

Returns:
the xml representation of the message, xml prologue included