updated api documentation to reflect changes on direct_messages

added direct_messages/destroy, friendica/direct_messages_setseen

diff --git a/doc/api.md b/doc/api.md
index 7d6f440c58c0008ecbaf909048c194f1b09c52ff..02295a95fef7567afed75bcfe7b347be4b26a151 100644 (file)
--- a/doc/api.md
+++ b/doc/api.md
@@ -104,6 +104,7 @@ Unofficial Twitter command. It shows all direct answers (excluding the original
 * max_id: maximum id\r
 * getText: Defines the format of the status field. Can be "html" or "plain"\r
 * include_entities: "true" shows entities for pictures and links (Default: false)\r
+* friendica_verbose: "true" enables different error returns for Windows 10 app (default: "false")\r
 \r
 #### Unsupported parameters\r
 * skip_status\r
@@ -116,6 +117,7 @@ Unofficial Twitter command. It shows all direct answers (excluding the original
 * since_id: minimal id\r
 * max_id: maximum id\r
 * getText: Defines the format of the status field. Can be "html" or "plain"\r
+* friendica_verbose: "true" enables different error returns for Windows 10 app (default: "false")\r
 \r
 ---\r
 ### direct_messages/conversation (*; AUTH)\r
@@ -127,6 +129,18 @@ Shows all direct messages of a conversation
 * max_id: maximum id\r
 * getText: Defines the format of the status field. Can be "html" or "plain"\r
 * uri: URI of the conversation\r
+* friendica_verbose: "true" enables different error returns for Windows 10 app (default: "false")\r
+\r
+---\r
+### direct_messages/sent (*; AUTH)\r
+#### Parameters\r
+* count: Items per page (default: 20)\r
+* page: page number\r
+* since_id: minimal id\r
+* max_id: maximum id\r
+* getText: Defines the format of the status field. Can be "html" or "plain"\r
+* include_entities: "true" shows entities for pictures and links (Default: false)\r
+* friendica_verbose: "true" enables different error returns for Windows 10 app (default: "false")\r
 \r
 ---\r
 ### direct_messages/new (POST,PUT; AUTH)\r
@@ -138,14 +152,22 @@ Shows all direct messages of a conversation
 * title: Title of the direct message\r
 \r
 ---\r
-### direct_messages/sent (*; AUTH)\r
+### direct_messages/destroy (POST,DELETE; AUTH)\r
 #### Parameters\r
-* count: Items per page (default: 20)\r
-* page: page number\r
-* since_id: minimal id\r
-* max_id: maximum id\r
-* getText: Defines the format of the status field. Can be "html" or "plain"\r
-* include_entities: "true" shows entities for pictures and links (Default: false)\r
+* id: id of the message to be deleted\r
+* include_entities: optional, currently not yet implemented\r
+* friendica_parenturi: optional, can be used for increased safety to delete only intended messages\r
+* friendica_verbose: "true" enables different error returns for Windows 10 app (default: "false")\r
+\r
+#### Return values\r
+\r
+On success:\r
+* JSON return as defined for Twitter API not yet implemented\r
+* on friendica_verbose=true: JSON return {"result":"ok","message":"message deleted"}\r
+\r
+On error:\r
+HTTP 400 BadRequest\r
+* on friendica_verbose=true: different JSON returns {"result":"error","message":"xyz"}\r
 \r
 ---\r
 ### favorites (*; AUTH)\r
@@ -694,6 +716,33 @@ xml
        </photos>\r
 ```\r
 \r
+---\r
+### friendica/direct_messages_setseen (GET; AUTH)\r
+#### Parameters\r
+* id: id of the message to be updated as seen\r
+\r
+#### Return values\r
+\r
+On success:\r
+* JSON return {"result":"ok","message":"message set to seen"}\r
+\r
+On error:\r
+* different JSON returns {"result":"error","message":"xyz"}\r
+\r
+---\r
+### friendica/direct_messages_search (GET; AUTH)\r
+#### Parameters\r
+* searchstring: string for which the API call should search as '%searchstring%' in field 'body' of all messages of the authenticated user (caption ignored)\r
+\r
+#### Return values\r
+Returns only tested with JSON, XML might work as well.\r
+\r
+On success:\r
+* JSON return {"success":"true","search_results": array of found messages}\r
+* JSOn return {"success":"false","search_results":"nothing found"}\r
+\r
+On error:\r
+* different JSON returns {"result":"error","message":"searchstring not specified"}\r
 \r
 ---\r
 ## Not Implemented API calls\r
@@ -718,7 +767,6 @@ The following API calls from the Twitter API aren't implemented neither in Frien
 * statuses/lookup\r
 * direct_messages/show\r
 * search/tweets\r
-* direct_messages/destroy\r
 * friendships/no_retweets/ids\r
 * friendships/incoming\r
 * friendships/outgoing\r