Changes between Initial Version and Version 1 of XmlRpcLogOut


Ignore:
Timestamp:
Sep 26, 2008, 7:22:28 PM (16 years ago)
Author:
guest
Comment:

Created this page [Majky]

Legend:

Unmodified
Added
Removed
Modified

  • XmlRpcLogOut

    v1 v1  
     1
     2=== !LogOut ===
     3
     4[[PageOutline(3-4, Sections)]]
     5
     6=== Intro ===
     7
     8  logout user and end the session
     9
     10
     11=== Description ===
     12
     13  '''struct !LogOut(string $token)'''
     14
     15  This will logout user identified by token ''token''.
     16  This function should be called just before exiting/closing client application.
     17
     18
     19=== Parameters ===
     20
     21  This function takes a single parameter of type ''string'':
     22
     23  ''token''::
     24    token string identifying user's session, taken from [wiki:XmlRpcLogIn LogIn] result structure.
     25
     26
     27=== Return Values ===
     28
     29  Output is returned in this structure:
     30{{{
     31  struct(
     32    (string) [status],
     33    (double) [seconds]
     34  )
     35}}}
     36
     37  and contains these elements:
     38    ''status''::
     39      function result code, see [XmlRpcStatusCode list of status codes]
     40    ''seconds''::
     41      time taken to execute this command on server
     42
     43
     44=== Implementations ===
     45  There are currently no available sample implementations.
     46
     47
     48=== Changelog ===
     49
     50  Version 1: created this function
     51
     52=== Examples ===
     53
     54
     55==== Input ====
     56 
     57{{{
     58#!xml
     59<methodCall>
     60 <methodName>LogOut</methodName>
     61 <params>
     62  <param>
     63   <value><string>5fdgt2e9qriblpbojnq0j46op1</string></value>
     64  </param>
     65 </params>
     66</methodCall>
     67}}}
     68 
     69 
     70==== Output ====
     71 
     72{{{
     73#!xml
     74<methodResponse>
     75 <params>
     76  <param>
     77   <value>
     78    <struct>
     79     <member>
     80      <name>status</name>
     81      <value><string>200 OK</string></value>
     82     </member>
     83     <member>
     84      <name>seconds</name>
     85      <value><double>0.197</double></value>
     86     </member>
     87    </struct>
     88   </value>
     89  </param>
     90 </params>
     91</methodResponse>
     92}}}
     93
     94
     95=== Notes ===
     96
     97  none yet
     98
     99
     100=== See also ===
     101
     102  * [wiki:XmlRpcLogIn LogIn]
     103  * [wiki:XmlRpcNoOperation NoOperation]
     104
     105
     106=== Comments ===
     107
     108        add your comments, hints and suggestion here if you like ...
     109
     110
     111[wiki:XmlRpcLogIn Prev] [wiki:XmlRpcIntro Home] [Next]