This page communicating with the BRAX API in real-time. It is using introspection (also known as class hinting, or API discovery) to retrieve the list of methods available from the server. Additionally, it is asking the server what each method's signature is, as well as any documentation available for that method.
BRAX Version 0.9
struct getItem (int)Retrieves a single item by ID. The struct is returned with all its associated parts, including any tags or comments associated to the item |
struct getItemByUrl (string)Retrieves a single item struct by a given unique URL |
struct getItems (struct)Retrieves a set of item structs with given constraints. (query,nick,tag,page) |
struct addItem (string,string,string)Add a new item (author,url,title) |
struct addSet (int,int)Adds item to an item set (item_id_1,item_id_2) |
struct updateItem (int,struct,string)Update an existing item by given ID. Only the params given will be updated for the item. Author is the 3rd argument. |
struct recentComments ()Retrieves the latest 10 comments |
struct getComments (int)Retrieves a set of comments for a given item ID |
struct getComment (int)Retrieves a single comment struct by a given comment ID |
struct addComment (int,string,string)Adds a single comment to a given item ID |
struct deleteComment (int)Deletes a comment by a given comment ID |
struct addQuote (string,string)Adds a quote to the quotes database by author |
struct getQuote ()Retrieves a random quote from quotes database for the current source |
struct deleteSet (int)Removes give item ID from all item sets |
struct featureItem (int)Marks a given item ID as the current source's Featured Item |
struct getFeaturedItem ()Retrieves the featured item struct for the current source, if any |
struct setSlogan (string)Sets a slogan for the current source |
struct getSlogan ()Retrieves the slogan for the current source, if any |
struct addTag (int,string,string)Add one or more tags to an item by given ID (tags are separated by commas) |
struct deleteTag (int,string)Deletes one or more tags from an item by given ID (tags are separated by commas) |
struct getIdByLetter (string)Gets items ID from a given letter |
struct getLetterById (int)Gets reference letter (a-z) for a given item ID |
struct isIdented (string,string)Is given nick and host known? |
struct addHost (string,string,string)Identify a new host with an author and password |
string getVersion ()Returns the current BRAX API version |
array system.listMethods (string)This method lists all the methods that the XML-RPC server knows how to dispatch |
string system.methodHelp (string)Returns help text if defined for the method passed, otherwise returns an empty string |
array system.methodSignature (string)Returns an array of known signatures (an array of arrays) for the method name passed. If no signatures are known, returns a none-array (test for type != array to detect missing signature) |





