fix link to image
[mysocials] / www / api.html
index cd8180b..a3240a4 100644 (file)
@@ -28,7 +28,7 @@
       <tr align="center">
        <td><a href="index.html" class="toplinks">About</a></td>
        <td class="toplinks">|</td>
-        <td><a href="sreenshots.html" class="toplinks">Screenshots</a></td>
+        <td><a href="screenshots.html" class="toplinks">Screenshots</a></td>
         <td class="toplinks">|</td>
         <td><a href="api.html" class="toplinks">MySocials API</a></td>
         <td class="toplinks">|</td>
@@ -80,7 +80,7 @@
        </p>
        <h3>Interaction with driver</h3>
        <p>
-       Fuction <b>msa_module->send(xmlDocPtr request, xmlDocPtr* response, const struct msa_module* info)</b> is used to perform requests to the driver. 
+       Function <b>msa_module->send(xmlDocPtr request, xmlDocPtr* response, const struct msa_module* info)</b> is used to perform requests to the driver. 
 Parameter <i>request</i> is a request in XML format. Description of structure of sending and receiveing data is described <a>here</a>.
 Parameter <i>response</i> contains driver response in XML format.
 Function <b>msa_module_get_info(struct msa_module* d)</b> is used to get information about driver (driver name and icon).
@@ -105,7 +105,7 @@ Function <b>msa_module_get_info(struct msa_module* d)</b> is used to get informa
        </pre>
 
        <h3>Driver interface</h3>
-       <p>MySocials driver interface described in  <b>msa_module</b> structure. Some of the fields of this stucture are filled before initialization by application (marked with **), the rest of it is filled during initialization.</p>
+       <p>MySocials driver interface described in  <b>msa_module</b> structure. Some of the fields of this structure are filled before initialization by application (marked with **), the rest of it is filled during initialization.</p>
 
        <pre class="c" style="font-family:monospace;"><span style="color: #993333;">struct</span> msa_module <span style="color: #009900;">&#123;</span>
        gchar <span style="color: #339933;">*</span>id<span style="color: #339933;">;</span>    <span style="color: #666666; font-style: italic;">// Identifier </span>
@@ -151,7 +151,7 @@ Function <b>msa_module_get_info(struct msa_module* d)</b> is used to get informa
        <li><i>noAuthorize</i> - flag which forbids driver to call WebAuth (optional, set to false by default) </li>
        <li><i>class</i> - class which includes called function</li>
        <li><i>function</i> - name of the function</li>
-       <li><i>Params</i> - set of parameters, stricly defined for each function</li>
+       <li><i>Params</i> - set of parameters, strictly defined for each function</li>
        </ul>
 
        <h4>Response format</h4>
@@ -163,7 +163,7 @@ Function <b>msa_module_get_info(struct msa_module* d)</b> is used to get informa
        </pre>
        
        <ul>
-       <li><i>authorized</i> - flag which indicates authorization during request performing (flag isn't set if error occures during request performing) </li>
+       <li><i>authorized</i> - flag which indicates authorization during request performing (flag isn't set if error occurs during request performing) </li>
        <li><i>upload</i> - number of bytes sent to server</li>
        <li><i>download</i> - number of bytes received from server</li>
        </ul>
@@ -269,7 +269,6 @@ Function <b>msa_module_get_info(struct msa_module* d)</b> is used to get informa
        <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;">&lt;Request</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">&quot;profile&quot;</span> <span style="color: #000066;">function</span>=<span style="color: #ff0000;">&quot;getBaseProfile&quot;</span><span style="color: #000000; font-weight: bold;">&gt;</span></span>
        <span style="color: #009900;"><span style="color: #000000; font-weight: bold;">&lt;Params</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">&quot;...&quot;</span><span style="color: #000000; font-weight: bold;">&gt;</span></span>
 <span style="color: #009900;"><span style="color: #000000; font-weight: bold;">&lt;/Request<span style="color: #000000; font-weight: bold;">&gt;</span></span></span>
-&nbsp;
        </pre>
        <p>Attribute <i>id</i> is an id of user whose profile is needed to be received (optional, equals id of owner of current account by default).</p>
        <b>Response:</b>
@@ -281,6 +280,32 @@ Function <b>msa_module_get_info(struct msa_module* d)</b> is used to get informa
         <span style="color: #009900;"><span style="color: #000000; font-weight: bold;">&lt;/Params<span style="color: #000000; font-weight: bold;">&gt;</span></span></span>
 <span style="color: #009900;"><span style="color: #000000; font-weight: bold;">&lt;/Response<span style="color: #000000; font-weight: bold;">&gt;</span></span></span>
        </pre>
+
+       <h4>getStatus</h4>
+       <b>Request:</b>
+       <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;">&lt;Request</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">&quot;profile&quot;</span> function = <span style="color: #ff0000;">&quot;getStatus&quot;</span><span style="color: #000000; font-weight: bold;">&gt;</span></span>
+     <span style="color: #009900;"><span style="color: #000000; font-weight: bold;">&lt;Params</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">&quot;...&quot;</span> <span style="color: #000000; font-weight: bold;">/&gt;</span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;">&lt;/Request<span style="color: #000000; font-weight: bold;">&gt;</span></span></span>
+       </pre>
+       <p>Attribute <i>id</i> is an id of user whose status is needed to be received (optional, equals id of owner of current account by default). </p>
+       <b>Response:</b>
+       <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;">&lt;Response</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">&quot;profile&quot;</span> function = <span style="color: #ff0000;">&quot;getStatus&quot;</span><span style="color: #000000; font-weight: bold;">&gt;</span></span>
+      <span style="color: #009900;"><span style="color: #000000; font-weight: bold;">&lt;Params</span> <span style="color: #000066;">id</span>=<span style="color: #ff0000;">&quot;vk ...&quot;</span><span style="color: #000000; font-weight: bold;">&gt;</span></span>
+            <span style="color: #009900;"><span style="color: #000000; font-weight: bold;">&lt;string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">&quot;Text&quot;</span><span style="color: #000000; font-weight: bold;">&gt;</span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;">&lt;/string<span style="color: #000000; font-weight: bold;">&gt;</span></span></span>
+      <span style="color: #009900;"><span style="color: #000000; font-weight: bold;">&lt;/Params<span style="color: #000000; font-weight: bold;">&gt;</span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;">&lt;/Response<span style="color: #000000; font-weight: bold;">&gt;</span></span></span>
+       </pre>
+
+       <h4>setStatus</h4>
+       <b>Request:</b>
+       <pre class="xml" style="font-family:monospace;"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;">&lt;Request</span> <span style="color: #000066;">class</span>=<span style="color: #ff0000;">&quot;profile&quot;</span> function = <span style="color: #ff0000;">&quot;setStatus&quot;</span><span style="color: #000000; font-weight: bold;">&gt;</span></span>
+     <span style="color: #009900;"><span style="color: #000000; font-weight: bold;">&lt;Params<span style="color: #000000; font-weight: bold;">&gt;</span></span></span>
+            <span style="color: #009900;"><span style="color: #000000; font-weight: bold;">&lt;string</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">&quot;Text&quot;</span><span style="color: #000000; font-weight: bold;">&gt;</span></span> ... <span style="color: #009900;"><span style="color: #000000; font-weight: bold;">&lt;/string<span style="color: #000000; font-weight: bold;">&gt;</span></span></span>
+     <span style="color: #009900;"><span style="color: #000000; font-weight: bold;">&lt;/Params<span style="color: #000000; font-weight: bold;">&gt;</span></span></span>
+<span style="color: #009900;"><span style="color: #000000; font-weight: bold;">&lt;/Request<span style="color: #000000; font-weight: bold;">&gt;</span></span></span>
+       </pre>
+       <p><i>Text</i> is a content of user's status.</p> 
+       <b>Response:</b> info message or error message.
        <!-- Profile finish -->
 
        <!-- Friends start -->