Current API version: 3.4.24
brax |
|
| string |
brax.getVersion () Returns the current BRAX API version |
brax.auth |
|
| struct |
brax.auth.sessions () List users currently online |
| string |
brax.auth.identify (string,string) Authenticate user and return a user token (username,password) |
brax.channels |
|
| struct |
brax.channels.getSlogan () Retrieves the slogan for the current channel, if any |
| struct |
brax.channels.setSlogan (string) Sets a slogan for the current channel |
brax.comments |
|
| struct |
brax.comments.deleteComment (int,string) Deletes a comment by a given comment ID (comment_id,user_token) |
| struct |
brax.comments.getComment (int) Retrieves a single comment struct by a given comment ID |
| struct |
brax.comments.getComments (int) Retrieves a set of comments for a given item ID |
| struct |
brax.comments.recentComments () Retrieves the latest 10 comments |
brax.items |
|
| struct |
brax.items.undoEdit (int,string,string) Undo a previous edit restoring older value (item_id, user_token, field) |
| string |
brax.items.getLetterById (int) Gets reference letter (a-z) for a given item ID |
| int |
brax.items.getIdByLetter (string) Gets items ID from a given letter |
| struct |
brax.items.deleteTag (int,string) Deletes one or more tags from an item by given ID (tags are separated by commas) |
| struct |
brax.items.addTag (int,string,string) Add one or more tags to an item by given ID (tags are separated by commas) (item_id,tags,user_token) |
| struct |
brax.items.addComment (int,string,string) Adds a single comment to a given item ID. (item_id,comment,user_token) |
| struct |
brax.items.flagItem (int,string,string) Flag item with a given flag. (item_id,flag,user_token) |
| struct |
brax.items.updateItem (int,struct,string) Update an existing item by given ID. (item_id,params,user_token) |
| struct |
brax.items.addUrlItem (string,string,string) Add a new URL item (user_token,url,title) |
| struct |
brax.items.bumpItem (int,string) Bump an item (item_id,user_token) |
| struct |
brax.items.getItems (struct) Retrieves a set of item structs with given constraints. (optional params: query,nick,tag,channel,domain,public,since,until,per_page,page) |
| struct |
brax.items.getItemByUrl (string) Retrieves a single item struct by a given unique URL |
| struct |
brax.items.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 |
brax.quotes |
|
| struct |
brax.quotes.getQuoteByNick (string) Retrieves a random quote from quotes database for a given author (author) |
| struct |
brax.quotes.getQuote () Retrieves a random quote from quotes database for the current channel |
| struct |
brax.quotes.addQuote (string,string) Adds a quote to the quotes database by author. (quote,user_token) |
brax.users |
|
| struct |
brax.users.heartItem (int,string) Saves a given item to a users favorites (item_id, user_token) |
system |
|
| 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) |
| string |
system.methodHelp (string) Returns help text if defined for the method passed, otherwise returns an empty string |
| array |
system.listMethods (string) This method lists all the methods that the XML-RPC server knows how to dispatch |
