Class: xmlrpcval

xmlrpcval(val, type)

new xmlrpcval(val, type)

Create an xmlrpcval object out of a plain javascript value.
Parameters:
Name Type Description
val any
type string Any valid xmlrpc type name (lowercase). If omitted, 'string' is assumed
Source:

Methods

addArray(vals)

Add an array of xmlrpcval objects to an xmlrpcval (of type array or uninitialized).
Parameters:
Name Type Description
vals array An array, whose members are xmlrpcvals
Source:
To Do:
  • add some checking for vals to be an array of xmlrpcvals?
Returns:
1 or 0 on failure

addScalar(val, type)

Add a single javascript value to an (uninitialized) xmlrpcval.
Parameters:
Name Type Description
val any
type string
Source:
Returns:
1 or 0 on failure

addStruct(vals)

Add a list (anon obj) of named xmlrpcval objects to an xmlrpcval (of type struct or uninitialized).
Parameters:
Name Type Description
vals object An anonymous object, whose members are xmlrpcvals
Source:
To Do:
  • add some checking for vals to be an array?
Returns:
1 or 0 on failure

arrayMem(m)

Returns the m-th member of an xmlrpcval of array type
Parameters:
Name Type Description
m int the index of the value to be retrieved (zero based).
Source:
Returns:
undefined if there is no such element

arraySize()

Returns the number of members in an xmlrpcval of array type
Source:

kindOf()

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

scalarTyp()

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

scalarVal()

Returns the value of a scalar xmlrpcval.
Source:

serialize(charset_encoding)

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

structEach()

Returns next member element for xmlrpcvals of type struct.
Source:
Returns:
An anon obj with members 0,key => element name, 1,value => element val, or false upon reaching end of struct

structMem(m)

Returns the value of a given struct member (an xmlrpcval object in itself).
Parameters:
Name Type Description
m string the name of the struct member to be looked up
Source:
Returns:
undefined if no such member exists

structMemExists(m)

Checks whether a struct member with a given name is present. Works only on xmlrpcvals of type struct.
Parameters:
Name Type Description
m string the name of the struct member to be looked up
Source:

structReset()

Reset internal pointer for xmlrpcvals of type struct.
Source:

structSize()

Returns the number of members in an xmlrpcval of struct type
Source: