diff options
Diffstat (limited to 'actions')
| -rw-r--r-- | actions/apistatusesupdate.php | 91 | ||||
| -rw-r--r-- | actions/apitimelinefriends.php | 97 | ||||
| -rw-r--r-- | actions/apitimelinepublic.php | 89 | ||||
| -rw-r--r-- | actions/login.php | 10 |
4 files changed, 283 insertions, 4 deletions
diff --git a/actions/apistatusesupdate.php b/actions/apistatusesupdate.php index d4ef6b550..5f3a447c2 100644 --- a/actions/apistatusesupdate.php +++ b/actions/apistatusesupdate.php @@ -33,6 +33,97 @@ * @link http://status.net/ */ +/* External API usage documentation. Please update when you change how this method works. */ + +/*! @page statusesupdate statuses/update + + @section Description + Updates the authenticating user's status. Requires the status parameter specified below. + Request must be a POST. + + @par URL pattern + /api/statuses/update.:format + + @par Formats (:format) + xml, json + + @par HTTP Method(s) + POST + + @par Requires Authentication + Yes + + @param status (Required) The URL-encoded text of the status update. + @param source (Optional) The source of the status. + @param in_reply_to_status_id (Optional) The ID of an existing status that the update is in reply to. + @param lat (Optional) The latitude the status refers to. + @param long (Optional) The longitude the status refers to. + @param media (Optional) a media upload, such as an image or movie file. + + @sa @ref authentication + @sa @ref apiroot + + @subsection usagenotes Usage notes + + @li The URL pattern is relative to the @ref apiroot. + @li If the @e source parameter is not supplied the source of the status will default to 'api'. + @li The XML response uses <a href="http://georss.org/Main_Page">GeoRSS</a> + to encode the latitude and longitude (see example response below <georss:point>). + @li Data uploaded via the @e media parameter should be multipart/form-data encoded. + + @subsection exampleusage Example usage + + @verbatim + curl -u username:password http://example.com/api/statuses/update.xml -d status='Howdy!' -d lat='30.468' -d long='-94.743' + @endverbatim + + @subsection exampleresponse Example response + + @verbatim + <?xml version="1.0" encoding="UTF-8"?> + <status> + <text>Howdy!</text> + <truncated>false</truncated> + <created_at>Tue Mar 30 23:28:05 +0000 2010</created_at> + <in_reply_to_status_id/> + <source>api</source> + <id>26668724</id> + <in_reply_to_user_id/> + <in_reply_to_screen_name/> + <geo xmlns:georss="http://www.georss.org/georss"> + <georss:point>30.468 -94.743</georss:point> + </geo> + <favorited>false</favorited> + <user> + <id>25803</id> + <name>Jed Sanders</name> + <screen_name>jedsanders</screen_name> + <location>Hoop and Holler, Texas</location> + <description>I like to think of myself as America's Favorite.</description> + <profile_image_url>http://avatar.example.com/25803-48-20080924200604.png</profile_image_url> + <url>http://jedsanders.net</url> + <protected>false</protected> + <followers_count>5</followers_count> + <profile_background_color/> + <profile_text_color/> + <profile_link_color/> + <profile_sidebar_fill_color/> + <profile_sidebar_border_color/> + <friends_count>2</friends_count> + <created_at>Wed Sep 24 20:04:00 +0000 2008</created_at> + <favourites_count>0</favourites_count> + <utc_offset>0</utc_offset> + <time_zone>UTC</time_zone> + <profile_background_image_url/> + <profile_background_tile>false</profile_background_tile> + <statuses_count>70</statuses_count> + <following>true</following> + <notifications>true</notifications> + </user> + </status> + @endverbatim +*/ + if (!defined('STATUSNET')) { exit(1); } diff --git a/actions/apitimelinefriends.php b/actions/apitimelinefriends.php index 7f80f252e..3c25c049e 100644 --- a/actions/apitimelinefriends.php +++ b/actions/apitimelinefriends.php @@ -28,11 +28,106 @@ * @author Mike Cochrane <mikec@mikenz.geek.nz> * @author Robin Millette <robin@millette.info> * @author Zach Copley <zach@status.net> - * @copyright 2009 StatusNet, Inc. + * @copyright 2009-2010 StatusNet, Inc. * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0 * @link http://status.net/ */ +/* External API usage documentation. Please update when you change how this method works. */ + +/*! @page friendstimeline statuses/friends_timeline + + @section Description + Returns the 20 most recent statuses posted by the authenticating + user and that user's friends. This is the equivalent of "You and + friends" page in the web interface. + + @par URL patterns + @li /api/statuses/friends_timeline.:format + @li /api/statuses/friends_timeline/:id.:format + + @par Formats (:format) + xml, json, rss, atom + + @par ID (:id) + username, user id + + @par HTTP Method(s) + GET + + @par Requires Authentication + Sometimes (see: @ref authentication) + + @param user_id (Optional) Specifies a user by ID + @param screen_name (Optional) Specifies a user by screename (nickname) + @param since_id (Optional) Returns only statuses with an ID greater + than (that is, more recent than) the specified ID. + @param max_id (Optional) Returns only statuses with an ID less than + (that is, older than) or equal to the specified ID. + @param count (Optional) Specifies the number of statuses to retrieve. + @param page (Optional) Specifies the page of results to retrieve. + + @sa @ref authentication + @sa @ref apiroot + + @subsection usagenotes Usage notes + @li The URL pattern is relative to the @ref apiroot. + @li The XML response uses <a href="http://georss.org/Main_Page">GeoRSS</a> + to encode the latitude and longitude (see example response below <georss:point>). + + @subsection exampleusage Example usage + + @verbatim + curl http://identi.ca/api/statuses/friends_timeline/evan.xml?count=1&page=2 + @endverbatim + + @subsection exampleresponse Example response + + @verbatim + <?xml version="1.0"?> + <statuses type="array"> + <status> + <text>back from the !yul !drupal meet with Evolving Web folk, @anarcat, @webchick and others, and an interesting refresher on SQL indexing</text> + <truncated>false</truncated> + <created_at>Wed Mar 31 01:33:02 +0000 2010</created_at> + <in_reply_to_status_id/> + <source><a href="http://code.google.com/p/microblog-purple/">mbpidgin</a></source> + <id>26674201</id> + <in_reply_to_user_id/> + <in_reply_to_screen_name/> + <geo/> + <favorited>false</favorited> + <user> + <id>246</id> + <name>Mark</name> + <screen_name>lambic</screen_name> + <location>Montreal, Canada</location> + <description>Geek</description> + <profile_image_url>http://avatar.identi.ca/246-48-20080702141545.png</profile_image_url> + <url>http://lambic.co.uk</url> + <protected>false</protected> + <followers_count>73</followers_count> + <profile_background_color>#F0F2F5</profile_background_color> + <profile_text_color/> + <profile_link_color>#002E6E</profile_link_color> + <profile_sidebar_fill_color>#CEE1E9</profile_sidebar_fill_color> + <profile_sidebar_border_color/> + <friends_count>58</friends_count> + <created_at>Wed Jul 02 14:12:15 +0000 2008</created_at> + <favourites_count>2</favourites_count> + <utc_offset>-14400</utc_offset> + <time_zone>US/Eastern</time_zone> + <profile_background_image_url/> + <profile_background_tile>false</profile_background_tile> + <statuses_count>933</statuses_count> + <following>false</following> + <notifications>false</notifications> + </user> + </status> + </statuses> + @endverbatim +*/ + if (!defined('STATUSNET')) { exit(1); } diff --git a/actions/apitimelinepublic.php b/actions/apitimelinepublic.php index 903461425..30f9f4cda 100644 --- a/actions/apitimelinepublic.php +++ b/actions/apitimelinepublic.php @@ -55,6 +55,95 @@ require_once INSTALLDIR . '/lib/apiprivateauth.php'; * @link http://status.net/ */ +/* External API usage documentation. Please update when you change how this method works. */ + +/*! @page publictimeline statuses/public_timeline + + @section Description + Returns the 20 most recent notices from users throughout the system who have + uploaded their own avatars. Depending on configuration, it may or may not + not include notices from automatic posting services. + + @par URL patterns + @li /api/statuses/public_timeline.:format + + @par Formats (:format) + xml, json, rss, atom + + @par HTTP Method(s) + GET + + @par Requires Authentication + No + + @param since_id (Optional) Returns only statuses with an ID greater + than (that is, more recent than) the specified ID. + @param max_id (Optional) Returns only statuses with an ID less than + (that is, older than) or equal to the specified ID. + @param count (Optional) Specifies the number of statuses to retrieve. + @param page (Optional) Specifies the page of results to retrieve. + + @sa @ref apiroot + + @subsection usagenotes Usage notes + @li The URL pattern is relative to the @ref apiroot. + @li The XML response uses <a href="http://georss.org/Main_Page">GeoRSS</a> + to encode the latitude and longitude (see example response below <georss:point>). + + @subsection exampleusage Example usage + + @verbatim + curl http://identi.ca/api/statuses/friends_timeline/evan.xml?count=1&page=2 + @endverbatim + + @subsection exampleresponse Example response + + @verbatim + <?xml version="1.0" encoding="UTF-8"?> + <statuses type="array"> + <status> + <text>@skwashd oh, commbank reenabled me super quick both times. but disconcerting when you don't expect it though</text> + <truncated>false</truncated> + <created_at>Sat Apr 17 00:49:12 +0000 2010</created_at> + <in_reply_to_status_id>28838393</in_reply_to_status_id> + <source>xmpp</source> + <id>28838456</id> + <in_reply_to_user_id>39303</in_reply_to_user_id> + <in_reply_to_screen_name>skwashd</in_reply_to_screen_name> + <geo></geo> + <favorited>false</favorited> + <user> + <id>44517</id> + <name>joshua may</name> + <screen_name>notjosh</screen_name> + <location></location> + <description></description> + <profile_image_url>http://avatar.identi.ca/44517-48-20090321004106.jpeg</profile_image_url> + <url></url> + <protected>false</protected> + <followers_count>17</followers_count> + <profile_background_color></profile_background_color> + <profile_text_color></profile_text_color> + <profile_link_color></profile_link_color> + <profile_sidebar_fill_color></profile_sidebar_fill_color> + <profile_sidebar_border_color></profile_sidebar_border_color> + <friends_count>20</friends_count> + <created_at>Sat Mar 21 00:40:25 +0000 2009</created_at> + <favourites_count>0</favourites_count> + <utc_offset>0</utc_offset> + <time_zone>UTC</time_zone> + <profile_background_image_url></profile_background_image_url> + <profile_background_tile>false</profile_background_tile> + <statuses_count>100</statuses_count> + <following>false</following> + <notifications>false</notifications> + </user> + </status> + [....] + </statuses> +@endverbatim +*/ + class ApiTimelinePublicAction extends ApiPrivateAuthAction { diff --git a/actions/login.php b/actions/login.php index 8ea3c800b..dc6352368 100644 --- a/actions/login.php +++ b/actions/login.php @@ -267,9 +267,13 @@ class LoginAction extends Action 'user name and password ' . 'before changing your settings.'); } else { - return _('Login with your username and password. ' . - 'Don\'t have a username yet? ' . - '[Register](%%action.register%%) a new account.'); + $prompt = _('Login with your username and password.'); + if (!common_config('site', 'closed') && !common_config('site', 'inviteonly')) { + $prompt .= ' '; + $prompt .= _('Don\'t have a username yet? ' . + '[Register](%%action.register%%) a new account.'); + } + return $prompt; } } |