b2evolution

Multilingual multiuser multiblog engine

b2evolution Technical Documentation (Version 2.4) [ class tree: xmlsrv ] [ index: xmlsrv ] [ all elements ]

Procedural File: _metaweblog.api.php

Source Location: /blogs/inc/xmlrpc/apis/_metaweblog.api.php

Page Details

XML-RPC : MetaWeblog API

b2evolution - http://b2evolution.net/ Released under GNU GPL License - http://b2evolution.net/about/license.html

Author:  tor
Version:  $Id: _metaweblog.api.php,v 1.2.2.2 2008/05/19 22:27:59 blueyed Exp $
Copyright:  (c)2003-2008 by Francois PLANQUE - http://fplanque.net/
See:  http://manual.b2evolution.net/MetaWeblog_API
See:  http://www.xmlrpc.com/metaWeblogApi
Filesource:  Source Code for this file
Functions
mw_editpost  [line 417]

void mw_editpost( xmlrpcmsg $m  )

metaWeblog.editPost (metaWeblog.editPost)

Parameters:
xmlrpcmsg   $m:  XML-RPC Message
  1. postid (string): Unique identifier of the post to edit Currently ignored in b2evo, in favor of the category.
  2. username (string): Login for a Blogger user who has permission to edit the given post (either the user who originally created it or an admin of the blog).
  3. password (string): Password for said username.
  4. struct (struct)

API Tags:
See:  basicEntrypoints

Information Tags:
Todo:  Tor - TODO
  • Sort out sql select with blog ID
  • screws up posts with multiple categories partly due to the fact that Movable Type calls to this API are different to Metaweblog API calls when handling categories.

[ Top ]
mw_getcategories  [line 543]

void mw_getcategories( xmlrpcmsg $m  )

metaWeblog.getCategories

Parameters:
xmlrpcmsg   $m:  XML-RPC Message
  1. blogid (string): Unique identifier of the blog the post will be added to. Currently ignored in b2evo, in favor of the category.
  2. username (string): Login for a Blogger user who has permission to edit the given post (either the user who originally created it or an admin of the blog).
  3. password (string): Password for said username.

API Tags:
See:  metawebloggetcategories


[ Top ]
mw_getpost  [line 745]

xmlrpcresp mw_getpost( xmlrpcmsg $m  )

metaweblog.getPost retieves a given post.

Parameters:
xmlrpcmsg   $m:  XML-RPC Message
  1. postid (string): Unique identifier of the post
  2. username (string): Login for a Blogger user who has permission to edit the given post (either the user who originally created it or an admin of the blog).
  3. password (string): Password for said username.

API Tags:
Return:  XML-RPC Response
See:  basicEntrypoints


[ Top ]
mw_getrecentposts  [line 634]

void mw_getrecentposts( xmlrpcmsg $m  )

metaWeblog.getRecentPosts

Parameters:
xmlrpcmsg   $m:  XML-RPC Message
  1. blogid (string): Unique identifier of the blog the post will be added to. Currently ignored in b2evo, in favor of the category.
  2. username (string): Login for a Blogger user who has permission to edit the given post (either the user who originally created it or an admin of the blog).
  3. password (string): Password for said username.

API Tags:
See:  metawebloggetrecentposts


[ Top ]
mw_newmediaobject  [line 168]

xmlrpcresp mw_newmediaobject( xmlrpcmsg $m  )

metaWeblog.newMediaObject image upload

image is supplied coded in the info struct as bits

Parameters:
xmlrpcmsg   $m:  XML-RPC Message
  1. blogid (string): Unique identifier of the blog the post will be added to. Currently ignored in b2evo, in favor of the category.
  2. username (string): Login for a Blogger user who has permission to edit the given post (either the user who originally created it or an admin of the blog).
  3. password (string): Password for said username.
  4. struct (struct) - name : filename - type : mimetype - bits : base64 encoded file

API Tags:
Return:  XML-RPC Response
See:  metaweblognewmediaobject

Information Tags:
Todo:  do not overwrite existing pics with same name
Todo:  extensive permissions

[ Top ]
mw_newpost  [line 337]

void mw_newpost( xmlrpcmsg $m  )

metaWeblog.newPost

mw API Tor 2004

NB! (Tor Feb 2005) status in metaweblog API speak dictates whether static html files are generated or not, so fairly misleading

Parameters:
xmlrpcmsg   $m:  XML-RPC Message
  1. blogid (string): Unique identifier of the blog the post will be added to. Currently ignored in b2evo, in favor of the category.
  2. username (string): Login for a Blogger user who has permission to edit the given post (either the user who originally created it or an admin of the blog).
  3. password (string): Password for said username.
  4. struct (struct)


[ Top ]
_mw_decode_postdate  [line 27]

string _mw_decode_postdate( struct $contentstruct, [ $now_if_empty = true]  )

Decode the dateCreated

Parameters:
struct   $contentstruct: 
   $now_if_empty: 

API Tags:
Return:  MYSQL date


[ Top ]
_mw_get_cat_IDs  [line 56]

array|xmlrpcresp _mw_get_cat_IDs( array $contentstruct, integer $blog_ID, [boolean $empty_struct_ok = false]  )

Get IDs for requested categories

Parameters:
array   $contentstruct:  struct
integer   $blog_ID:  blog ID
boolean   $empty_struct_ok:  Return empty array (instead of error), if no cats given in struct?

API Tags:
Return:  A list of category IDs or xmlrpcresp in case of error.


[ Top ]


Documentation generated on Sat, 06 Mar 2010 03:37:40 +0100 by phpDocumentor 1.4.2. This site is hosted and maintained by Daniel HAHLER (Contact).