Class xmlrpcval

Object
   |
   +--xmlrpcval

Direct Known Subclasses:

jsonrpcval

class xmlrpcval

Defined in xmlrpc_lib.js

Constructor Detail

xmlrpcval

xmlrpcval(<mixed> val, <string> type)

Create an xmlrpcval object out of a plain javascript value

Parameters:
val -
type - Any valid xmlrpc type name (lowercase). If omitted, 'string' is assumed

addArray

integer addArray(<array> vals)

Add an array of xmlrpcval objects to an xmlrpcval (of type array or uninitialized)

Parameters:
vals - An array, whose members are xmlrpcvals

Returns:
1 or 0 on failure

addScalar

integer addScalar(<mixed> val, <string> type)

Add a single javascript value to an (uninitialized) xmlrpcval

Parameters:
val -
type -

Returns:
1 or 0 on failure

addStruct

integer addStruct(<object> vals)

Add a list (anon obj) of named xmlrpcval objects to an xmlrpcval (of type struct or uninitialized)

Parameters:
vals - An anonymous object, whose members are xmlrpcvals

Returns:
1 or 0 on failure

arrayMem

xmlrpcval arrayMem(<integer> m)

Returns the m-th member of an xmlrpcval of array type

Parameters:
m - the index of the value to be retrieved (zero based).

Returns:
undefined if there is no such element

arraySize

integer arraySize()

Returns the number of members in an xmlrpcval of array type

kindOf

string kindOf()

Returns a string containing "struct", "array" or "scalar" describing the base type of the value

scalarTyp

string scalarTyp()

Returns the type of the xmlrpcval. For integers, 'int' is always returned in place of 'i4'

scalarVal

mixed scalarVal()

Returns the value of a scalar xmlrpcval

serialize

string serialize(<string> charset_encoding)

Returns xml representation of the value. XML prologue not included

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

structEach

object structEach()

Returns next member element for xmlrpcvals of type struct.

Returns:
An anon obj with members 0,key => element name, 1,value => element val, or false upon reaching end of struct

structMem

xmlrpcval structMem(<string> m)

Returns the value of a given struct member (an xmlrpcval object in itself).

Parameters:
m - the name of the struct member to be looked up

Returns:
undefined if no such member exists

structMemExists

boolean structMemExists(<string> m)

Checks wheter a struct member with a given name is present. Works only on xmlrpcvals of type struct.

Parameters:
m - the name of the struct member to be looked up

structReset

void structReset()

Reset internal pointer for xmlrpcvals of type struct.

structSize

integer structSize()

Returns the number of members in an xmlrpcval of struct type