phpDocumentor xml
[ class tree: xml ] [ index: xml ] [ all elements ]

Procedural File: _blogger.api.php

Source Location: /qp_inc/xmlrpc/apis/_blogger.api.php

Page Details

XML-RPC : Blogger API

Quam Plures - http://quamplures.net/ Released under GNU GPL License - http://quamplures.net/license.html

Copyright:  (c)2003-2009 by Francois PLANQUE - http://fplanque.net/
Copyright:  (c) 2009 - 2011 by the Quam Plures developers - http://quamplures.net/
See:  http://www.sixapart.com/developers/xmlrpc/blogger_api/
See:  http://manual.b2evolution.net/Blogger_API
See:  http://www.blogger.com/developers/api/1_docs/
Filesource:  Source Code for this file
Functions
blogger_deletepost  [line 237]

xmlrpcresp blogger_deletepost( xmlrpcmsg $m  )

blogger.deletePost deletes a given post.

This API call is not documented on http://www.blogger.com/developers/api/1_docs/

Parameters:
xmlrpcmsg   $m:  XML-RPC Message
  1. appkey (string): Unique identifier/passcode of the application sending the post. (See access info http://www.blogger.com/developers/api/1_docs/#access .)
  2. postid (string): Unique identifier of the post to be deleted.
  3. 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).
  4. password (string): Password for said username.

API Tags:
Return:  XML-RPC Response
See:  http://www.sixapart.com/developers/xmlrpc/blogger_api/bloggerdeletepost.html


[ Top ]
blogger_editpost  [line 146]

xmlrpcresp blogger_editpost( xmlrpcmsg $m  )

blogger.editPost changes the contents of a given post.

Optionally, will publish the blog the post belongs to after changing the post. (In QP, this means the changed post will be moved to published state). On success, it returns a boolean true value. On error, it will return a fault with an error message.

Parameters:
xmlrpcmsg   $m:  XML-RPC Message
  1. appkey (string): Unique identifier/passcode of the application sending the post. (See access info http://www.blogger.com/developers/api/1_docs/#access .)
  2. postid (string): Unique identifier of the post to be changed.
  3. 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).
  4. password (string): Password for said username.
  5. content (string): New content of the post.
  6. publish (boolean): If true, the blog will be published immediately after the post is made. (In QP, this means, the new post will be in 'published' state, otherwise it would be in draft state).

API Tags:
Return:  XML-RPC Response
See:  http://www.blogger.com/developers/api/1_docs/xmlrpc_editPost.html
See:  http://www.sixapart.com/developers/xmlrpc/blogger_api/bloggereditpost.html

Information Tags:
Todo:  check current status and permission on it

[ Top ]
blogger_getpost  [line 407]

xmlrpcresp blogger_getpost( xmlrpcmsg $m  )

blogger.getPost retieves a given post.

This API call is not documented on http://www.blogger.com/developers/api/1_docs/

Parameters:
xmlrpcmsg   $m:  XML-RPC Message
  1. appkey (string): Unique identifier/passcode of the application sending the post. (See access info http://www.blogger.com/developers/api/1_docs/#access .)
  2. postid (string): Unique identifier of the post to be deleted.
  3. 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).
  4. password (string): Password for said username.

API Tags:
Return:  XML-RPC Response
See:  http://www.sixapart.com/developers/xmlrpc/blogger_api/bloggergetpost.html


[ Top ]
blogger_getrecentposts  [line 475]

xmlrpcresp blogger_getrecentposts( xmlrpcmsg $m  )

blogger.getRecentPosts retieves X most recent posts.

This API call is not documented on http://www.blogger.com/developers/api/1_docs/

Parameters:
xmlrpcmsg   $m:  XML-RPC Message
  1. appkey (string): Unique identifier/passcode of the application sending the post. (See access info http://www.blogger.com/developers/api/1_docs/#access .)
  2. blogid (string): Unique identifier of the blog the post will be added to. Currently ignored in QP, in favor of the category.
  3. 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).
  4. password (string): Password for said username.
  5. numposts (integer): number of posts to retrieve.

API Tags:
Return:  XML-RPC Response
See:  http://www.sixapart.com/developers/xmlrpc/blogger_api/bloggergetrecentposts.html


[ Top ]
blogger_getuserinfo  [line 364]

xmlrpcresp blogger_getuserinfo( xmlrpcmsg $m  )

blogger.getUserInfo returns returns a struct containing user info.

Data returned: userid, firstname, lastname, nickname, email, and url.

see http://www.blogger.com/developers/api/1_docs/xmlrpc_getUserInfo.html

Parameters:
xmlrpcmsg   $m:  XML-RPC Message
  1. appkey (string): Unique identifier/passcode of the application sending the post. (See access info http://www.blogger.com/developers/api/1_docs/#access .)
  2. username (string): Login for the Blogger user who's blogs will be retrieved.
  3. password (string): Password for said username. (currently not required by QP)

API Tags:
Return:  XML-RPC Response, a <struct> containing:
  • userid,
  • firstname,
  • lastname,
  • nickname,
  • email,
  • url
See:  http://www.sixapart.com/developers/xmlrpc/blogger_api/bloggergetuserinfo.html


[ Top ]
blogger_getusersblogs  [line 302]

xmlrpcresp blogger_getusersblogs( xmlrpcmsg $m  )

blogger.getUsersBlogs returns information about all the blogs a given user is a member of.

Data is returned as an array of <struct>s containing the ID (blogid), name (blogName), and URL (url) of each blog.

Non official: Also return a boolean stating wether or not the user can edit the blog templates (isAdmin).

see http://www.blogger.com/developers/api/1_docs/xmlrpc_getUsersBlogs.html

Parameters:
xmlrpcmsg   $m:  XML-RPC Message
  1. appkey (string): Unique identifier/passcode of the application sending the post. (See access info http://www.blogger.com/developers/api/1_docs/#access .)
  2. username (string): Login for the Blogger user who's blogs will be retrieved.
  3. password (string): Password for said username. (currently not required by QP)

API Tags:
Return:  XML-RPC Response, an array of <struct>s containing for each blog:
  • ID (blogid),
  • name (blogName),
  • URL (url),
  • bool: can user edit template? (isAdmin).
See:  http://www.sixapart.com/developers/xmlrpc/blogger_api/bloggergetusersblogs.html


[ Top ]
blogger_newpost  [line 46]

xmlrpcresp blogger_newpost( xmlrpcmsg $m  )

blogger.newPost makes a new post to a designated blog.

Optionally, will publish the blog after making the post. (In QP, this means the new post will be in 'published' state). On success, it returns the unique ID of the new post (usually a seven-digit number at this time). On error, it will return some error message.

Parameters:
xmlrpcmsg   $m:  XML-RPC Message
  1. appkey (string): Unique identifier/passcode of the application sending the post. (See access info http://www.blogger.com/developers/api/1_docs/#access .)
  2. blogid (string): Unique identifier of the blog the post will be added to. Currently ignored in QP, in favor of the category.
  3. username (string): Login for a Blogger user who has permission to post to the blog.
  4. password (string): Password for said username.
  5. content (string): Contents of the post.
  6. publish (boolean): If true, the blog will be published immediately after the post is made. (In QP, this means, the new post will be in 'published' state, otherwise it would be in draft state).

API Tags:
Return:  XML-RPC Response
See:  http://www.sixapart.com/developers/xmlrpc/blogger_api/bloggernewpost.html
See:  http://www.blogger.com/developers/api/1_docs/xmlrpc_newPost.html


[ Top ]