Difference between revisions of "XML-RPC Protocol"
From Dreamwidth Notes
(a table is easier to read and maintain) |
(description of getcircle) |
||
| (6 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | Help us convert the [http://www.livejournal.com/doc/server/ljp.csp.xml-rpc.protocol.html LJ XML-RPC protocols documentation] for our implementation. | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
== Methods == | == Methods == | ||
| Line 15: | Line 11: | ||
| [[XML-RPC Protocol Method: addcomment | addcomment]] | | [[XML-RPC Protocol Method: addcomment | addcomment]] | ||
| | | | ||
| + | |- | ||
| + | | [[XML-RPC Protocol Method: checkforupdates | checkforupdates]] | ||
| + | | Check for updates on your read list. Replaces "checkfriends". | ||
|- | |- | ||
| [[XML-RPC Protocol Method: consolecommand|consolecommand]] | | [[XML-RPC Protocol Method: consolecommand|consolecommand]] | ||
| Line 32: | Line 31: | ||
|- | |- | ||
| [[XML-RPC Protocol Method: getcircle|getcircle]] | | [[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]] | | [[XML-RPC Protocol Method: getdaycounts|getdaycounts]] | ||
| Line 62: | Line 61: | ||
|- | |- | ||
| [[XML-RPC Protocol Method: sendmessage|sendmessage]] | | [[XML-RPC Protocol Method: sendmessage|sendmessage]] | ||
| − | | | + | | Send a private message to a user's inbox. |
|- | |- | ||
| [[XML-RPC Protocol Method: sessionexpire|sessionexpire]] | | [[XML-RPC Protocol Method: sessionexpire|sessionexpire]] | ||
| Line 79: | Line 78: | ||
== Deprecated Methods == | == Deprecated Methods == | ||
| − | + | {| border="1" | |
| − | + | |Deprecated method | |
| − | + | |Remarks | |
| − | + | |- | |
| + | |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: XML-RPC Protocol]] | [[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. |
