/usr/share/doc/flickcurl-doc/flickcurl-section-reflection.html is in flickcurl-doc 1.25-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Reflection</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-section-prefs.html" title="Preferences">
<link rel="next" href="flickcurl-section-serializer.html" title="Serializer">
<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-section-prefs.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-serializer.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-reflection.synopsis" class="shortcut">Top</a>
|
<a href="#flickcurl-section-reflection.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="flickcurl-section-reflection"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="flickcurl-section-reflection.top_of_page"></a>Reflection</span></h2>
<p>Reflection — Flickr introspection API.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="flickcurl-section-reflection.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="flickcurl-section-reflection.html#flickcurl-arg" title="flickcurl_arg">flickcurl_arg</a>;
<a class="link" href="flickcurl-section-reflection.html#flickcurl-method" title="flickcurl_method">flickcurl_method</a>;
<span class="returnvalue">void</span> <a class="link" href="flickcurl-section-reflection.html#flickcurl-free-method" title="flickcurl_free_method ()">flickcurl_free_method</a> (<em class="parameter"><code><a class="link" href="flickcurl-section-reflection.html#flickcurl-method" title="flickcurl_method"><span class="type">flickcurl_method</span></a> *method</code></em>);
<a class="link" href="flickcurl-section-reflection.html#flickcurl-method" title="flickcurl_method"><span class="returnvalue">flickcurl_method</span></a> * <a class="link" href="flickcurl-section-reflection.html#flickcurl-reflection-getMethodInfo" title="flickcurl_reflection_getMethodInfo ()">flickcurl_reflection_getMethodInfo</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> *name</code></em>);
<span class="returnvalue">char</span> ** <a class="link" href="flickcurl-section-reflection.html#flickcurl-reflection-getMethods" title="flickcurl_reflection_getMethods ()">flickcurl_reflection_getMethods</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>);
</pre>
</div>
<div class="refsect1">
<a name="flickcurl-section-reflection.description"></a><h2>Description</h2>
<p>
Flickr introspection API.
</p>
</div>
<div class="refsect1">
<a name="flickcurl-section-reflection.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="flickcurl-arg"></a><h3>flickcurl_arg</h3>
<pre class="programlisting">typedef struct {
char* name;
int optional;
char *description;
} flickcurl_arg;
</pre>
<p>
An API method argument.
</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-arg.name"></a>name</code></em>;</span></p></td>
<td>Argument name</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="flickcurl-arg.optional"></a>optional</code></em>;</span></p></td>
<td>boolean flag (non-0 true) if argument is optional</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">char</span> *<em class="structfield"><code><a name="flickcurl-arg.description"></a>description</code></em>;</span></p></td>
<td>description of argument (HTML)</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="flickcurl-method"></a><h3>flickcurl_method</h3>
<pre class="programlisting">typedef struct {
char *name;
int needslogin;
char *description;
char *response;
char *explanation;
/* argument list */
flickcurl_arg** args;
int args_count;
} flickcurl_method;
</pre>
<p>
An API method
</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-method.name"></a>name</code></em>;</span></p></td>
<td>Method name</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="flickcurl-method.needslogin"></a>needslogin</code></em>;</span></p></td>
<td>boolean flag (non-0 true) if method requires login</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">char</span> *<em class="structfield"><code><a name="flickcurl-method.description"></a>description</code></em>;</span></p></td>
<td>description of method</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">char</span> *<em class="structfield"><code><a name="flickcurl-method.response"></a>response</code></em>;</span></p></td>
<td>example response (HTML)</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">char</span> *<em class="structfield"><code><a name="flickcurl-method.explanation"></a>explanation</code></em>;</span></p></td>
<td>explanation of example response or NULL if missing</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="flickcurl-section-reflection.html#flickcurl-arg" title="flickcurl_arg"><span class="type">flickcurl_arg</span></a> **<em class="structfield"><code><a name="flickcurl-method.args"></a>args</code></em>;</span></p></td>
<td>method arguments</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="flickcurl-method.args-count"></a>args_count</code></em>;</span></p></td>
<td>number of arguments, may be 0</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="flickcurl-free-method"></a><h3>flickcurl_free_method ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> flickcurl_free_method (<em class="parameter"><code><a class="link" href="flickcurl-section-reflection.html#flickcurl-method" title="flickcurl_method"><span class="type">flickcurl_method</span></a> *method</code></em>);</pre>
<p>
Destructor for method object
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
<td>method object</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="flickcurl-reflection-getMethodInfo"></a><h3>flickcurl_reflection_getMethodInfo ()</h3>
<pre class="programlisting"><a class="link" href="flickcurl-section-reflection.html#flickcurl-method" title="flickcurl_method"><span class="returnvalue">flickcurl_method</span></a> * flickcurl_reflection_getMethodInfo (<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> *name</code></em>);</pre>
<p>
Get information about an API method
</p>
<p>
Implements flickr.reflection.getMethodInfo (0.10)
</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>name</code></em> :</span></p></td>
<td>method name</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a class="link" href="flickcurl-section-reflection.html#flickcurl-method" title="flickcurl_method"><span class="type">flickcurl_method</span></a> or NULL on failure</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="flickcurl-reflection-getMethods"></a><h3>flickcurl_reflection_getMethods ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> ** flickcurl_reflection_getMethods (<em class="parameter"><code><a class="link" href="flickcurl-section-core.html#flickcurl" title="flickcurl"><span class="type">flickcurl</span></a> *fc</code></em>);</pre>
<p>
Get the list of available API method names
</p>
<p>
Implements flickr.reflection.getMethods (0.10)
</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"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>arry of names or NULL on failure</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|