Class: xmlrpcmsg

xmlrpcmsg(meth, pars)

new xmlrpcmsg(meth, pars)

Parameters:
Name Type Description
meth string Name of the method to be invoked
pars array list of parameters for method call (xmlrpcval objects)
Source:

Methods

addParam(par)

Add a parameter to the list of parameters to be used upon method invocation
Parameters:
Name Type Description
par xmlrpcval
Source:
Returns:
false on failure (when parameter par is not of correct type)

getNumParams()

Returns the number of parameters in the messge.
Source:
Returns:
the number of parameters currently set

getParam(i)

Returns the nth parameter in the message. The index zero-based.
Parameters:
Name Type Description
i int the index of the parameter to fetch (zero based)
Source:
Returns:
the i-th parameter (undefined if index i is bigger than current number of params)

method(meth)

Gets/sets the xmlrpc method to be invoked
Parameters:
Name Type Description
meth string the method to be set (leave empty not to set it)
Source:
Returns:
the method that will be invoked

parseResponse(data, headers_processed, return_type)

Parse the xmlrpc response contained in the string data and return an xmlrpcresp object.
Parameters:
Name Type Description
data string the xmlrpc response, eventually including http headers
headers_processed boolean | string 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 string decides return type, i.e. content of response.value(). Either 'xmlrpcvals' (default), 'xml' or 'jsvals'
Source:

serialize(charset_encoding)

Returns xml representation of the message. XML prologue included
Parameters:
Name Type Description
charset_encoding string The charset to be used for serialization. If null, US-ASCII is assumed
Source:
Returns:
the xml representation of the message, xml prologue included