Difference between revisions of "XML-RPC Protocol"
From Dreamwidth Notes
(Spelling fix.) |
(Added LJ Server Manual's short descriptions.) |
||
| Line 10: | Line 10: | ||
* [[XML-RPC Protocol Method: addcomment|addcomment]] | * [[XML-RPC Protocol Method: addcomment|addcomment]] | ||
| − | * [[XML-RPC Protocol Method: consolecommand|consolecommand]] | + | * [[XML-RPC Protocol Method: consolecommand|consolecommand]] -- Run an administrative command. |
* [[XML-RPC Protocol Method: editcircle|editcircle]] | * [[XML-RPC Protocol Method: editcircle|editcircle]] | ||
| − | * [[XML-RPC Protocol Method: editevent|editevent]] | + | * [[XML-RPC Protocol Method: editevent|editevent]] -- Edit or delete a user's past journal entry. |
| − | * [[XML-RPC Protocol Method: friendof|friendof]] | + | * [[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: getchallenge|getchallenge]] | + | * [[XML-RPC Protocol Method: getchallenge|getchallenge]] -- Generate a server challenge string for authentication. |
* [[XML-RPC Protocol Method: getcircle|getcircle]] | * [[XML-RPC Protocol Method: getcircle|getcircle]] | ||
| − | * [[XML-RPC Protocol Method: getdaycounts|getdaycounts]] | + | * [[XML-RPC Protocol Method: getdaycounts|getdaycounts]] -- Retrieve the number of journal entries per day. |
| − | * [[XML-RPC Protocol Method: | + | * [[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: | + | * [[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: getfriendspage|getfriendspage]] | ||
* [[XML-RPC Protocol Method: getinbox|getinbox]] | * [[XML-RPC Protocol Method: getinbox|getinbox]] | ||
* [[XML-RPC Protocol Method: gettrustgroups|gettrustgroups]] | * [[XML-RPC Protocol Method: gettrustgroups|gettrustgroups]] | ||
| − | * [[XML-RPC Protocol Method: getusertags|getusertags]] | + | * [[XML-RPC Protocol Method: getusertags|getusertags]] -- Retrieve a list of the user's defined tags. |
| − | * [[XML-RPC Protocol Method: login|login]] | + | * [[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]] | + | * [[XML-RPC Protocol Method: postevent|postevent]] -- Submit a new journal entry to the server. |
* [[XML-RPC Protocol Method: sendmessage|sendmessage]] | * [[XML-RPC Protocol Method: sendmessage|sendmessage]] | ||
| − | * [[XML-RPC Protocol Method: sessionexpire|sessionexpire]] | + | * [[XML-RPC Protocol Method: sessionexpire|sessionexpire]] -- Expire session cookies. |
| − | * [[XML-RPC Protocol Method: sessiongenerate|sessiongenerate]] | + | * [[XML-RPC Protocol Method: sessiongenerate|sessiongenerate]] -- Generate a session cookie. |
* [[XML-RPC Protocol Method: setmessageread|setmessageread]] | * [[XML-RPC Protocol Method: setmessageread|setmessageread]] | ||
| − | * [[XML-RPC Protocol Method: syncitems|syncitems]] | + | * [[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 -- | + | * 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. |
| − | * editfriends -- | + | * editfriends -- Deprecated, use [[XML-RPC Protocol Method: editcircle|editcircle]] instead. |
| − | * editfriendgroups -- | + | * editfriendgroups -- Deprecated, use [[XML-RPC Protocol Method: editcircle|editcircle]] instead. |
| − | * getfriendgroups -- | + | * getfriendgroups -- Deprecated, use [[XML-RPC Protocol Method: gettrustgroups|gettrustgroups]] instead. |
[[Category: Development]] | [[Category: Development]] | ||
Revision as of 05:42, 19 September 2010
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...
Using XML-RPC
This would talk about how to use XML-RPC from various languages...
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.
- addcomment
- 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
- 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
- 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
- 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.
- editfriends -- Deprecated, use editcircle instead.
- editfriendgroups -- Deprecated, use editcircle instead.
- getfriendgroups -- Deprecated, use gettrustgroups instead.
