« back to all changes in this revision
Viewing changes to docs/html/flickcurl-section-auth.html
- browse files at revision 16
- compare with another revision
- download diff
- download tarball
- view history from revision 16
- Committer: Package Import Robot
- Author(s): Kumar Appaiah
- Date: 2013-05-20 21:15:09 UTC
- mfrom: (1.4.1) (15.1.1 experimental)
- Revision ID: package-import@ubuntu.com-20130520211509-e701o5dlwa04aqiw
Tags: 1.24-1
New upstream release
- files added:
- .pc
- files removed:
- utils/oauth-test.c
- files modified:
- ChangeLog
added
removed
docs/html/flickcurl-section-auth.html
37
37
</tr></table></div>
38
38
<div class="refsynopsisdiv">
39
39
<a name="flickcurl-section-auth.synopsis"></a><h2>Synopsis</h2>
40
<pre class="synopsis"><span class="returnvalue">char</span> * <a class="link" href="flickcurl-section-auth.html#flickcurl-auth-checkToken" title="flickcurl_auth_checkToken ()">flickcurl_auth_checkToken</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>,
40
<pre class="synopsis">const <span class="returnvalue">char</span> * <a class="link" href="flickcurl-section-auth.html#flickcurl-get-api-key" title="flickcurl_get_api_key ()">flickcurl_get_api_key</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>);
41
<span class="returnvalue">void</span> <a class="link" href="flickcurl-section-auth.html#flickcurl-set-api-key" title="flickcurl_set_api_key ()">flickcurl_set_api_key</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>,
42
<em class="parameter"><code>const <span class="type">char</span> *api_key</code></em>);
43
const <span class="returnvalue">char</span> * <a class="link" href="flickcurl-section-auth.html#flickcurl-get-shared-secret" title="flickcurl_get_shared_secret ()">flickcurl_get_shared_secret</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>);
44
<span class="returnvalue">void</span> <a class="link" href="flickcurl-section-auth.html#flickcurl-set-shared-secret" title="flickcurl_set_shared_secret ()">flickcurl_set_shared_secret</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>,
45
<em class="parameter"><code>const <span class="type">char</span> *secret</code></em>);
46
const <span class="returnvalue">char</span> * <a class="link" href="flickcurl-section-auth.html#flickcurl-get-auth-token" title="flickcurl_get_auth_token ()">flickcurl_get_auth_token</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>);
47
<span class="returnvalue">void</span> <a class="link" href="flickcurl-section-auth.html#flickcurl-set-auth-token" title="flickcurl_set_auth_token ()">flickcurl_set_auth_token</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>,
48
<em class="parameter"><code>const <span class="type">char</span> *auth_token</code></em>);
49
<span class="returnvalue">char</span> * <a class="link" href="flickcurl-section-auth.html#flickcurl-auth-checkToken" title="flickcurl_auth_checkToken ()">flickcurl_auth_checkToken</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>,
41
50
<em class="parameter"><code>const <span class="type">char</span> *token</code></em>);
42
51
<span class="returnvalue">char</span> * <a class="link" href="flickcurl-section-auth.html#flickcurl-auth-getFrob" title="flickcurl_auth_getFrob ()">flickcurl_auth_getFrob</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>);
43
52
<span class="returnvalue">char</span> * <a class="link" href="flickcurl-section-auth.html#flickcurl-auth-getFullToken" title="flickcurl_auth_getFullToken ()">flickcurl_auth_getFullToken</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>,
45
54
<span class="returnvalue">char</span> * <a class="link" href="flickcurl-section-auth.html#flickcurl-auth-getToken" title="flickcurl_auth_getToken ()">flickcurl_auth_getToken</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>,
46
55
<em class="parameter"><code>const <span class="type">char</span> *frob</code></em>);
47
56
<span class="returnvalue">int</span> <a class="link" href="flickcurl-section-auth.html#flickcurl-auth-oauth-getAccessToken" title="flickcurl_auth_oauth_getAccessToken ()">flickcurl_auth_oauth_getAccessToken</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>);
57
extern const char* const <a class="link" href="flickcurl-section-auth.html#flickcurl-flickr-oauth-access-token-uri" title="flickcurl_flickr_oauth_access_token_uri">flickcurl_flickr_oauth_access_token_uri</a>;
58
extern const char* const <a class="link" href="flickcurl-section-auth.html#flickcurl-flickr-oauth-authorize-uri" title="flickcurl_flickr_oauth_authorize_uri">flickcurl_flickr_oauth_authorize_uri</a>;
59
extern const char* const <a class="link" href="flickcurl-section-auth.html#flickcurl-flickr-oauth-request-token-uri" title="flickcurl_flickr_oauth_request_token_uri">flickcurl_flickr_oauth_request_token_uri</a>;
60
const <span class="returnvalue">char</span> * <a class="link" href="flickcurl-section-auth.html#flickcurl-get-oauth-client-key" title="flickcurl_get_oauth_client_key ()">flickcurl_get_oauth_client_key</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>);
61
<span class="returnvalue">void</span> <a class="link" href="flickcurl-section-auth.html#flickcurl-set-oauth-client-key" title="flickcurl_set_oauth_client_key ()">flickcurl_set_oauth_client_key</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>,
62
<em class="parameter"><code>const <span class="type">char</span> *client_key</code></em>);
63
const <span class="returnvalue">char</span> * <a class="link" href="flickcurl-section-auth.html#flickcurl-get-oauth-client-secret" title="flickcurl_get_oauth_client_secret ()">flickcurl_get_oauth_client_secret</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>);
64
<span class="returnvalue">void</span> <a class="link" href="flickcurl-section-auth.html#flickcurl-set-oauth-client-secret" title="flickcurl_set_oauth_client_secret ()">flickcurl_set_oauth_client_secret</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>,
65
<em class="parameter"><code>const <span class="type">char</span> *client_secret</code></em>);
66
const <span class="returnvalue">char</span> * <a class="link" href="flickcurl-section-auth.html#flickcurl-get-oauth-request-token" title="flickcurl_get_oauth_request_token ()">flickcurl_get_oauth_request_token</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>);
67
<span class="returnvalue">void</span> <a class="link" href="flickcurl-section-auth.html#flickcurl-set-oauth-request-token" title="flickcurl_set_oauth_request_token ()">flickcurl_set_oauth_request_token</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>,
68
<em class="parameter"><code>const <span class="type">char</span> *token</code></em>);
69
const <span class="returnvalue">char</span> * <a class="link" href="flickcurl-section-auth.html#flickcurl-get-oauth-request-token-secret" title="flickcurl_get_oauth_request_token_secret ()">flickcurl_get_oauth_request_token_secret</a>
70
(<em class="parameter"><code><a class="link" href="flickcurl-section-core.html#flickcurl" title="flickcurl"><span class="type">flickcurl</span></a> *fc</code></em>);
71
<span class="returnvalue">void</span> <a class="link" href="flickcurl-section-auth.html#flickcurl-set-oauth-request-token-secret" title="flickcurl_set_oauth_request_token_secret ()">flickcurl_set_oauth_request_token_secret</a>
72
(<em class="parameter"><code><a class="link" href="flickcurl-section-core.html#flickcurl" title="flickcurl"><span class="type">flickcurl</span></a> *fc</code></em>,
73
<em class="parameter"><code>const <span class="type">char</span> *secret</code></em>);
74
const <span class="returnvalue">char</span> * <a class="link" href="flickcurl-section-auth.html#flickcurl-get-oauth-token" title="flickcurl_get_oauth_token ()">flickcurl_get_oauth_token</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>);
75
<span class="returnvalue">void</span> <a class="link" href="flickcurl-section-auth.html#flickcurl-set-oauth-token" title="flickcurl_set_oauth_token ()">flickcurl_set_oauth_token</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>,
76
<em class="parameter"><code>const <span class="type">char</span> *token</code></em>);
77
const <span class="returnvalue">char</span> * <a class="link" href="flickcurl-section-auth.html#flickcurl-get-oauth-token-secret" title="flickcurl_get_oauth_token_secret ()">flickcurl_get_oauth_token_secret</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>);
78
<span class="returnvalue">void</span> <a class="link" href="flickcurl-section-auth.html#flickcurl-set-oauth-token-secret" title="flickcurl_set_oauth_token_secret ()">flickcurl_set_oauth_token_secret</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>,
79
<em class="parameter"><code>const <span class="type">char</span> *secret</code></em>);
80
const <span class="returnvalue">char</span> * <a class="link" href="flickcurl-section-auth.html#flickcurl-get-oauth-username" title="flickcurl_get_oauth_username ()">flickcurl_get_oauth_username</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>);
81
const <span class="returnvalue">char</span> * <a class="link" href="flickcurl-section-auth.html#flickcurl-get-oauth-user-nsid" title="flickcurl_get_oauth_user_nsid ()">flickcurl_get_oauth_user_nsid</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>);
82
<span class="returnvalue">int</span> <a class="link" href="flickcurl-section-auth.html#flickcurl-oauth-create-request-token" title="flickcurl_oauth_create_request_token ()">flickcurl_oauth_create_request_token</a>
83
(<em class="parameter"><code><a class="link" href="flickcurl-section-core.html#flickcurl" title="flickcurl"><span class="type">flickcurl</span></a> *fc</code></em>,
84
<em class="parameter"><code>const <span class="type">char</span> *callback</code></em>);
85
<span class="returnvalue">char</span> * <a class="link" href="flickcurl-section-auth.html#flickcurl-oauth-get-authorize-uri" title="flickcurl_oauth_get_authorize_uri ()">flickcurl_oauth_get_authorize_uri</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>);
86
<span class="returnvalue">int</span> <a class="link" href="flickcurl-section-auth.html#flickcurl-oauth-create-access-token" title="flickcurl_oauth_create_access_token ()">flickcurl_oauth_create_access_token</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>,
87
<em class="parameter"><code>const <span class="type">char</span> *verifier</code></em>);
48
88
</pre>
49
89
</div>
50
90
<div class="refsect1">
56
96
<div class="refsect1">
57
97
<a name="flickcurl-section-auth.details"></a><h2>Details</h2>
58
98
<div class="refsect2">
99
<a name="flickcurl-get-api-key"></a><h3>flickcurl_get_api_key ()</h3>
100
<pre class="programlisting">const <span class="returnvalue">char</span> * flickcurl_get_api_key (<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>
101
<p>
102
Get current application API Key (OAuth Client key)
103
</p>
104
<div class="variablelist"><table border="0">
105
<col align="left" valign="top">
106
<tbody>
107
<tr>
108
<td><p><span class="term"><em class="parameter"><code>fc</code></em> :</span></p></td>
109
<td>flickcurl object</td>
110
</tr>
111
<tr>
112
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
113
<td>API key or NULL if none set</td>
114
</tr>
115
</tbody>
116
</table></div>
117
</div>
118
<hr>
119
<div class="refsect2">
120
<a name="flickcurl-set-api-key"></a><h3>flickcurl_set_api_key ()</h3>
121
<pre class="programlisting"><span class="returnvalue">void</span> flickcurl_set_api_key (<em class="parameter"><code><a class="link" href="flickcurl-section-core.html#flickcurl" title="flickcurl"><span class="type">flickcurl</span></a> *fc</code></em>,
122
<em class="parameter"><code>const <span class="type">char</span> *api_key</code></em>);</pre>
123
<p>
124
Set legacy Flickr auth application API Key (OAuth Client key)
125
</p>
126
<p>
127
For OAuth this is not sufficient and
128
<a class="link" href="flickcurl-section-auth.html#flickcurl-set-oauth-client-key" title="flickcurl_set_oauth_client_key ()"><code class="function">flickcurl_set_oauth_client_key()</code></a> and
129
<a class="link" href="flickcurl-section-auth.html#flickcurl-set-oauth-client-secret" title="flickcurl_set_oauth_client_secret ()"><code class="function">flickcurl_set_oauth_client_secret()</code></a> be used
130
to pass both the client key and client secret.
131
</p>
132
<div class="variablelist"><table border="0">
133
<col align="left" valign="top">
134
<tbody>
135
<tr>
136
<td><p><span class="term"><em class="parameter"><code>fc</code></em> :</span></p></td>
137
<td>flickcurl object</td>
138
</tr>
139
<tr>
140
<td><p><span class="term"><em class="parameter"><code>api_key</code></em> :</span></p></td>
141
<td>API Key</td>
142
</tr>
143
</tbody>
144
</table></div>
145
</div>
146
<hr>
147
<div class="refsect2">
148
<a name="flickcurl-get-shared-secret"></a><h3>flickcurl_get_shared_secret ()</h3>
149
<pre class="programlisting">const <span class="returnvalue">char</span> * flickcurl_get_shared_secret (<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>
150
<p>
151
Get legacy Flickr auth Secret
152
</p>
153
<div class="variablelist"><table border="0">
154
<col align="left" valign="top">
155
<tbody>
156
<tr>
157
<td><p><span class="term"><em class="parameter"><code>fc</code></em> :</span></p></td>
158
<td>flickcurl object</td>
159
</tr>
160
<tr>
161
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
162
<td>shared secret or NULL if none set</td>
163
</tr>
164
</tbody>
165
</table></div>
166
</div>
167
<hr>
168
<div class="refsect2">
169
<a name="flickcurl-set-shared-secret"></a><h3>flickcurl_set_shared_secret ()</h3>
170
<pre class="programlisting"><span class="returnvalue">void</span> flickcurl_set_shared_secret (<em class="parameter"><code><a class="link" href="flickcurl-section-core.html#flickcurl" title="flickcurl"><span class="type">flickcurl</span></a> *fc</code></em>,
171
<em class="parameter"><code>const <span class="type">char</span> *secret</code></em>);</pre>
172
<p>
173
Set legacy Flickr auth secret
174
</p>
175
<div class="variablelist"><table border="0">
176
<col align="left" valign="top">
177
<tbody>
178
<tr>
179
<td><p><span class="term"><em class="parameter"><code>fc</code></em> :</span></p></td>
180
<td>flickcurl object</td>
181
</tr>
182
<tr>
183
<td><p><span class="term"><em class="parameter"><code>secret</code></em> :</span></p></td>
184
<td>shared secret</td>
185
</tr>
186
</tbody>
187
</table></div>
188
</div>
189
<hr>
190
<div class="refsect2">
191
<a name="flickcurl-get-auth-token"></a><h3>flickcurl_get_auth_token ()</h3>
192
<pre class="programlisting">const <span class="returnvalue">char</span> * flickcurl_get_auth_token (<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>
193
<p>
194
Get legacy Flickr auth Token
195
</p>
196
<div class="variablelist"><table border="0">
197
<col align="left" valign="top">
198
<tbody>
199
<tr>
200
<td><p><span class="term"><em class="parameter"><code>fc</code></em> :</span></p></td>
201
<td>flickcurl object</td>
202
</tr>
203
<tr>
204
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
205
<td>auth token or NULL if none set</td>
206
</tr>
207
</tbody>
208
</table></div>
209
</div>
210
<hr>
211
<div class="refsect2">
212
<a name="flickcurl-set-auth-token"></a><h3>flickcurl_set_auth_token ()</h3>
213
<pre class="programlisting"><span class="returnvalue">void</span> flickcurl_set_auth_token (<em class="parameter"><code><a class="link" href="flickcurl-section-core.html#flickcurl" title="flickcurl"><span class="type">flickcurl</span></a> *fc</code></em>,
214
<em class="parameter"><code>const <span class="type">char</span> *auth_token</code></em>);</pre>
215
<p>
216
Set legacy Flickr auth Token
217
</p>
218
<div class="variablelist"><table border="0">
219
<col align="left" valign="top">
220
<tbody>
221
<tr>
222
<td><p><span class="term"><em class="parameter"><code>fc</code></em> :</span></p></td>
223
<td>flickcurl object</td>
224
</tr>
225
<tr>
226
<td><p><span class="term"><em class="parameter"><code>auth_token</code></em> :</span></p></td>
227
<td>auth token</td>
228
</tr>
229
</tbody>
230
</table></div>
231
</div>
232
<hr>
233
<div class="refsect2">
59
234
<a name="flickcurl-auth-checkToken"></a><h3>flickcurl_auth_checkToken ()</h3>
60
235
<pre class="programlisting"><span class="returnvalue">char</span> * flickcurl_auth_checkToken (<em class="parameter"><code><a class="link" href="flickcurl-section-core.html#flickcurl" title="flickcurl"><span class="type">flickcurl</span></a> *fc</code></em>,
61
236
<em class="parameter"><code>const <span class="type">char</span> *token</code></em>);</pre>
177
352
<a name="flickcurl-auth-oauth-getAccessToken"></a><h3>flickcurl_auth_oauth_getAccessToken ()</h3>
178
353
<pre class="programlisting"><span class="returnvalue">int</span> flickcurl_auth_oauth_getAccessToken (<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>
179
354
<p>
180
Exchange an auth token from the old Authentication API for an OAuth access token.
181
</p>
182
<p>
183
Calling this method will delete the old auth token used to make the request.
184
</p>
185
<p>
186
Implements flickr.auth.oauth.getAccessToken (1.22)
355
Exchange tokens from the legacy Flickr auth to ones for OAuth
356
</p>
357
<p>
358
Calling this method will delete the legacy auth tokens used to
359
make the request since they will expire within 24 hours of this
360
call.
361
</p>
362
<p>
363
The OAuth token and secret should be saved and can be read from
364
<a class="link" href="flickcurl-section-auth.html#flickcurl-get-oauth-token" title="flickcurl_get_oauth_token ()"><code class="function">flickcurl_get_oauth_token()</code></a> and <a class="link" href="flickcurl-section-auth.html#flickcurl-get-oauth-token-secret" title="flickcurl_get_oauth_token_secret ()"><code class="function">flickcurl_get_oauth_token_secret()</code></a>
365
</p>
366
<p>
367
Implements flickr.auth.oauth.getAccessToken (1.23)
187
368
</p>
188
369
<div class="variablelist"><table border="0">
189
370
<col align="left" valign="top">
199
380
</tbody>
200
381
</table></div>
201
382
</div>
383
<hr>
384
<div class="refsect2">
385
<a name="flickcurl-flickr-oauth-access-token-uri"></a><h3>flickcurl_flickr_oauth_access_token_uri</h3>
386
<pre class="programlisting">extern const char* const flickcurl_flickr_oauth_access_token_uri;
387
</pre>
388
<p>
389
</p>
390
</div>
391
<hr>
392
<div class="refsect2">
393
<a name="flickcurl-flickr-oauth-authorize-uri"></a><h3>flickcurl_flickr_oauth_authorize_uri</h3>
394
<pre class="programlisting">extern const char* const flickcurl_flickr_oauth_authorize_uri;
395
</pre>
396
<p>
397
</p>
398
</div>
399
<hr>
400
<div class="refsect2">
401
<a name="flickcurl-flickr-oauth-request-token-uri"></a><h3>flickcurl_flickr_oauth_request_token_uri</h3>
402
<pre class="programlisting">extern const char* const flickcurl_flickr_oauth_request_token_uri;
403
</pre>
404
<p>
405
</p>
406
</div>
407
<hr>
408
<div class="refsect2">
409
<a name="flickcurl-get-oauth-client-key"></a><h3>flickcurl_get_oauth_client_key ()</h3>
410
<pre class="programlisting">const <span class="returnvalue">char</span> * flickcurl_get_oauth_client_key (<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>
411
<p>
412
Get OAuth Client Key (aka Consumer key, API Key)
413
</p>
414
<p>
415
See also <a class="link" href="flickcurl-section-auth.html#flickcurl-get-oauth-client-secret" title="flickcurl_get_oauth_client_secret ()"><code class="function">flickcurl_get_oauth_client_secret()</code></a>
416
</p>
417
<div class="variablelist"><table border="0">
418
<col align="left" valign="top">
419
<tbody>
420
<tr>
421
<td><p><span class="term"><em class="parameter"><code>fc</code></em> :</span></p></td>
422
<td>flickcurl object</td>
423
</tr>
424
<tr>
425
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
426
<td>client key or NULL if none set</td>
427
</tr>
428
</tbody>
429
</table></div>
430
</div>
431
<hr>
432
<div class="refsect2">
433
<a name="flickcurl-set-oauth-client-key"></a><h3>flickcurl_set_oauth_client_key ()</h3>
434
<pre class="programlisting"><span class="returnvalue">void</span> flickcurl_set_oauth_client_key (<em class="parameter"><code><a class="link" href="flickcurl-section-core.html#flickcurl" title="flickcurl"><span class="type">flickcurl</span></a> *fc</code></em>,
435
<em class="parameter"><code>const <span class="type">char</span> *client_key</code></em>);</pre>
436
<p>
437
Set OAuth client key (aka API key)
438
</p>
439
<p>
440
See also <a class="link" href="flickcurl-section-auth.html#flickcurl-get-oauth-client-key" title="flickcurl_get_oauth_client_key ()"><code class="function">flickcurl_get_oauth_client_key()</code></a>
441
</p>
442
<div class="variablelist"><table border="0">
443
<col align="left" valign="top">
444
<tbody>
445
<tr>
446
<td><p><span class="term"><em class="parameter"><code>fc</code></em> :</span></p></td>
447
<td>flickcurl object</td>
448
</tr>
449
<tr>
450
<td><p><span class="term"><em class="parameter"><code>client_key</code></em> :</span></p></td>
451
<td>client key (API key)</td>
452
</tr>
453
</tbody>
454
</table></div>
455
</div>
456
<hr>
457
<div class="refsect2">
458
<a name="flickcurl-get-oauth-client-secret"></a><h3>flickcurl_get_oauth_client_secret ()</h3>
459
<pre class="programlisting">const <span class="returnvalue">char</span> * flickcurl_get_oauth_client_secret (<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>
460
<p>
461
Get OAuth Client secret
462
</p>
463
<p>
464
See also <a class="link" href="flickcurl-section-auth.html#flickcurl-get-oauth-client-key" title="flickcurl_get_oauth_client_key ()"><code class="function">flickcurl_get_oauth_client_key()</code></a>
465
</p>
466
<div class="variablelist"><table border="0">
467
<col align="left" valign="top">
468
<tbody>
469
<tr>
470
<td><p><span class="term"><em class="parameter"><code>fc</code></em> :</span></p></td>
471
<td>flickcurl object</td>
472
</tr>
473
<tr>
474
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
475
<td>client secret or NULL if none set</td>
476
</tr>
477
</tbody>
478
</table></div>
479
</div>
480
<hr>
481
<div class="refsect2">
482
<a name="flickcurl-set-oauth-client-secret"></a><h3>flickcurl_set_oauth_client_secret ()</h3>
483
<pre class="programlisting"><span class="returnvalue">void</span> flickcurl_set_oauth_client_secret (<em class="parameter"><code><a class="link" href="flickcurl-section-core.html#flickcurl" title="flickcurl"><span class="type">flickcurl</span></a> *fc</code></em>,
484
<em class="parameter"><code>const <span class="type">char</span> *client_secret</code></em>);</pre>
485
<p>
486
Set OAuth client key (aka shared secret)
487
</p>
488
<p>
489
See also <a class="link" href="flickcurl-section-auth.html#flickcurl-set-oauth-client-secret" title="flickcurl_set_oauth_client_secret ()"><code class="function">flickcurl_set_oauth_client_secret()</code></a>
490
</p>
491
<div class="variablelist"><table border="0">
492
<col align="left" valign="top">
493
<tbody>
494
<tr>
495
<td><p><span class="term"><em class="parameter"><code>fc</code></em> :</span></p></td>
496
<td>flickcurl object</td>
497
</tr>
498
<tr>
499
<td><p><span class="term"><em class="parameter"><code>client_secret</code></em> :</span></p></td>
500
<td>client key (shared key)</td>
501
</tr>
502
</tbody>
503
</table></div>
504
</div>
505
<hr>
506
<div class="refsect2">
507
<a name="flickcurl-get-oauth-request-token"></a><h3>flickcurl_get_oauth_request_token ()</h3>
508
<pre class="programlisting">const <span class="returnvalue">char</span> * flickcurl_get_oauth_request_token (<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>
509
<p>
510
Get OAuth request token
511
</p>
512
<div class="variablelist"><table border="0">
513
<col align="left" valign="top">
514
<tbody>
515
<tr>
516
<td><p><span class="term"><em class="parameter"><code>fc</code></em> :</span></p></td>
517
<td>flickcurl object</td>
518
</tr>
519
<tr>
520
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
521
<td>request token or NULL if none set</td>
522
</tr>
523
</tbody>
524
</table></div>
525
</div>
526
<hr>
527
<div class="refsect2">
528
<a name="flickcurl-set-oauth-request-token"></a><h3>flickcurl_set_oauth_request_token ()</h3>
529
<pre class="programlisting"><span class="returnvalue">void</span> flickcurl_set_oauth_request_token (<em class="parameter"><code><a class="link" href="flickcurl-section-core.html#flickcurl" title="flickcurl"><span class="type">flickcurl</span></a> *fc</code></em>,
530
<em class="parameter"><code>const <span class="type">char</span> *token</code></em>);</pre>
531
<p>
532
Set OAuth request token
533
</p>
534
<p>
535
See also <a class="link" href="flickcurl-section-auth.html#flickcurl-get-oauth-request-token" title="flickcurl_get_oauth_request_token ()"><code class="function">flickcurl_get_oauth_request_token()</code></a>
536
</p>
537
<div class="variablelist"><table border="0">
538
<col align="left" valign="top">
539
<tbody>
540
<tr>
541
<td><p><span class="term"><em class="parameter"><code>fc</code></em> :</span></p></td>
542
<td>flickcurl object</td>
543
</tr>
544
<tr>
545
<td><p><span class="term"><em class="parameter"><code>token</code></em> :</span></p></td>
546
<td>request token</td>
547
</tr>
548
</tbody>
549
</table></div>
550
</div>
551
<hr>
552
<div class="refsect2">
553
<a name="flickcurl-get-oauth-request-token-secret"></a><h3>flickcurl_get_oauth_request_token_secret ()</h3>
554
<pre class="programlisting">const <span class="returnvalue">char</span> * flickcurl_get_oauth_request_token_secret
555
(<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>
556
<p>
557
Get OAuth request token secret
558
</p>
559
<div class="variablelist"><table border="0">
560
<col align="left" valign="top">
561
<tbody>
562
<tr>
563
<td><p><span class="term"><em class="parameter"><code>fc</code></em> :</span></p></td>
564
<td>flickcurl object</td>
565
</tr>
566
<tr>
567
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
568
<td>request token secret or NULL if none set</td>
569
</tr>
570
</tbody>
571
</table></div>
572
</div>
573
<hr>
574
<div class="refsect2">
575
<a name="flickcurl-set-oauth-request-token-secret"></a><h3>flickcurl_set_oauth_request_token_secret ()</h3>
576
<pre class="programlisting"><span class="returnvalue">void</span> flickcurl_set_oauth_request_token_secret
577
(<em class="parameter"><code><a class="link" href="flickcurl-section-core.html#flickcurl" title="flickcurl"><span class="type">flickcurl</span></a> *fc</code></em>,
578
<em class="parameter"><code>const <span class="type">char</span> *secret</code></em>);</pre>
579
<p>
580
Set OAuth request token secret credentials
581
</p>
582
<p>
583
See also <a class="link" href="flickcurl-section-auth.html#flickcurl-get-oauth-request-token-secret" title="flickcurl_get_oauth_request_token_secret ()"><code class="function">flickcurl_get_oauth_request_token_secret()</code></a>
584
</p>
585
<div class="variablelist"><table border="0">
586
<col align="left" valign="top">
587
<tbody>
588
<tr>
589
<td><p><span class="term"><em class="parameter"><code>fc</code></em> :</span></p></td>
590
<td>flickcurl object</td>
591
</tr>
592
<tr>
593
<td><p><span class="term"><em class="parameter"><code>secret</code></em> :</span></p></td>
594
<td>request token secret</td>
595
</tr>
596
</tbody>
597
</table></div>
598
</div>
599
<hr>
600
<div class="refsect2">
601
<a name="flickcurl-get-oauth-token"></a><h3>flickcurl_get_oauth_token ()</h3>
602
<pre class="programlisting">const <span class="returnvalue">char</span> * flickcurl_get_oauth_token (<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>
603
<p>
604
Get OAuth Token
605
</p>
606
<div class="variablelist"><table border="0">
607
<col align="left" valign="top">
608
<tbody>
609
<tr>
610
<td><p><span class="term"><em class="parameter"><code>fc</code></em> :</span></p></td>
611
<td>flickcurl object</td>
612
</tr>
613
<tr>
614
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
615
<td>auth token or NULL if none set</td>
616
</tr>
617
</tbody>
618
</table></div>
619
</div>
620
<hr>
621
<div class="refsect2">
622
<a name="flickcurl-set-oauth-token"></a><h3>flickcurl_set_oauth_token ()</h3>
623
<pre class="programlisting"><span class="returnvalue">void</span> flickcurl_set_oauth_token (<em class="parameter"><code><a class="link" href="flickcurl-section-core.html#flickcurl" title="flickcurl"><span class="type">flickcurl</span></a> *fc</code></em>,
624
<em class="parameter"><code>const <span class="type">char</span> *token</code></em>);</pre>
625
<p>
626
Set OAuth Token
627
</p>
628
<div class="variablelist"><table border="0">
629
<col align="left" valign="top">
630
<tbody>
631
<tr>
632
<td><p><span class="term"><em class="parameter"><code>fc</code></em> :</span></p></td>
633
<td>flickcurl object</td>
634
</tr>
635
<tr>
636
<td><p><span class="term"><em class="parameter"><code>token</code></em> :</span></p></td>
637
<td>auth token</td>
638
</tr>
639
</tbody>
640
</table></div>
641
</div>
642
<hr>
643
<div class="refsect2">
644
<a name="flickcurl-get-oauth-token-secret"></a><h3>flickcurl_get_oauth_token_secret ()</h3>
645
<pre class="programlisting">const <span class="returnvalue">char</span> * flickcurl_get_oauth_token_secret (<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>
646
<p>
647
Get OAuth token secret
648
</p>
649
<div class="variablelist"><table border="0">
650
<col align="left" valign="top">
651
<tbody>
652
<tr>
653
<td><p><span class="term"><em class="parameter"><code>fc</code></em> :</span></p></td>
654
<td>flickcurl object</td>
655
</tr>
656
<tr>
657
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
658
<td>secret or NULL if none set</td>
659
</tr>
660
</tbody>
661
</table></div>
662
</div>
663
<hr>
664
<div class="refsect2">
665
<a name="flickcurl-set-oauth-token-secret"></a><h3>flickcurl_set_oauth_token_secret ()</h3>
666
<pre class="programlisting"><span class="returnvalue">void</span> flickcurl_set_oauth_token_secret (<em class="parameter"><code><a class="link" href="flickcurl-section-core.html#flickcurl" title="flickcurl"><span class="type">flickcurl</span></a> *fc</code></em>,
667
<em class="parameter"><code>const <span class="type">char</span> *secret</code></em>);</pre>
668
<p>
669
Set OAuth token Secret
670
</p>
671
<div class="variablelist"><table border="0">
672
<col align="left" valign="top">
673
<tbody>
674
<tr>
675
<td><p><span class="term"><em class="parameter"><code>fc</code></em> :</span></p></td>
676
<td>flickcurl object</td>
677
</tr>
678
<tr>
679
<td><p><span class="term"><em class="parameter"><code>secret</code></em> :</span></p></td>
680
<td>shared secret</td>
681
</tr>
682
</tbody>
683
</table></div>
684
</div>
685
<hr>
686
<div class="refsect2">
687
<a name="flickcurl-get-oauth-username"></a><h3>flickcurl_get_oauth_username ()</h3>
688
<pre class="programlisting">const <span class="returnvalue">char</span> * flickcurl_get_oauth_username (<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>
689
<p>
690
Get the username for the authenticated user
691
</p>
692
<div class="variablelist"><table border="0">
693
<col align="left" valign="top">
694
<tbody>
695
<tr>
696
<td><p><span class="term"><em class="parameter"><code>fc</code></em> :</span></p></td>
697
<td>flickcurl object</td>
698
</tr>
699
<tr>
700
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
701
<td>username or NULL if none set</td>
702
</tr>
703
</tbody>
704
</table></div>
705
</div>
706
<hr>
707
<div class="refsect2">
708
<a name="flickcurl-get-oauth-user-nsid"></a><h3>flickcurl_get_oauth_user_nsid ()</h3>
709
<pre class="programlisting">const <span class="returnvalue">char</span> * flickcurl_get_oauth_user_nsid (<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>
710
<p>
711
Get the user_nsid for the authenticated user
712
</p>
713
<div class="variablelist"><table border="0">
714
<col align="left" valign="top">
715
<tbody>
716
<tr>
717
<td><p><span class="term"><em class="parameter"><code>fc</code></em> :</span></p></td>
718
<td>flickcurl object</td>
719
</tr>
720
<tr>
721
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
722
<td>user_nsid or NULL if none set</td>
723
</tr>
724
</tbody>
725
</table></div>
726
</div>
727
<hr>
728
<div class="refsect2">
729
<a name="flickcurl-oauth-create-request-token"></a><h3>flickcurl_oauth_create_request_token ()</h3>
730
<pre class="programlisting"><span class="returnvalue">int</span> flickcurl_oauth_create_request_token
731
(<em class="parameter"><code><a class="link" href="flickcurl-section-core.html#flickcurl" title="flickcurl"><span class="type">flickcurl</span></a> *fc</code></em>,
732
<em class="parameter"><code>const <span class="type">char</span> *callback</code></em>);</pre>
733
<p>
734
Request an OAuth request token from Flickr for the application API Key/secret
735
</p>
736
<p>
737
Requires the OAuth Client key (API key) and Client secret to have
738
been set with <a class="link" href="flickcurl-section-auth.html#flickcurl-set-oauth-client-key" title="flickcurl_set_oauth_client_key ()"><code class="function">flickcurl_set_oauth_client_key()</code></a> and
739
<a class="link" href="flickcurl-section-auth.html#flickcurl-set-oauth-client-secret" title="flickcurl_set_oauth_client_secret ()"><code class="function">flickcurl_set_oauth_client_secret()</code></a> respectively.
740
</p>
741
<p>
742
Calls the Flickr OAuth endpoint to get a request token for the
743
given callback or uses out-of-band if <em class="parameter"><code>callback</code></em> is NULL.
744
</p>
745
<p>
746
On success, stores the request token in the <em class="parameter"><code>fc</code></em> structure.
747
</p>
748
<div class="variablelist"><table border="0">
749
<col align="left" valign="top">
750
<tbody>
751
<tr>
752
<td><p><span class="term"><em class="parameter"><code>fc</code></em> :</span></p></td>
753
<td>flickcurl object</td>
754
</tr>
755
<tr>
756
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
757
<td>callback URL or NULL for out of band</td>
758
</tr>
759
<tr>
760
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
761
<td>non-0 on failure</td>
762
</tr>
763
</tbody>
764
</table></div>
765
</div>
766
<hr>
767
<div class="refsect2">
768
<a name="flickcurl-oauth-get-authorize-uri"></a><h3>flickcurl_oauth_get_authorize_uri ()</h3>
769
<pre class="programlisting"><span class="returnvalue">char</span> * flickcurl_oauth_get_authorize_uri (<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>
770
<p>
771
Get the URL for the user to authorize Flickr OAuth of an application
772
</p>
773
<p>
774
Forms the URL the user needs to start at to authorize the
775
application.
776
</p>
777
<p>
778
This function requires <a class="link" href="flickcurl-section-auth.html#flickcurl-oauth-create-request-token" title="flickcurl_oauth_create_request_token ()"><code class="function">flickcurl_oauth_create_request_token()</code></a> to have
779
been called to build a request token / secret pair.
780
</p>
781
<p>
782
After this function, the application should pass the verifier to
783
<a class="link" href="flickcurl-section-auth.html#flickcurl-oauth-create-access-token" title="flickcurl_oauth_create_access_token ()"><code class="function">flickcurl_oauth_create_access_token()</code></a> for the final step in OAuth along
784
with the request token and request token secret.
785
</p>
786
<div class="variablelist"><table border="0">
787
<col align="left" valign="top">
788
<tbody>
789
<tr>
790
<td><p><span class="term"><em class="parameter"><code>fc</code></em> :</span></p></td>
791
<td>flickcurl object</td>
792
</tr>
793
<tr>
794
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
795
<td>authorize URI or NULL on failure</td>
796
</tr>
797
</tbody>
798
</table></div>
799
</div>
800
<hr>
801
<div class="refsect2">
802
<a name="flickcurl-oauth-create-access-token"></a><h3>flickcurl_oauth_create_access_token ()</h3>
803
<pre class="programlisting"><span class="returnvalue">int</span> flickcurl_oauth_create_access_token (<em class="parameter"><code><a class="link" href="flickcurl-section-core.html#flickcurl" title="flickcurl"><span class="type">flickcurl</span></a> *fc</code></em>,
804
<em class="parameter"><code>const <span class="type">char</span> *verifier</code></em>);</pre>
805
<p>
806
Get a Flickr OAuth access token from request token credentials and verifier
807
</p>
808
<p>
809
Calls the Flickr OAuth access token endpoint using the verifier
810
from out of band authentication to get an access token to enable
811
authenticated calls to the Flickr API.
812
</p>
813
<div class="variablelist"><table border="0">
814
<col align="left" valign="top">
815
<tbody>
816
<tr>
817
<td><p><span class="term"><em class="parameter"><code>fc</code></em> :</span></p></td>
818
<td>flickcurl object</td>
819
</tr>
820
<tr>
821
<td><p><span class="term"><em class="parameter"><code>verifier</code></em> :</span></p></td>
822
<td>verifier from OOB authentication</td>
823
</tr>
824
<tr>
825
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
826
<td>non-0 on failure</td>
827
</tr>
828
</tbody>
829
</table></div>
830
</div>
202
831
</div>
203
832
</div>
204
833
<div class="footer">
Loggerhead is a web-based interface for Breezy
Version: 2.0.1