====== Interface XML/RPC de DotClear ======

DotClear propose d'intégrer les méthodes XML/RPC suivantes : Blogger API 1.0, metaWeblog et MovableType. Ceci revient à supporter la même spécification que MovableType. L'objectif est de pouvoir utiliser les client XML/RPC en spécifiant MovableType comme type de weblogue.

Voir à ce propos MovableType programmatic interfaces.

L'interface XML/RPC ne supporte que le format XHTML. Un billet dont le format original est Wiki, édité via un client XML/RPC sera converti en XHTML sans possibilité de revenir à la syntaxe Wiki.

Clients testés avec succès :

    * BloGTK (en mode MovableType)
    * w.bloggar (en mode MovableType - uniquement ISO-8859-1) 

===== Méthodes Blogger =====

==== blogger.newPost ====

Description : Crée un nouveau billet et, éventuellement, le publie.

Paramètres : String appkey, String blogid, String username, String password, String content, boolean publish.

Retourne : En cas de succès, String postid, l'id du nouveau billet ; en cas d'erreur, une erreur XML/RPC.

==== blogger.editPost ====

Description : Met à jour un billet donné.

Paramètres : String appkey, String postid, String username, String password, String content, boolean publish.

Retourne : En cas de succès, valeur booléenne vraie, sinon une erreur XML/RPC.

==== blogger.getPost ====

Description : Renvoie les informations sur un billet donné.

Paramètres : String appkey, String postid, String username, String password.

Retourne : En cas de succès, struct contenant String userid, ISO.8601 dateCreated, String content ; sinon une erreur XML/RPC

==== blogger.deletePost ====

Description : Supprime un billet.

Paramètres : String appkey, String postid, String username, String password, boolean publish

Retourne : En cas de succès, valeur booléenne vraie, sinon une erreur XML/RPC.

==== blogger.getRecentPosts ====

Description : Renvoie la liste des billets les plus récents sur le système.

Parameters : String appkey, String blogid, String username, String password, int numberOfPosts

Retourne: En cas de succès, un tableau de structs contenant ISO.8601 dateCreated, String userid, String postid, String content ; sinon une erreur XML/PRC.

==== blogger.getUsersBlogs ====

Description : Renvoie la liste des weblogues sur lesquels l'auteur peut poster.

Paramètres : String appkey, String username, String password.

Retourne : En cas de succès, un tableau de structs contenant String url, String blogid, String blogName ; sinon une erreur XML/RPC.

<note>DotClear ne gérant qu'un seul weblogue, il retournera toujours 1 comme ID.</note>

==== blogger.getUserInfo ====

Description : Renvoie des informations à propos de l'auteur identifié.

Paramètres : String appkey, String username, String password.

Retourne : En cas de succès, un struct contenant String userid, String firstname, String lastname, String nickname, String email, String url ; sinon une erreur XML/RPC.

===== Méthodes metaWeblog =====


==== metaWeblog.newPost ====

Description : Création d'un nouveau billet.

Paramètres : String blogid, String username, String password, struct content, boolean publish.

Retourne : En cas de succès, String postid, l'id du nouveau billet ; en cas d'erreur, une erreur XML/RPC.

<note>Le struct content peut contenir les valeurs courantes suivantes :

    * title pour le titre du billet ;
    * description pour le contenu du billet ;
    * mt_allow_comments pour indiquer si les commentaires sont permis ou non ;
    * mt_allow_pings pour indiquer si les trackbacks sont permis ou non ;
    * mt_excerpt pour le chapo du billet.
</note>

==== metaWeblog.editPost ====

Description : Met à jour les informations d'un billet donné.

Paramètres : String postid, String username, String password, struct content, boolean publish.

Retourne : En cas de succès, valeur booléenne vraie, sinon une erreur XML/RPC.

<note>Le struct content peut contenir les valeurs courantes suivantes :

    * title pour le titre du billet ;
    * description pour le contenu du billet ;
    * dateCreated pour la date du billet ;
    * mt_allow_comments pour indiquer si les commentaires sont permis ou non ;
    * mt_allow_pings pour indiquer si les trackbacks sont permis ou non ;
    * mt_excerpt pour le chapo du billet.
</note>

==== metaWeblog.getPost ====

Description : Renvoie les informations sur un billet donné.

Paramètres : String postid, String username, String password

Retourne : En cas de succès, un struct contenant String userid, ISO.8601 dateCreated, String postid, String description, String title, String link, String permaLink, String mt_excerpt, String mt_text_more, int mt_allow_comments, int mt_allow_pings, String mt_convert_breaks, String mt_keywords ; sinon une erreur XML/RPC.

<note>Les champs mt_text_more, mt_convert_breaks et mt_keywords sont toujours vide. Le champs description et mt_excerpt contiennent respectivement le contenu et le chapo du billet.</note>

==== metaWeblog.getRecentPosts ====

Description : Renvoie la liste des billets les plus récents sur le système.

Paramètres : String blogid, String username, String password, int numberOfPosts.

Retourne : En cas de succès, un tableau de structs contenant ISO.8601 dateCreated, String userid, String postid, String description, String title, String link, String permaLink, String mt_excerpt, String mt_text_more, int mt_allow_comments, int mt_allow_pings, String mt_convert_breaks, String mt_keywords ; sinon une erreur XML/RPC.

<note>Les champs mt_text_more, mt_convert_breaks et mt_keywords sont toujours vide. Le champs description et mt_excerpt contiennent respectivement le contenu et le chapo du billet.</note>

==== metaWeblog.newMediaObject ====

Méthode non supportée.

===== Méthodes MovableType =====

==== mt.getRecentPostTitles ====

Description : Renvoie la liste des titres des billets les plus récents sur le système.

Paramètres : String blogid, String username, String password, int numberOfPosts.

Retourne : En cas de succès, un tableau de structs contenant ISO.8601 dateCreated, String userid, String postid, String title ; sinon une erreur XML/RPC.

==== mt.getCategoryList ====

Description : Renvoie la liste des catégories définies sur le weblogue.

Parameters : String blogid, String username, String password.

Retourne : en cas de succès, un tableau de structs contenant String categoryId et String categoryName; sinon, une erreur XML/RPC.

==== mt.getPostCategories ====

Description : Renvoie la liste des catégories du billet.

Paramètres : String postid, String username, String password.

Retourne : en cas de succès, un tableau de structs contenant String categoryName, String categoryId, et boolean isPrimary; sinon, une erreur XML/RPC.

<note>Un billet sur DotClear n'a qu'une catégorie, le tableau n'en aura donc qu'une seule, avec isPrimary marqué comme vrai.</note>

==== mt.setPostCategories ====

Description : Définit la catégorie d'un billet.

Paramètres : String postid, String username, String password, array categories.

Retourne : en cas de succès, un booléen vrai ; sinon, une erreur XML/RPC.

<note>le tableau categories est un tableau de structs contenant String categoryId et boolean isPrimary. Dans le cas de DotClear, la catégorie marquée comme isPrimary, si elle existe, sinon la première de la liste sera utilisée comme catégorie du billet.</note>

==== mt.supportedMethods ====

Description : Renvoie les méthodes XML/RPC supportées par le serveur.

Paramètres : aucun

Retourne : Tableau des méthodes supportées par le serveur.

==== mt.supportedTextFilters ====

Méthode non supportée.

==== mt.getTrackbackPings ====

Méthode non supportée.

==== mt.publishPost ====

Méthode non supportée.