We are no longer offering accounts on this server. Consider https://gitlab.freedesktop.org/ as a place to host projects.

Commit f852a193 authored by Zach Copley's avatar Zach Copley

Add docs for public_timeline

parent f91e9928
......@@ -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)
@par Requires Authentication
@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
curl http://identi.ca/api/statuses/friends_timeline/evan.xml?count=1&page=2
@subsection exampleresponse Example response
<?xml version="1.0" encoding="UTF-8"?>
<statuses type="array">
<text>@skwashd oh, commbank reenabled me super quick both times. but disconcerting when you don't expect it though</text>
<created_at>Sat Apr 17 00:49:12 +0000 2010</created_at>
<name>joshua may</name>
<created_at>Sat Mar 21 00:40:25 +0000 2009</created_at>
class ApiTimelinePublicAction extends ApiPrivateAuthAction
......@@ -44,6 +44,7 @@
@subsection timelinesmethods_sec Timeline Methods
@li @ref publictimeline
@li @ref friendstimeline
@subsection statusmethods_sec Status Methods
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment