Ampache
[ class tree: Ampache ] [ index: Ampache ] [ all elements ]

Class: xmlRpcServer

Source Location: /lib/class/xmlrpcserver.class.php

Class Overview


xmlRpcServer


Methods



Class Details

[line 29]
xmlRpcServer

This class contains all the methods that the /server/xmlrpc.server.php will respond to to add a new method, just define a new public static function in here and it will be automagicaly populated to xmlrpcserver.<FUNCTION> in /server/xmlrpc.server.php




[ Top ]


Class Methods


static method create_stream_session [line 174]

static void create_stream_session( $xmlrpc_object)

create_stream_session

This creates a new stream session and returns the SID in question, this requires a TOKEN as generated by the handshake




Tags:

access:  public


Parameters:

   $xmlrpc_object  

[ Top ]

static method get_album_images [line 134]

static void get_album_images( $xmlrpc_object)

get_album_images

Returns the images information of the albums




Tags:

access:  public


Parameters:

   $xmlrpc_object  

[ Top ]

static method get_catalogs [line 37]

static void get_catalogs( $xmlrpc_object)

get_catalogs

This returns a list of the current non-remote catalogs hosted on this Ampache instance It requires a key be passed as the first element //FIXME: USE TOKEN!




Tags:

access:  public


Parameters:

   $xmlrpc_object  

[ Top ]

static method get_songs [line 79]

static void get_songs( $xmlrpc_object)

get_songs

This is a basic function to return all of the song data in a serialized format. It takes a start and end point as well as the TOKEN for auth mojo //FIXME: USE TOKEN!




Tags:

access:  public


Parameters:

   $xmlrpc_object  

[ Top ]

static method handshake [line 199]

static void handshake( $xmlrpc_object)

handshake

This should be run before any other XMLRPC actions, it checks the KEY encoded with a timestamp then returns a valid TOKEN to be used in all further communication




Tags:

access:  public


Parameters:

   $xmlrpc_object  

[ Top ]


Documentation generated on Thu, 12 Feb 2009 08:00:13 +0900 by phpDocumentor 1.4.2