(no commit message)

[euphorik.git] / doc / protocole3.txt

diff --git a/doc/protocole3.txt b/doc/protocole3.txt
index 6126502..fdb68df 100644 (file)
--- a/doc/protocole3.txt
+++ b/doc/protocole3.txt
@@ -29,6 +29,19 @@ c : client
 s : server
 Les messages client vers serveur sont envoyés par HTTP-POST.
 
+A toutes les requêtes le serveur peut répondre une erreur :
+<error>
+   {
+      "reply" : "error",
+      "error_message" : "blabla"
+   }
+   
+Message ok générique :
+<ok>
+   {
+      "reply" : "ok"
+   }
+
 
 C.1. Login
 ----------
@@ -55,7 +68,7 @@ ou
 s -> c\r
    {\r
       "reply" : "login",\r
-      "status" : "registration_ok" | "authentification_ok" | "error",\r
+      "status" : "registration_ok" | "authentification_ok",\r
       "cookie" : "LKJDLAKSJBFLKASN",\r
       "id" : 193,\r
       "pseudo" : "Paul",\r
@@ -68,8 +81,7 @@ s -> c
             "root" : 123,\r
             "page" : 1\r
          }\r
-      ],\r
-      "error_message" : "blabla"\r
+      ]\r
    }
  \r
  
@@ -84,7 +96,6 @@ c -> s
  
 C.3. Profile
 ------------
-Modification du profile, seul "cookie" est obligatoire.
 
 c -> s\r
    {\r
@@ -95,7 +106,7 @@ c -> s
       "pseudo" : "Paul",\r
       "email" : "paul@pierre.com",\r
       "css" : "css/3/euphorik.css",\r
-      "mainPage" : 1,\r
+      "main_page" : 1,\r
       "conversations" : [\r
          {\r
             "root" : 123,\r
@@ -104,11 +115,10 @@ c -> s
       ]\r
    }\r
       
-s -> c\r
-   {\r
-      "reply" : "ok" | "error",\r
-      "error_message" : "blabla"\r
-   }
+s -> c
+   <ok>
+ou
+   <error>
 
 
 C.4. Wait event
@@ -122,7 +132,7 @@ c -> s
       "cookie" : "LKJDLAKSJBFLKASN",\r
       "message_count" : 10,\r
       "last_message_id" : 163,
-      "mainPage" : 1,
+      "main_page" : 1,
       "conversations" : [
          {
             "root" : 123,
@@ -138,21 +148,24 @@ Le format de la date n'est pas formel.
    {\r
       "reply" : "new_messages",\r
       "conversations" : [\r
-         "last_page" : true | false,\r
-         "messages" : [\r
-            "id" : 54,\r
-            "date" : "Hier 17:26:54",\r
-            "system" : true | false,\r
-            "owner" : true | false,\r
-            "answered" : true | false,\r
-            "is_a_reply" : true | false,\r
-            "nick" : "Paul",\r
-            "login" : "paul_22",\r
-            "content" : "Salut",\r
-            "answer_to" : [\r
-               { "id" : 123, "pseudo" : "Pierre", "login" : "pierre_45" }\r
+         {\r
+            "last_page" : true | false,\r
+            "messages" : [\r
+               "id" : 54,\r
+               "date" : "Hier 17:26:54",\r
+               "system" : true | false,\r
+               "owner" : true | false,\r
+               "answered" : true | false,\r
+               "is_a_reply" : true | false,\r
+               "nick" : "Paul",\r
+               "login" : "paul_22",\r
+               "content" : "Salut",\r
+               "answer_to" : [\r
+                  { "id" : 123, "pseudo" : "Pierre", "login" : "pierre_45" }\r
+               ]\r
             ]\r
-         ]\r
+         }\r
+         ...\r
       ]\r
    }
 ou\r
@@ -166,9 +179,26 @@ ou
       "reply" : "error",\r
       "error_message" : "blabla"\r
    }
+\r
+\r
+C.5. Envoie troll\r
+-------------------\r
+\r
+c -> s\r
+   {\r
+      "action" : "put_troll",\r
+      "cookie" : "LKJDLAKSJBFLKASN",\r
+      "content" : "Un bon troll velu !"\r
+   }\r
+ \r
+s -> c\r
+   {\r
+      "reply" : "ok" | "error",\r
+      "error_message" : "blabla"\r
+   }\r
+   
 
-
-C.5. Envoie message
+C.6. Envoie message
 -------------------
 Le client envoie un message, le message peut répondre à un certain nombre d'autres messages.
 "answer_to" n'est pas obligatoire.\r
@@ -179,6 +209,7 @@ c -> s
       "cookie" : "LKJDLAKSJBFLKASN",\r
       "nick" : "Paul",\r
       "content" : "Bonjour",\r
+      "Troll" : 45,\r
       "answer_to" : [ 345, 532, ... ]\r
    }
  
@@ -189,7 +220,7 @@ s -> c
    }
  \r
  \r
-C.6 Ajout d'une correction d'un messages\r
+C.7. Ajout d'une correction d'un messages\r
 ----------------------------------------\r
 Le client envoie un correctif sous la forme de texte supplémentaire à appondre au dernier messages.\r
 Le message est appondu avec un " +++ " devant, par exemple :\r