X-Git-Url: https://vcs.maemo.org/git/?a=blobdiff_plain;f=www%2Fapi.html;fp=www%2Fapi.html;h=23b3e680f9d8eb6fbdc5604c946408c329117715;hb=540126496f0d971f237a18cb32a85c09229c797e;hp=fe8defe483d03a2d75339e6e3888d44029e47beb;hpb=a357e6fc6537278f56192ac676b8d85e50f03128;p=mysocials diff --git a/www/api.html b/www/api.html index fe8defe..23b3e68 100644 --- a/www/api.html +++ b/www/api.html @@ -166,8 +166,7 @@ Function msa_module_get_info(struct msa_module* d) is used to get informa
Following classes are supported: -
+Following classes are supported:
<Request class="messages" function="getListInboxMessages"> + <Params> + <number name="page"></number> + <number name="pageSize"></number> + <number name="timeOffset"> ... </number> + </Params> +</Request> ++
<Response class="messages" function = "getListInboxMessages"> + <Params> + <array name="messageList" page="..." pageSize="..." quantity="..."> + <struct name="message" id="..."> + <string name="SenderId"> ... </string> + <string name="SenderName"> ... </string> + <string name="Time"> ... </string> + <string name="Title"> ... </string> + <string name="Text"> ... </string> + <string name="Status"> ... </string> + <attachment id="..." ownerId="..." type="..."> + ... + </attachment> + </struct> + </array> + </Params> +</Response> ++
<Request class="messages" function="getListThreads"> + <Params> + <number name="page"></number> + <number name="pageSize"></number> + </Params> +</Request> ++
<Response class="messages" function = "getListThreads"> + <Params> + <array name="threadList" page="..." pageSize="..." quantity="..."> + <struct name="thread" id="..."> + <number name="time"> ... </number> + <number name="size"> ... </number> + </struct> + </array> + </Params> +</Response> ++ +
<Request class="messages" function="getListThreadMessages"> + <Params> + <string name="threadId"></string> + <number name="page"></number> + <number name="pageSize"></number> + </Params> +</Request> ++
<Response class="messages" function = "getListThreadMessages"> + <Params> + <array name="messageList" threadId="..." page="..." pageSize="..." quantity="..."> + <struct name="message" id="..."> + <string name="SenderId"> ... </string> + <string name="SenderName"> ... </string> + <array name="recipientList" quantity="..."> + <struct name="recipient"> + <string name="RecipientId"> ... </string> + <string name="RecipientName"> ... </string> + </struct> + </array> + <string name="Time"> ... </string> + <string name="Title"> ... </string> + <string name="Text"> ... </string> + <string name="Status"> ... </string> + <attachment id="..." ownerId="..." type="..."> + ... + </attachment> + </struct> + </array> + </Params> +</Response> ++
<Request class="messages" function = "getTotalCountInbox"> + <Params/> +</Request> ++ Response: +
<Response class="messages" function = "getTotalCountInbox"> + <Params> + <string name="quantity"> ... </string> + </Params> +</Response> ++ +
<Request class="messages" function = "getTotalCountOutbox"> + <Params/> +</Request> ++ Response: +
<Response class="messages" function = "getTotalCountOutbox"> + <Params> + <string name="quantity"> ... </string> + </Params> +</Response> ++ +
<Request class="messages" function = "getCountInboxByTime"> + <Params> + <number name="timeOffset"> ... </number> + </Params> +</Request> ++ Response: +
<Response class="messages" function = "getCountInboxByTime"> + <Params> + <string name="quantity"> ... </string> + </Params> +</Response> ++ +
<Request class="messages" function = "getCountOutboxByTime"> + <Params> + <number name="timeOffset"> ... </number> + </Params> +</Request> ++ Response: +
<Response class="messages" function = "getCountOutboxByTime"> + <Params> + <string name="quantity"> ... </string> + </Params> +</Response> ++ +
<Request class="messages" function = "sendMessage"> + <Params id="..."> + <string name="text"> ... </string> + <string name="title"> ... </string> + </Params> +</Request> ++ Response: info message or error message. + +
<Request class="messages" function="readMessage"> + <Params> + <string name="messageId"> ... </string> + </Params> +</Request> ++ Response: info message or error message. + +
<Request class="messages" function="deleteMessage"> + <Params> + <string name="messageId"> ... </string> + </Params> +</Request> ++ Response: info message or error message. + +
<Request class="messages" function="getListWallMessages"> + <Params id="..."> + <number name="page"></number> + <number name="pageSize"></number> + </Params> +</Request> ++ Response: +
<Response class="messages" function = "getListWallMessages"> + <Params id="..."> + <array name="messageList" page="..." pageSize="..." quantity="..."> + <struct name="message" id="..."> + <string name="SenderId">... </string> + <string name="SenderName"> ... </string> + <string name="Time"> ... </string> + <string name="Text"> ... </string> + <attachment id="..." ownerId="..." type="..."> + ... + </attachment> + </struct> + </array> + </Params> +</Response> ++
Content of the attachment tag is the same as in class Messages.
+ +<Request class="messages" function = "getTotalCountWall"> + <Params id="..."> + </Params> +</Request> ++ Response: +
<Response class="messages" function = "getTotalCountWall"> + <Params> + <string name="quantity">123</string> + </Params> +</Response> ++ +
<Request class="messages" function = "sendWallMessage"> + <Params id="..."> + <string name="text">text of message</string> + </Params> +</Request> ++ Response: info message or error message. + +
<Request class="messages" function="deleteWallMessage"> + <Params> + <string name="messageId">...</string> + </Params> +</Request> ++ Response: info message or error message. @@ -695,6 +953,27 @@ Function msa_module_get_info(struct msa_module* d) is used to get informa </Params> </Response> + +
<Request class="audio" function="getAudio"> + <Params id="vk..."> + <string name="audioId">...</string> + </Params> +</Request> ++ Response: +
<Response class="audio" function = "getAudio"> + <Params> + <struct name="audio" id="vk..." ownerId="vk..."> + <string name="title">...</string> + <string name="artist">...</string> + <number name="duration">...</number> + <string name="audio">...url...</string> + </struct> + </Params> +</Response> +@@ -726,6 +1005,51 @@ Function msa_module_get_info(struct msa_module* d) is used to get informa
<Request class="news" function="getListNews"> + <Params> + <number name="page"> ... </number> + <number name="pageSize"> ... </number> + <number name="timeOffset"> ... </number> + <string name="newsType">TYPE</string> + </Params> +</Request> ++
TYPE can have following values:
+<Response class="news" function="getListNews"> + <Params> + <array name="newsList" page="..." pageSize="..." quantity="..." newsType="TYPE"> + <struct name="news"> + <string name="authorId"> ... </string> + <string name="authorName"> ... </string> + <string name="text"> ... </string> + <number name="created"> ... </number> + <attachment id="..." ownerId="..." type="image/video/audio/link/note"> + </attachment> + </struct> + </array> + </Params> +</Response> ++ authorName - news author name (optional). +
Content of the attachment tag is the same as in class Messages.