Difference between revisions of "XML-RPC Protocol"

From Dreamwidth Notes
Jump to: navigation, search
(Added LJ Server Manual's short descriptions.)
(description of getcircle)
 
(10 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
Placeholder page.  This is where we can link to all of the protocol methods that we have available, including how to use the XML-RPC Protocol, etc...
+
Help us convert the [http://www.livejournal.com/doc/server/ljp.csp.xml-rpc.protocol.html LJ XML-RPC protocols documentation] for our implementation.
−
 
+
−
== Using XML-RPC ==
+
−
 
+
−
This would talk about how to use XML-RPC from various languages...
+
  
 
== Methods ==
 
== Methods ==
Line 9: Line 5:
 
The protocol is still in flux due to the change from LJ's friends system to Dreamwidth's subscription and access system. Not all of these methods have been pushed live yet, but the code has been committed.
 
The protocol is still in flux due to the change from LJ's friends system to Dreamwidth's subscription and access system. Not all of these methods have been pushed live yet, but the code has been committed.
  
−
* [[XML-RPC Protocol Method: addcomment|addcomment]]
+
{| border="1"
−
* [[XML-RPC Protocol Method: consolecommand|consolecommand]] -- Run an administrative command.
+
|method
−
* [[XML-RPC Protocol Method: editcircle|editcircle]]
+
| description
−
* [[XML-RPC Protocol Method: editevent|editevent]] -- Edit or delete a user's past journal entry.
+
|-
−
* [[XML-RPC Protocol Method: friendof|friendof]] -- Designed to return a list of which other users list this user as their friend, but currently returns nothing.
+
| [[XML-RPC Protocol Method: addcomment | addcomment]]  
−
* [[XML-RPC Protocol Method: getchallenge|getchallenge]] -- Generate a server challenge string for authentication.
+
|
−
* [[XML-RPC Protocol Method: getcircle|getcircle]]
+
|-
−
* [[XML-RPC Protocol Method: getdaycounts|getdaycounts]] -- Retrieve the number of journal entries per day.
+
| [[XML-RPC Protocol Method: checkforupdates | checkforupdates]]  
−
* [[XML-RPC Protocol Method: getevents|getevents]] -- Download parts of the user's journal. See also [[XML-RPC Protocol Method: syncitems|syncitems]] mode.
+
| Check for updates on your read list. Replaces "checkfriends".
−
* [[XML-RPC Protocol Method: getfriends|getfriends]] -- Designed to return a list of which other users this user lists as their friend, but currently returns nothing.
+
|-
−
* [[XML-RPC Protocol Method: getfriendspage|getfriendspage]]
+
| [[XML-RPC Protocol Method: consolecommand|consolecommand]]
−
* [[XML-RPC Protocol Method: getinbox|getinbox]]
+
| Run an administrative command.  
−
* [[XML-RPC Protocol Method: gettrustgroups|gettrustgroups]]
+
|-
−
* [[XML-RPC Protocol Method: getusertags|getusertags]] -- Retrieve a list of the user's defined tags.
+
| [[XML-RPC Protocol Method: editcircle|editcircle]]  
−
* [[XML-RPC Protocol Method: login|login]] -- Validate user's password and get base information needed for client to function
+
|
−
* [[XML-RPC Protocol Method: postevent|postevent]] -- Submit a new journal entry to the server.
+
|-
−
* [[XML-RPC Protocol Method: sendmessage|sendmessage]]
+
| [[XML-RPC Protocol Method: editevent|editevent]]  
−
* [[XML-RPC Protocol Method: sessionexpire|sessionexpire]] -- Expire session cookies.
+
| Edit or delete a user's past journal entry.
−
* [[XML-RPC Protocol Method: sessiongenerate|sessiongenerate]] -- Generate a session cookie.
+
|-
−
* [[XML-RPC Protocol Method: setmessageread|setmessageread]]
+
| [[XML-RPC Protocol Method: friendof|friendof]]  
−
* [[XML-RPC Protocol Method: syncitems|syncitems]] -- Get a list of all the items that have been created or updated for a user.
+
| Designed to return a list of which other users list this user as their friend, but currently returns nothing.
 +
|-
 +
| [[XML-RPC Protocol Method: getchallenge|getchallenge]]  
 +
| Generate a server challenge string for authentication.  
 +
|-
 +
| [[XML-RPC Protocol Method: getcircle|getcircle]]  
 +
| Returns details about a user's watch list and/or a user's trust list. Can also get a user's watched-by list, trusted-by list, content filters and trust groups.
 +
|-
 +
| [[XML-RPC Protocol Method: getdaycounts|getdaycounts]]  
 +
| Retrieve the number of journal entries per day.  
 +
|-
 +
| [[XML-RPC Protocol Method: getevents|getevents]]  
 +
| Download parts of the user's journal. See also [[XML-RPC Protocol Method: syncitems|syncitems]] mode.  
 +
|-
 +
| [[XML-RPC Protocol Method: getfriends|getfriends]]  
 +
| Designed to return a list of which other users this user lists as their friend, but currently returns nothing.  
 +
|-
 +
| [[XML-RPC Protocol Method: getfriendspage|getfriendspage]]  
 +
|
 +
|-
 +
| [[XML-RPC Protocol Method: getinbox|getinbox]]  
 +
|
 +
|-
 +
| [[XML-RPC Protocol Method: gettrustgroups|gettrustgroups]]  
 +
|
 +
|-
 +
| [[XML-RPC Protocol Method: getusertags|getusertags]]  
 +
| Retrieve a list of the user's defined tags.  
 +
|-
 +
| [[XML-RPC Protocol Method: login|login]]  
 +
| Validate user's password and get base information needed for client to function.
 +
|-
 +
| [[XML-RPC Protocol Method: postevent|postevent]]  
 +
| Submit a new journal entry to the server.  
 +
|-
 +
| [[XML-RPC Protocol Method: sendmessage|sendmessage]]  
 +
| Send a private message to a user's inbox.
 +
|-
 +
| [[XML-RPC Protocol Method: sessionexpire|sessionexpire]]  
 +
| Expire session cookies.  
 +
|-
 +
| [[XML-RPC Protocol Method: sessiongenerate|sessiongenerate]]  
 +
| Generate a session cookie.  
 +
|-
 +
| [[XML-RPC Protocol Method: setmessageread|setmessageread]]  
 +
|
 +
|-
 +
| [[XML-RPC Protocol Method: syncitems|syncitems]]  
 +
| Get a list of all the items that have been created or updated for a user.  
 +
|}
  
 
== Deprecated Methods ==
 
== Deprecated Methods ==
  
−
* checkfriends -- Checks to see if the user's friends list has been updated since a specified time. Temporarily disabled, to be aliased to new method "checksubscriptions" once that method is written.
+
{| border="1"
−
* editfriends -- Deprecated, use [[XML-RPC Protocol Method: editcircle|editcircle]] instead.
+
|Deprecated method
−
* editfriendgroups -- Deprecated, use [[XML-RPC Protocol Method: editcircle|editcircle]] instead.
+
|Remarks
−
* getfriendgroups -- Deprecated, use [[XML-RPC Protocol Method: gettrustgroups|gettrustgroups]] instead.
+
|-
 +
|checkfriends
 +
|Checks to see if the user's friends list has been updated since a specified time. Deprecated, use [[XML-RPC Protocol Method: checkforupdates|checkforupdates]] instead.
 +
|-
 +
|editfriends
 +
|Deprecated, use [[XML-RPC Protocol Method: editcircle|editcircle]] instead.
 +
|-
 +
|editfriendgroups
 +
|Deprecated, use [[XML-RPC Protocol Method: editcircle|editcircle]] instead.
 +
|-
 +
|getfriendgroups
 +
|Deprecated, use [[XML-RPC Protocol Method: gettrustgroups|gettrustgroups]] instead.
 +
|}
  
−
[[Category: Development]]
+
[[Category: XML-RPC Protocol]]

Latest revision as of 08:17, 23 April 2011

Help us convert the LJ XML-RPC protocols documentation for our implementation.

Methods

The protocol is still in flux due to the change from LJ's friends system to Dreamwidth's subscription and access system. Not all of these methods have been pushed live yet, but the code has been committed.

method description
addcomment
checkforupdates Check for updates on your read list. Replaces "checkfriends".
consolecommand Run an administrative command.
editcircle
editevent Edit or delete a user's past journal entry.
friendof Designed to return a list of which other users list this user as their friend, but currently returns nothing.
getchallenge Generate a server challenge string for authentication.
getcircle Returns details about a user's watch list and/or a user's trust list. Can also get a user's watched-by list, trusted-by list, content filters and trust groups.
getdaycounts Retrieve the number of journal entries per day.
getevents Download parts of the user's journal. See also syncitems mode.
getfriends Designed to return a list of which other users this user lists as their friend, but currently returns nothing.
getfriendspage
getinbox
gettrustgroups
getusertags Retrieve a list of the user's defined tags.
login Validate user's password and get base information needed for client to function.
postevent Submit a new journal entry to the server.
sendmessage Send a private message to a user's inbox.
sessionexpire Expire session cookies.
sessiongenerate Generate a session cookie.
setmessageread
syncitems Get a list of all the items that have been created or updated for a user.

Deprecated Methods

Deprecated method Remarks
checkfriends Checks to see if the user's friends list has been updated since a specified time. Deprecated, use checkforupdates instead.
editfriends Deprecated, use editcircle instead.
editfriendgroups Deprecated, use editcircle instead.
getfriendgroups Deprecated, use gettrustgroups instead.
Retrieved from "http://wiki.dreamwidth.net/wiki/index.php?title=XML-RPC_Protocol&oldid=9683"