1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Activity</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Flickcurl Flickr API Manual">
<link rel="up" href="index.html" title="Flickcurl Flickr API Manual">
<link rel="prev" href="flickcurl-searching-search-example.html" title="Photos search example">
<link rel="next" href="flickcurl-section-auth.html" title="Authentication">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="flickcurl-searching-search-example.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td> </td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Flickcurl Flickr API Manual</th>
<td><a accesskey="n" href="flickcurl-section-auth.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#flickcurl-section-activity.synopsis" class="shortcut">Top</a>
|
<a href="#flickcurl-section-activity.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="flickcurl-section-activity"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="flickcurl-section-activity.top_of_page"></a>Activity</span></h2>
<p>Activity — Activity on notes and comments</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="flickcurl-section-activity.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="flickcurl-section-activity.html#flickcurl-activity" title="flickcurl_activity">flickcurl_activity</a>;
<a class="link" href="flickcurl-section-activity.html#flickcurl-activity-event" title="flickcurl_activity_event">flickcurl_activity_event</a>;
<a class="link" href="flickcurl-section-activity.html#flickcurl-activity" title="flickcurl_activity"><span class="returnvalue">flickcurl_activity</span></a> ** <a class="link" href="flickcurl-section-activity.html#flickcurl-activity-userComments" title="flickcurl_activity_userComments ()">flickcurl_activity_userComments</a> (<em class="parameter"><code><a class="link" href="flickcurl-section-core.html#flickcurl" title="flickcurl"><span class="type">flickcurl</span></a> *fc</code></em>,
<em class="parameter"><code><span class="type">int</span> per_page</code></em>,
<em class="parameter"><code><span class="type">int</span> page</code></em>);
<a class="link" href="flickcurl-section-activity.html#flickcurl-activity" title="flickcurl_activity"><span class="returnvalue">flickcurl_activity</span></a> ** <a class="link" href="flickcurl-section-activity.html#flickcurl-activity-userPhotos" title="flickcurl_activity_userPhotos ()">flickcurl_activity_userPhotos</a> (<em class="parameter"><code><a class="link" href="flickcurl-section-core.html#flickcurl" title="flickcurl"><span class="type">flickcurl</span></a> *fc</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *timeframe</code></em>,
<em class="parameter"><code><span class="type">int</span> per_page</code></em>,
<em class="parameter"><code><span class="type">int</span> page</code></em>);
<span class="returnvalue">void</span> <a class="link" href="flickcurl-section-activity.html#flickcurl-free-activities" title="flickcurl_free_activities ()">flickcurl_free_activities</a> (<em class="parameter"><code><a class="link" href="flickcurl-section-activity.html#flickcurl-activity" title="flickcurl_activity"><span class="type">flickcurl_activity</span></a> **activities_object</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="flickcurl-section-activity.description"></a><h2>Description</h2>
<p>
Activity on notes and comments
</p>
</div>
<div class="refsect1">
<a name="flickcurl-section-activity.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="flickcurl-activity"></a><h3>flickcurl_activity</h3>
<pre class="programlisting">typedef struct {
char *type; /* photoset or photo */
char *owner;
char *owner_name;
char *primary;
/* photo info: ID/secret/server/farm */
char *id;
char *secret;
int server;
int farm;
/* counts */
int comments_old;
int comments_new;
int notes_old;
int notes_new;
int views;
int comments;
int photos;
int faves;
/* flags */
int more;
char* title;
/* Array of events on this item */
flickcurl_activity_event* events[FLICKCURL_MAX_ACTIVITY_EVENTS+1];
} flickcurl_activity;
</pre>
<p>
Comments or photos item with activity
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><span class="type">char</span> *<em class="structfield"><code><a name="flickcurl-activity.type"></a>type</code></em>;</span></p></td>
<td>activity type photoset or photo</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">char</span> *<em class="structfield"><code><a name="flickcurl-activity.owner"></a>owner</code></em>;</span></p></td>
<td>owner NSID</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">char</span> *<em class="structfield"><code><a name="flickcurl-activity.owner-name"></a>owner_name</code></em>;</span></p></td>
<td>owner name</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">char</span> *<em class="structfield"><code><a name="flickcurl-activity.primary"></a>primary</code></em>;</span></p></td>
<td>primary</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">char</span> *<em class="structfield"><code><a name="flickcurl-activity.id"></a>id</code></em>;</span></p></td>
<td>photo id</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">char</span> *<em class="structfield"><code><a name="flickcurl-activity.secret"></a>secret</code></em>;</span></p></td>
<td>photo secret</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="flickcurl-activity.server"></a>server</code></em>;</span></p></td>
<td>photo server</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="flickcurl-activity.farm"></a>farm</code></em>;</span></p></td>
<td>photo farm</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="flickcurl-activity.comments-old"></a>comments_old</code></em>;</span></p></td>
<td>old comments count</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="flickcurl-activity.comments-new"></a>comments_new</code></em>;</span></p></td>
<td>new comments count</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="flickcurl-activity.notes-old"></a>notes_old</code></em>;</span></p></td>
<td>old notes count</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="flickcurl-activity.notes-new"></a>notes_new</code></em>;</span></p></td>
<td>new notes count</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="flickcurl-activity.views"></a>views</code></em>;</span></p></td>
<td>views count</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="flickcurl-activity.comments"></a>comments</code></em>;</span></p></td>
<td>comments count</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="flickcurl-activity.photos"></a>photos</code></em>;</span></p></td>
<td>photos count</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="flickcurl-activity.faves"></a>faves</code></em>;</span></p></td>
<td>favourites count</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="flickcurl-activity.more"></a>more</code></em>;</span></p></td>
<td>more boolean flag</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">char</span> *<em class="structfield"><code><a name="flickcurl-activity.title"></a>title</code></em>;</span></p></td>
<td>title of acitivty</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="flickcurl-section-activity.html#flickcurl-activity-event" title="flickcurl_activity_event"><span class="type">flickcurl_activity_event</span></a> *<em class="structfield"><code><a name="flickcurl-activity.events"></a>events</code></em>[FLICKCURL_MAX_ACTIVITY_EVENTS+1];</span></p></td>
<td>array of events associated with this actiivty</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="flickcurl-activity-event"></a><h3>flickcurl_activity_event</h3>
<pre class="programlisting">typedef struct {
char *type; /* comment or note */
char *id;
char *user;
char *username;
char *value;
int date_added;
} flickcurl_activity_event;
</pre>
<p>
Comment or photo activity event
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><span class="type">char</span> *<em class="structfield"><code><a name="flickcurl-activity-event.type"></a>type</code></em>;</span></p></td>
<td>activty event type</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">char</span> *<em class="structfield"><code><a name="flickcurl-activity-event.id"></a>id</code></em>;</span></p></td>
<td>ID</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">char</span> *<em class="structfield"><code><a name="flickcurl-activity-event.user"></a>user</code></em>;</span></p></td>
<td>user ID</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">char</span> *<em class="structfield"><code><a name="flickcurl-activity-event.username"></a>username</code></em>;</span></p></td>
<td>user name</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">char</span> *<em class="structfield"><code><a name="flickcurl-activity-event.value"></a>value</code></em>;</span></p></td>
<td>event value</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="flickcurl-activity-event.date-added"></a>date_added</code></em>;</span></p></td>
<td>date added</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="flickcurl-activity-userComments"></a><h3>flickcurl_activity_userComments ()</h3>
<pre class="programlisting"><a class="link" href="flickcurl-section-activity.html#flickcurl-activity" title="flickcurl_activity"><span class="returnvalue">flickcurl_activity</span></a> ** flickcurl_activity_userComments (<em class="parameter"><code><a class="link" href="flickcurl-section-core.html#flickcurl" title="flickcurl"><span class="type">flickcurl</span></a> *fc</code></em>,
<em class="parameter"><code><span class="type">int</span> per_page</code></em>,
<em class="parameter"><code><span class="type">int</span> page</code></em>);</pre>
<p>
Returns a list of recent activity on photos commented on by the calling user.
</p>
<p>
Implements flickr.activity.userComments (1.0)
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>fc</code></em> :</span></p></td>
<td>flickcurl context</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>per_page</code></em> :</span></p></td>
<td>Number of items to return per page. If this argument is omitted, it defaults to 10. The maximum allowed value is 50.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>page</code></em> :</span></p></td>
<td>The page of results to return. If this argument is omitted, it defaults to 1.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>non-0 on failure</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="flickcurl-activity-userPhotos"></a><h3>flickcurl_activity_userPhotos ()</h3>
<pre class="programlisting"><a class="link" href="flickcurl-section-activity.html#flickcurl-activity" title="flickcurl_activity"><span class="returnvalue">flickcurl_activity</span></a> ** flickcurl_activity_userPhotos (<em class="parameter"><code><a class="link" href="flickcurl-section-core.html#flickcurl" title="flickcurl"><span class="type">flickcurl</span></a> *fc</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *timeframe</code></em>,
<em class="parameter"><code><span class="type">int</span> per_page</code></em>,
<em class="parameter"><code><span class="type">int</span> page</code></em>);</pre>
<p>
Returns a list of recent activity on photos belonging to the calling user. Do not poll this method more than once an hour.
</p>
<p>
Implements flickr.activity.userPhotos (1.0)
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>fc</code></em> :</span></p></td>
<td>flickcurl context</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>timeframe</code></em> :</span></p></td>
<td>The timeframe in which to return updates for. This can be specified in days (<code class="code">'2d'</code>) or hours (<code class="code">'4h'</code>). The default behavoir is to return changes since the beginning of the previous user session. (or NULL)</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>per_page</code></em> :</span></p></td>
<td>Number of items to return per page. If this argument is omitted, it defaults to 10. The maximum allowed value is 50. (or NULL)</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>page</code></em> :</span></p></td>
<td>The page of results to return. If this argument is omitted, it defaults to 1. (or NULL)</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>non-0 on failure</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="flickcurl-free-activities"></a><h3>flickcurl_free_activities ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> flickcurl_free_activities (<em class="parameter"><code><a class="link" href="flickcurl-section-activity.html#flickcurl-activity" title="flickcurl_activity"><span class="type">flickcurl_activity</span></a> **activities_object</code></em>);</pre>
<p>
Destructor for array of activity objects
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>activities_object</code></em> :</span></p></td>
<td>activity object array</td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|