← Back to branch summary

~noskcaj/ubuntu/vivid/gnome-online-accounts/3.14.2

« back to all changes in this revision

Viewing changes to doc/html/GoaOAuthProvider.html

  • Committer: Package Import Robot
  • Author(s): Emilio Pozuelo Monfort
  • Date: 2014-04-26 11:30:35 UTC
  • mfrom: (1.2.5) (2.1.13 experimental)
  • Revision ID: package-import@ubuntu.com-20140426113035-m9oxbp0uit7f4xte
Tags: 3.12.1-1
* New upstream release.
* Upload to unstable.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/GoaOAuthProvider.html
2
2
<html>
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
 
<title>GoaOAuthProvider</title>
 
5
<title>GNOME Online Accounts Reference Manual: GoaOAuthProvider</title>
6
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
7
<link rel="home" href="index.html" title="GNOME Online Accounts Reference Manual">
8
8
<link rel="up" href="ch07.html" title="Core">
9
 
<link rel="prev" href="GoaProvider.html" title="GoaProvider">
 
9
<link rel="prev" href="GoaProviderFactory.html" title="GoaProviderFactory">
10
10
<link rel="next" href="GoaOAuth2Provider.html" title="GoaOAuth2Provider">
11
 
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
 
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16
 
<tr valign="middle">
17
 
<td><a accesskey="p" href="GoaProvider.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
 
<td><a accesskey="u" href="ch07.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
 
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
 
<th width="100%" align="center">GNOME Online Accounts Reference Manual</th>
21
 
<td><a accesskey="n" href="GoaOAuth2Provider.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22
 
</tr>
23
 
<tr><td colspan="5" class="shortcuts">
24
 
<a href="#GoaOAuthProvider.synopsis" class="shortcut">Top</a>
25
 
                   | 
26
 
                  <a href="#GoaOAuthProvider.description" class="shortcut">Description</a>
27
 
                   | 
28
 
                  <a href="#GoaOAuthProvider.object-hierarchy" class="shortcut">Object Hierarchy</a>
29
 
</td></tr>
30
 
</table>
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
 
16
<td width="100%" align="left" class="shortcuts">
 
17
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 
 
18
                  <a href="#GoaOAuthProvider.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
 
19
                  <a href="#GoaOAuthProvider.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
 
20
</td>
 
21
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
 
22
<td><a accesskey="u" href="ch07.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
 
23
<td><a accesskey="p" href="GoaProviderFactory.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
 
24
<td><a accesskey="n" href="GoaOAuth2Provider.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
 
25
</tr></table>
31
26
<div class="refentry">
32
27
<a name="GoaOAuthProvider"></a><div class="titlepage"></div>
33
28
<div class="refnamediv"><table width="100%"><tr>
35
30
<h2><span class="refentrytitle"><a name="GoaOAuthProvider.top_of_page"></a>GoaOAuthProvider</span></h2>
36
31
<p>GoaOAuthProvider — Abstract base class for OAuth 1.0a providers</p>
37
32
</td>
38
 
<td valign="top" align="right"></td>
 
33
<td class="gallery_image" valign="top" align="right"></td>
39
34
</tr></table></div>
40
 
<div class="refsynopsisdiv">
41
 
<a name="GoaOAuthProvider.synopsis"></a><h2>Synopsis</h2>
42
 
<pre class="synopsis">struct              <a class="link" href="GoaOAuthProvider.html#GoaOAuthProvider-struct" title="struct GoaOAuthProvider">GoaOAuthProvider</a>;
43
 
struct              <a class="link" href="GoaOAuthProvider.html#GoaOAuthProviderClass" title="struct GoaOAuthProviderClass">GoaOAuthProviderClass</a>;
44
 
const <span class="returnvalue">gchar</span> *       <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-authentication-cookie" title="goa_oauth_provider_get_authentication_cookie ()">goa_oauth_provider_get_authentication_cookie</a>
45
 
                                                        (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>);
46
 
const <span class="returnvalue">gchar</span> *       <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-request-uri" title="goa_oauth_provider_get_request_uri ()">goa_oauth_provider_get_request_uri</a>  (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>);
47
 
<span class="returnvalue">gchar</span> **            <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-request-uri-params" title="goa_oauth_provider_get_request_uri_params ()">goa_oauth_provider_get_request_uri_params</a>
48
 
                                                        (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>);
49
 
const <span class="returnvalue">gchar</span> *       <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-authorization-uri" title="goa_oauth_provider_get_authorization_uri ()">goa_oauth_provider_get_authorization_uri</a>
50
 
                                                        (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>);
51
 
const <span class="returnvalue">gchar</span> *       <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-token-uri" title="goa_oauth_provider_get_token_uri ()">goa_oauth_provider_get_token_uri</a>    (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>);
52
 
const <span class="returnvalue">gchar</span> *       <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-callback-uri" title="goa_oauth_provider_get_callback_uri ()">goa_oauth_provider_get_callback_uri</a> (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>);
53
 
const <span class="returnvalue">gchar</span> *       <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-consumer-key" title="goa_oauth_provider_get_consumer_key ()">goa_oauth_provider_get_consumer_key</a> (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>);
54
 
const <span class="returnvalue">gchar</span> *       <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-consumer-secret" title="goa_oauth_provider_get_consumer_secret ()">goa_oauth_provider_get_consumer_secret</a>
55
 
                                                        (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>);
56
 
<span class="returnvalue">gchar</span> *             <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-build-authorization-uri" title="goa_oauth_provider_build_authorization_uri ()">goa_oauth_provider_build_authorization_uri</a>
57
 
                                                        (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>,
58
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *authorization_uri</code></em>,
59
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *escaped_oauth_token</code></em>);
60
 
<span class="returnvalue">gboolean</span>            <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-use-external-browser" title="goa_oauth_provider_get_use_external_browser ()">goa_oauth_provider_get_use_external_browser</a>
61
 
                                                        (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>);
62
 
<span class="returnvalue">gboolean</span>            <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-use-mobile-browser" title="goa_oauth_provider_get_use_mobile_browser ()">goa_oauth_provider_get_use_mobile_browser</a>
63
 
                                                        (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>);
64
 
<span class="returnvalue">gboolean</span>            <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-is-deny-node" title="goa_oauth_provider_is_deny_node ()">goa_oauth_provider_is_deny_node</a>     (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>,
65
 
                                                         <em class="parameter"><code><span class="type">WebKitDOMNode</span> *node</code></em>);
66
 
<span class="returnvalue">gboolean</span>            <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-is-identity-node" title="goa_oauth_provider_is_identity_node ()">goa_oauth_provider_is_identity_node</a> (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>,
67
 
                                                         <em class="parameter"><code><span class="type">WebKitDOMHTMLInputElement</span> *element</code></em>);
68
 
<span class="returnvalue">gboolean</span>            <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-is-password-node" title="goa_oauth_provider_is_password_node ()">goa_oauth_provider_is_password_node</a> (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>,
69
 
                                                         <em class="parameter"><code><span class="type">WebKitDOMHTMLInputElement</span> *element</code></em>);
70
 
<span class="returnvalue">void</span>                <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-add-account-key-values" title="goa_oauth_provider_add_account_key_values ()">goa_oauth_provider_add_account_key_values</a>
71
 
                                                        (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>,
72
 
                                                         <em class="parameter"><code><span class="type">GVariantBuilder</span> *builder</code></em>);
73
 
<span class="returnvalue">gchar</span> *             <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-identity-sync" title="goa_oauth_provider_get_identity_sync ()">goa_oauth_provider_get_identity_sync</a>
74
 
                                                        (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>,
75
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *access_token</code></em>,
76
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *access_token_secret</code></em>,
77
 
                                                         <em class="parameter"><code><span class="type">gchar</span> **out_presentation_identity</code></em>,
78
 
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
79
 
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
80
 
<span class="returnvalue">gchar</span> *             <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-access-token-sync" title="goa_oauth_provider_get_access_token_sync ()">goa_oauth_provider_get_access_token_sync</a>
81
 
                                                        (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>,
82
 
                                                         <em class="parameter"><code><a class="link" href="GoaObject.html" title="GoaObject"><span class="type">GoaObject</span></a> *object</code></em>,
83
 
                                                         <em class="parameter"><code><span class="type">gboolean</span> force_refresh</code></em>,
84
 
                                                         <em class="parameter"><code><span class="type">gchar</span> **out_access_token_secret</code></em>,
85
 
                                                         <em class="parameter"><code><span class="type">gint</span> *out_access_token_expires_in</code></em>,
86
 
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
87
 
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
88
 
<span class="returnvalue">gchar</span> *             <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-parse-request-token-error" title="goa_oauth_provider_parse_request_token_error ()">goa_oauth_provider_parse_request_token_error</a>
89
 
                                                        (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>,
90
 
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/rest/RestProxyCall.html"><span class="type">RestProxyCall</span></a> *call</code></em>);
91
 
</pre>
 
35
<div class="refsect1">
 
36
<a name="GoaOAuthProvider.functions"></a><h2>Functions</h2>
 
37
<div class="informaltable"><table width="100%" border="0">
 
38
<colgroup>
 
39
<col width="150px" class="functions_return">
 
40
<col class="functions_name">
 
41
</colgroup>
 
42
<tbody>
 
43
<tr>
 
44
<td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
45
</td>
 
46
<td class="function_name">
 
47
<a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-authentication-cookie" title="goa_oauth_provider_get_authentication_cookie ()">goa_oauth_provider_get_authentication_cookie</a> <span class="c_punctuation">()</span>
 
48
</td>
 
49
</tr>
 
50
<tr>
 
51
<td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
52
</td>
 
53
<td class="function_name">
 
54
<a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-request-uri" title="goa_oauth_provider_get_request_uri ()">goa_oauth_provider_get_request_uri</a> <span class="c_punctuation">()</span>
 
55
</td>
 
56
</tr>
 
57
<tr>
 
58
<td class="function_type">
 
59
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> **
 
60
</td>
 
61
<td class="function_name">
 
62
<a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-request-uri-params" title="goa_oauth_provider_get_request_uri_params ()">goa_oauth_provider_get_request_uri_params</a> <span class="c_punctuation">()</span>
 
63
</td>
 
64
</tr>
 
65
<tr>
 
66
<td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
67
</td>
 
68
<td class="function_name">
 
69
<a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-authorization-uri" title="goa_oauth_provider_get_authorization_uri ()">goa_oauth_provider_get_authorization_uri</a> <span class="c_punctuation">()</span>
 
70
</td>
 
71
</tr>
 
72
<tr>
 
73
<td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
74
</td>
 
75
<td class="function_name">
 
76
<a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-token-uri" title="goa_oauth_provider_get_token_uri ()">goa_oauth_provider_get_token_uri</a> <span class="c_punctuation">()</span>
 
77
</td>
 
78
</tr>
 
79
<tr>
 
80
<td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
81
</td>
 
82
<td class="function_name">
 
83
<a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-callback-uri" title="goa_oauth_provider_get_callback_uri ()">goa_oauth_provider_get_callback_uri</a> <span class="c_punctuation">()</span>
 
84
</td>
 
85
</tr>
 
86
<tr>
 
87
<td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
88
</td>
 
89
<td class="function_name">
 
90
<a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-consumer-key" title="goa_oauth_provider_get_consumer_key ()">goa_oauth_provider_get_consumer_key</a> <span class="c_punctuation">()</span>
 
91
</td>
 
92
</tr>
 
93
<tr>
 
94
<td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
95
</td>
 
96
<td class="function_name">
 
97
<a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-consumer-secret" title="goa_oauth_provider_get_consumer_secret ()">goa_oauth_provider_get_consumer_secret</a> <span class="c_punctuation">()</span>
 
98
</td>
 
99
</tr>
 
100
<tr>
 
101
<td class="function_type">
 
102
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
103
</td>
 
104
<td class="function_name">
 
105
<a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-build-authorization-uri" title="goa_oauth_provider_build_authorization_uri ()">goa_oauth_provider_build_authorization_uri</a> <span class="c_punctuation">()</span>
 
106
</td>
 
107
</tr>
 
108
<tr>
 
109
<td class="function_type">
 
110
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
111
</td>
 
112
<td class="function_name">
 
113
<a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-use-external-browser" title="goa_oauth_provider_get_use_external_browser ()">goa_oauth_provider_get_use_external_browser</a> <span class="c_punctuation">()</span>
 
114
</td>
 
115
</tr>
 
116
<tr>
 
117
<td class="function_type">
 
118
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
119
</td>
 
120
<td class="function_name">
 
121
<a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-use-mobile-browser" title="goa_oauth_provider_get_use_mobile_browser ()">goa_oauth_provider_get_use_mobile_browser</a> <span class="c_punctuation">()</span>
 
122
</td>
 
123
</tr>
 
124
<tr>
 
125
<td class="function_type">
 
126
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
127
</td>
 
128
<td class="function_name">
 
129
<a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-is-deny-node" title="goa_oauth_provider_is_deny_node ()">goa_oauth_provider_is_deny_node</a> <span class="c_punctuation">()</span>
 
130
</td>
 
131
</tr>
 
132
<tr>
 
133
<td class="function_type">
 
134
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
135
</td>
 
136
<td class="function_name">
 
137
<a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-is-identity-node" title="goa_oauth_provider_is_identity_node ()">goa_oauth_provider_is_identity_node</a> <span class="c_punctuation">()</span>
 
138
</td>
 
139
</tr>
 
140
<tr>
 
141
<td class="function_type">
 
142
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
143
</td>
 
144
<td class="function_name">
 
145
<a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-is-password-node" title="goa_oauth_provider_is_password_node ()">goa_oauth_provider_is_password_node</a> <span class="c_punctuation">()</span>
 
146
</td>
 
147
</tr>
 
148
<tr>
 
149
<td class="function_type">
 
150
<span class="returnvalue">void</span>
 
151
</td>
 
152
<td class="function_name">
 
153
<a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-add-account-key-values" title="goa_oauth_provider_add_account_key_values ()">goa_oauth_provider_add_account_key_values</a> <span class="c_punctuation">()</span>
 
154
</td>
 
155
</tr>
 
156
<tr>
 
157
<td class="function_type">
 
158
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
159
</td>
 
160
<td class="function_name">
 
161
<a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-identity-sync" title="goa_oauth_provider_get_identity_sync ()">goa_oauth_provider_get_identity_sync</a> <span class="c_punctuation">()</span>
 
162
</td>
 
163
</tr>
 
164
<tr>
 
165
<td class="function_type">
 
166
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
167
</td>
 
168
<td class="function_name">
 
169
<a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-access-token-sync" title="goa_oauth_provider_get_access_token_sync ()">goa_oauth_provider_get_access_token_sync</a> <span class="c_punctuation">()</span>
 
170
</td>
 
171
</tr>
 
172
<tr>
 
173
<td class="function_type">
 
174
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
175
</td>
 
176
<td class="function_name">
 
177
<a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-parse-request-token-error" title="goa_oauth_provider_parse_request_token_error ()">goa_oauth_provider_parse_request_token_error</a> <span class="c_punctuation">()</span>
 
178
</td>
 
179
</tr>
 
180
</tbody>
 
181
</table></div>
 
182
</div>
 
183
<div class="refsect1">
 
184
<a name="GoaOAuthProvider.other"></a><h2>Types and Values</h2>
 
185
<div class="informaltable"><table width="100%" border="0">
 
186
<colgroup>
 
187
<col width="150px" class="name">
 
188
<col class="description">
 
189
</colgroup>
 
190
<tbody>
 
191
<tr>
 
192
<td class="datatype_keyword">struct</td>
 
193
<td class="function_name"><a class="link" href="GoaOAuthProvider.html#GoaOAuthProvider-struct" title="struct GoaOAuthProvider">GoaOAuthProvider</a></td>
 
194
</tr>
 
195
<tr>
 
196
<td class="datatype_keyword">struct</td>
 
197
<td class="function_name"><a class="link" href="GoaOAuthProvider.html#GoaOAuthProviderClass" title="struct GoaOAuthProviderClass">GoaOAuthProviderClass</a></td>
 
198
</tr>
 
199
</tbody>
 
200
</table></div>
92
201
</div>
93
202
<div class="refsect1">
94
203
<a name="GoaOAuthProvider.object-hierarchy"></a><h2>Object Hierarchy</h2>
95
 
<pre class="synopsis">
96
 
  GObject
97
 
   +----<a class="link" href="GoaProvider.html" title="GoaProvider">GoaProvider</a>
98
 
         +----GoaOAuthProvider
99
 
               +----<a class="link" href="GoaFlickrProvider.html" title="GoaFlickrProvider">GoaFlickrProvider</a>
 
204
<pre class="screen">    <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
205
    <span class="lineart">╰──</span> <a class="link" href="GoaProvider.html" title="GoaProvider">GoaProvider</a>
 
206
        <span class="lineart">╰──</span> GoaOAuthProvider
 
207
            <span class="lineart">├──</span> <a class="link" href="GoaYahooProvider.html" title="GoaYahooProvider">GoaYahooProvider</a>
 
208
            <span class="lineart">╰──</span> <a class="link" href="GoaFlickrProvider.html" title="GoaFlickrProvider">GoaFlickrProvider</a>
100
209
</pre>
101
210
</div>
102
211
<div class="refsect1">
103
212
<a name="GoaOAuthProvider.description"></a><h2>Description</h2>
104
 
<p>
105
 
<a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> is an abstract base class for OAuth 1.0a
 
213
<p><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> is an abstract base class for OAuth 1.0a
106
214
compliant implementations as defined by <a class="ulink" href="http://tools.ietf.org/html/rfc5849" target="_top">RFC
107
215
5849</a>. Additionally, the code works with providers
108
216
implementing <a class="ulink" href="http://oauth.googlecode.com/svn/spec/ext/session/1.0/drafts/1/spec.html" target="_top">OAuth
109
 
Session 1.0 Draft 1</a> for refreshing access tokens.
110
 
</p>
111
 
<p>
112
 
Subclasses must implement
 
217
Session 1.0 Draft 1</a> for refreshing access tokens.</p>
 
218
<p>Subclasses must implement
113
219
<a class="link" href="GoaOAuthProvider.html#GoaOAuthProviderClass.get-consumer-key"><span class="type">GoaOAuthProviderClass.get_consumer_key</span></a>,
114
220
<a class="link" href="GoaOAuthProvider.html#GoaOAuthProviderClass.get-consumer-secret"><span class="type">GoaOAuthProviderClass.get_consumer_secret</span></a>,
115
221
<a class="link" href="GoaOAuthProvider.html#GoaOAuthProviderClass.get-request-uri"><span class="type">GoaOAuthProviderClass.get_request_uri</span></a>,
116
222
<a class="link" href="GoaOAuthProvider.html#GoaOAuthProviderClass.get-authorization-uri"><span class="type">GoaOAuthProviderClass.get_authorization_uri</span></a>,
117
223
<a class="link" href="GoaOAuthProvider.html#GoaOAuthProviderClass.get-token-uri"><span class="type">GoaOAuthProviderClass.get_token_uri</span></a>,
118
224
<a class="link" href="GoaOAuthProvider.html#GoaOAuthProviderClass.get-callback-uri"><span class="type">GoaOAuthProviderClass.get_callback_uri</span></a> and
119
 
<a class="link" href="GoaOAuthProvider.html#GoaOAuthProviderClass.get-identity-sync"><span class="type">GoaOAuthProviderClass.get_identity_sync</span></a> methods.
120
 
</p>
121
 
<p>
122
 
Additionally, the
 
225
<a class="link" href="GoaOAuthProvider.html#GoaOAuthProviderClass.get-identity-sync"><span class="type">GoaOAuthProviderClass.get_identity_sync</span></a> methods.</p>
 
226
<p>Additionally, the
123
227
<a class="link" href="GoaProvider.html#GoaProviderClass.get-provider-type"><span class="type">GoaProviderClass.get_provider_type</span></a>,
124
228
<a class="link" href="GoaProvider.html#GoaProviderClass.get-provider-name"><span class="type">GoaProviderClass.get_provider_name</span></a>,
125
229
<a class="link" href="GoaProvider.html#GoaProviderClass.build-object"><span class="type">GoaProviderClass.build_object</span></a> (this should chain up to its
126
 
parent class) methods must be implemented.
127
 
</p>
128
 
<p>
129
 
Note that the <a class="link" href="GoaProvider.html#GoaProviderClass.add-account"><span class="type">GoaProviderClass.add_account</span></a>,
 
230
parent class) methods must be implemented.</p>
 
231
<p>Note that the <a class="link" href="GoaProvider.html#GoaProviderClass.add-account"><span class="type">GoaProviderClass.add_account</span></a>,
130
232
<a class="link" href="GoaProvider.html#GoaProviderClass.refresh-account"><span class="type">GoaProviderClass.refresh_account</span></a> and
131
233
<a class="link" href="GoaProvider.html#GoaProviderClass.ensure-credentials-sync"><span class="type">GoaProviderClass.ensure_credentials_sync</span></a> methods do not
132
 
need to be implemented - this type implements these methods.
133
 
</p>
134
 
</div>
135
 
<div class="refsect1">
136
 
<a name="GoaOAuthProvider.details"></a><h2>Details</h2>
 
234
need to be implemented - this type implements these methods.</p>
 
235
</div>
 
236
<div class="refsect1">
 
237
<a name="GoaOAuthProvider.functions_details"></a><h2>Functions</h2>
 
238
<div class="refsect2">
 
239
<a name="goa-oauth-provider-get-authentication-cookie"></a><h3>goa_oauth_provider_get_authentication_cookie ()</h3>
 
240
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
241
goa_oauth_provider_get_authentication_cookie
 
242
                               (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>);</pre>
 
243
<p>Gets the name of a cookie whose presence indicates that the user has been able to
 
244
log in during the authorization step. This is used to modify the embedded web
 
245
browser UI that is presented to the user.</p>
 
246
<p>This is a pure virtual method - a subclass must provide an
 
247
implementation.</p>
 
248
<div class="refsect3">
 
249
<a name="id-1.5.2.5.7.2.6"></a><h4>Parameters</h4>
 
250
<div class="informaltable"><table width="100%" border="0">
 
251
<colgroup>
 
252
<col width="150px" class="parameters_name">
 
253
<col class="parameters_description">
 
254
<col width="200px" class="parameters_annotations">
 
255
</colgroup>
 
256
<tbody><tr>
 
257
<td class="parameter_name"><p>provider</p></td>
 
258
<td class="parameter_description"><p>A <a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a>.</p></td>
 
259
<td class="parameter_annotations"> </td>
 
260
</tr></tbody>
 
261
</table></div>
 
262
</div>
 
263
<div class="refsect3">
 
264
<a name="id-1.5.2.5.7.2.7"></a><h4>Returns</h4>
 
265
<p> A string owned by <em class="parameter"><code>provider</code></em>
 
266
- do not free. </p>
 
267
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 
268
</div>
 
269
</div>
 
270
<hr>
 
271
<div class="refsect2">
 
272
<a name="goa-oauth-provider-get-request-uri"></a><h3>goa_oauth_provider_get_request_uri ()</h3>
 
273
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
274
goa_oauth_provider_get_request_uri (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>);</pre>
 
275
<p>Gets the request uri.</p>
 
276
<p>http://tools.ietf.org/html/rfc5849<span class="type">section-2.1</span></p>
 
277
<p>This is a pure virtual method - a subclass must provide an
 
278
implementation.</p>
 
279
<div class="refsect3">
 
280
<a name="id-1.5.2.5.7.3.7"></a><h4>Parameters</h4>
 
281
<div class="informaltable"><table width="100%" border="0">
 
282
<colgroup>
 
283
<col width="150px" class="parameters_name">
 
284
<col class="parameters_description">
 
285
<col width="200px" class="parameters_annotations">
 
286
</colgroup>
 
287
<tbody><tr>
 
288
<td class="parameter_name"><p>provider</p></td>
 
289
<td class="parameter_description"><p>A <a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a>.</p></td>
 
290
<td class="parameter_annotations"> </td>
 
291
</tr></tbody>
 
292
</table></div>
 
293
</div>
 
294
<div class="refsect3">
 
295
<a name="id-1.5.2.5.7.3.8"></a><h4>Returns</h4>
 
296
<p> A string owned by <em class="parameter"><code>provider</code></em>
 
297
- do not free. </p>
 
298
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 
299
</div>
 
300
</div>
 
301
<hr>
 
302
<div class="refsect2">
 
303
<a name="goa-oauth-provider-get-request-uri-params"></a><h3>goa_oauth_provider_get_request_uri_params ()</h3>
 
304
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> **
 
305
goa_oauth_provider_get_request_uri_params
 
306
                               (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>);</pre>
 
307
<p>Gets additional parameters for the request URI.</p>
 
308
<p>http://tools.ietf.org/html/rfc5849<span class="type">section-2.1</span></p>
 
309
<p>This is a virtual method where the default implementation returns
 
310
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
 
311
<div class="refsect3">
 
312
<a name="id-1.5.2.5.7.4.7"></a><h4>Parameters</h4>
 
313
<div class="informaltable"><table width="100%" border="0">
 
314
<colgroup>
 
315
<col width="150px" class="parameters_name">
 
316
<col class="parameters_description">
 
317
<col width="200px" class="parameters_annotations">
 
318
</colgroup>
 
319
<tbody><tr>
 
320
<td class="parameter_name"><p>provider</p></td>
 
321
<td class="parameter_description"><p>A <a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a>.</p></td>
 
322
<td class="parameter_annotations"> </td>
 
323
</tr></tbody>
 
324
</table></div>
 
325
</div>
 
326
<div class="refsect3">
 
327
<a name="id-1.5.2.5.7.4.8"></a><h4>Returns</h4>
 
328
<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> (for no parameters) or a
 
329
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated array of (key, value) pairs that will be added to
 
330
the URI. The caller will free the returned value with <a href="http://library.gnome.org/devel/glib/unstable/glib-String-Utility-Functions.html#g-strfreev"><code class="function">g_strfreev()</code></a>. </p>
 
331
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 
332
</div>
 
333
</div>
 
334
<hr>
 
335
<div class="refsect2">
 
336
<a name="goa-oauth-provider-get-authorization-uri"></a><h3>goa_oauth_provider_get_authorization_uri ()</h3>
 
337
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
338
goa_oauth_provider_get_authorization_uri
 
339
                               (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>);</pre>
 
340
<p>Gets the authorization uri.</p>
 
341
<p>http://tools.ietf.org/html/rfc5849<span class="type">section-2.2</span></p>
 
342
<p>This is a pure virtual method - a subclass must provide an
 
343
implementation.</p>
 
344
<div class="refsect3">
 
345
<a name="id-1.5.2.5.7.5.7"></a><h4>Parameters</h4>
 
346
<div class="informaltable"><table width="100%" border="0">
 
347
<colgroup>
 
348
<col width="150px" class="parameters_name">
 
349
<col class="parameters_description">
 
350
<col width="200px" class="parameters_annotations">
 
351
</colgroup>
 
352
<tbody><tr>
 
353
<td class="parameter_name"><p>provider</p></td>
 
354
<td class="parameter_description"><p>A <a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a>.</p></td>
 
355
<td class="parameter_annotations"> </td>
 
356
</tr></tbody>
 
357
</table></div>
 
358
</div>
 
359
<div class="refsect3">
 
360
<a name="id-1.5.2.5.7.5.8"></a><h4>Returns</h4>
 
361
<p> A string owned by <em class="parameter"><code>provider</code></em>
 
362
- do not free. </p>
 
363
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 
364
</div>
 
365
</div>
 
366
<hr>
 
367
<div class="refsect2">
 
368
<a name="goa-oauth-provider-get-token-uri"></a><h3>goa_oauth_provider_get_token_uri ()</h3>
 
369
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
370
goa_oauth_provider_get_token_uri (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>);</pre>
 
371
<p>Gets the token uri.</p>
 
372
<p>http://tools.ietf.org/html/rfc5849<span class="type">section-2.3</span></p>
 
373
<p>This is a pure virtual method - a subclass must provide an
 
374
implementation.</p>
 
375
<div class="refsect3">
 
376
<a name="id-1.5.2.5.7.6.7"></a><h4>Parameters</h4>
 
377
<div class="informaltable"><table width="100%" border="0">
 
378
<colgroup>
 
379
<col width="150px" class="parameters_name">
 
380
<col class="parameters_description">
 
381
<col width="200px" class="parameters_annotations">
 
382
</colgroup>
 
383
<tbody><tr>
 
384
<td class="parameter_name"><p>provider</p></td>
 
385
<td class="parameter_description"><p>A <a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a>.</p></td>
 
386
<td class="parameter_annotations"> </td>
 
387
</tr></tbody>
 
388
</table></div>
 
389
</div>
 
390
<div class="refsect3">
 
391
<a name="id-1.5.2.5.7.6.8"></a><h4>Returns</h4>
 
392
<p> A string owned by <em class="parameter"><code>provider</code></em>
 
393
- do not free. </p>
 
394
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 
395
</div>
 
396
</div>
 
397
<hr>
 
398
<div class="refsect2">
 
399
<a name="goa-oauth-provider-get-callback-uri"></a><h3>goa_oauth_provider_get_callback_uri ()</h3>
 
400
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
401
goa_oauth_provider_get_callback_uri (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>);</pre>
 
402
<p>Gets the callback uri.</p>
 
403
<p>http://tools.ietf.org/html/rfc5849<span class="type">section-2.1</span></p>
 
404
<p>This is a pure virtual method - a subclass must provide an
 
405
implementation.</p>
 
406
<div class="refsect3">
 
407
<a name="id-1.5.2.5.7.7.7"></a><h4>Parameters</h4>
 
408
<div class="informaltable"><table width="100%" border="0">
 
409
<colgroup>
 
410
<col width="150px" class="parameters_name">
 
411
<col class="parameters_description">
 
412
<col width="200px" class="parameters_annotations">
 
413
</colgroup>
 
414
<tbody><tr>
 
415
<td class="parameter_name"><p>provider</p></td>
 
416
<td class="parameter_description"><p>A <a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a>.</p></td>
 
417
<td class="parameter_annotations"> </td>
 
418
</tr></tbody>
 
419
</table></div>
 
420
</div>
 
421
<div class="refsect3">
 
422
<a name="id-1.5.2.5.7.7.8"></a><h4>Returns</h4>
 
423
<p> A string owned by <em class="parameter"><code>provider</code></em>
 
424
- do not free. </p>
 
425
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 
426
</div>
 
427
</div>
 
428
<hr>
 
429
<div class="refsect2">
 
430
<a name="goa-oauth-provider-get-consumer-key"></a><h3>goa_oauth_provider_get_consumer_key ()</h3>
 
431
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
432
goa_oauth_provider_get_consumer_key (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>);</pre>
 
433
<p>Gets the consumer key identifying the client.</p>
 
434
<p>This is a pure virtual method - a subclass must provide an
 
435
implementation.</p>
 
436
<div class="refsect3">
 
437
<a name="id-1.5.2.5.7.8.6"></a><h4>Parameters</h4>
 
438
<div class="informaltable"><table width="100%" border="0">
 
439
<colgroup>
 
440
<col width="150px" class="parameters_name">
 
441
<col class="parameters_description">
 
442
<col width="200px" class="parameters_annotations">
 
443
</colgroup>
 
444
<tbody><tr>
 
445
<td class="parameter_name"><p>provider</p></td>
 
446
<td class="parameter_description"><p>A <a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a>.</p></td>
 
447
<td class="parameter_annotations"> </td>
 
448
</tr></tbody>
 
449
</table></div>
 
450
</div>
 
451
<div class="refsect3">
 
452
<a name="id-1.5.2.5.7.8.7"></a><h4>Returns</h4>
 
453
<p> A string owned by <em class="parameter"><code>provider</code></em>
 
454
- do not free. </p>
 
455
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 
456
</div>
 
457
</div>
 
458
<hr>
 
459
<div class="refsect2">
 
460
<a name="goa-oauth-provider-get-consumer-secret"></a><h3>goa_oauth_provider_get_consumer_secret ()</h3>
 
461
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
462
goa_oauth_provider_get_consumer_secret
 
463
                               (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>);</pre>
 
464
<p>Gets the consumer secret identifying the client.</p>
 
465
<p>This is a pure virtual method - a subclass must provide an
 
466
implementation.</p>
 
467
<div class="refsect3">
 
468
<a name="id-1.5.2.5.7.9.6"></a><h4>Parameters</h4>
 
469
<div class="informaltable"><table width="100%" border="0">
 
470
<colgroup>
 
471
<col width="150px" class="parameters_name">
 
472
<col class="parameters_description">
 
473
<col width="200px" class="parameters_annotations">
 
474
</colgroup>
 
475
<tbody><tr>
 
476
<td class="parameter_name"><p>provider</p></td>
 
477
<td class="parameter_description"><p>A <a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a>.</p></td>
 
478
<td class="parameter_annotations"> </td>
 
479
</tr></tbody>
 
480
</table></div>
 
481
</div>
 
482
<div class="refsect3">
 
483
<a name="id-1.5.2.5.7.9.7"></a><h4>Returns</h4>
 
484
<p> A string owned by <em class="parameter"><code>provider</code></em>
 
485
- do not free. </p>
 
486
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 
487
</div>
 
488
</div>
 
489
<hr>
 
490
<div class="refsect2">
 
491
<a name="goa-oauth-provider-build-authorization-uri"></a><h3>goa_oauth_provider_build_authorization_uri ()</h3>
 
492
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
493
goa_oauth_provider_build_authorization_uri
 
494
                               (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>,
 
495
                                <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *authorization_uri</code></em>,
 
496
                                <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *escaped_oauth_token</code></em>);</pre>
 
497
<p>Builds the URI that can be opened in a web browser (or embedded web
 
498
browser widget) to start authenticating an user.</p>
 
499
<p>The default implementation just returns the expected URI
 
500
(e.g. <code class="literal">http://example.com/dialog/oauth?auth_token=1234567890</code>)</p>
 
501
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>override (and chain up) if you e.g. need to to pass additional
 
502
parameters.</p></li></ul></div>
 
503
<p>The <em class="parameter"><code>authorization_uri</code></em>
 
504
 parameter originate from the result of the
 
505
the <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-authorization-uri" title="goa_oauth_provider_get_authorization_uri ()"><code class="function">goa_oauth_provider_get_authorization_uri()</code></a> method. The
 
506
<em class="parameter"><code>escaped_oauth_token</code></em>
 
507
 parameter is the temporary credentials identifier
 
508
escaped using <a href="http://library.gnome.org/devel/glib/unstable/glib-URI-Functions.html#g-uri-escape-string"><code class="function">g_uri_escape_string()</code></a>.</p>
 
509
<div class="refsect3">
 
510
<a name="id-1.5.2.5.7.10.8"></a><h4>Parameters</h4>
 
511
<div class="informaltable"><table width="100%" border="0">
 
512
<colgroup>
 
513
<col width="150px" class="parameters_name">
 
514
<col class="parameters_description">
 
515
<col width="200px" class="parameters_annotations">
 
516
</colgroup>
 
517
<tbody>
 
518
<tr>
 
519
<td class="parameter_name"><p>provider</p></td>
 
520
<td class="parameter_description"><p>A <a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a>.</p></td>
 
521
<td class="parameter_annotations"> </td>
 
522
</tr>
 
523
<tr>
 
524
<td class="parameter_name"><p>authorization_uri</p></td>
 
525
<td class="parameter_description"><p>An authorization URI.</p></td>
 
526
<td class="parameter_annotations"> </td>
 
527
</tr>
 
528
<tr>
 
529
<td class="parameter_name"><p>escaped_oauth_token</p></td>
 
530
<td class="parameter_description"><p>An escaped oauth token.</p></td>
 
531
<td class="parameter_annotations"> </td>
 
532
</tr>
 
533
</tbody>
 
534
</table></div>
 
535
</div>
 
536
<div class="refsect3">
 
537
<a name="id-1.5.2.5.7.10.9"></a><h4>Returns</h4>
 
538
<p> An authorization URI that must be freed with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>. </p>
 
539
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 
540
</div>
 
541
</div>
 
542
<hr>
 
543
<div class="refsect2">
 
544
<a name="goa-oauth-provider-get-use-external-browser"></a><h3>goa_oauth_provider_get_use_external_browser ()</h3>
 
545
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
546
goa_oauth_provider_get_use_external_browser
 
547
                               (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>);</pre>
 
548
<p>Returns whether an external browser (the users default browser)
 
549
should be used for user interaction.</p>
 
550
<p>If an external browser is used, then the dialogs presented in
 
551
<a class="link" href="GoaProvider.html#goa-provider-add-account" title="goa_provider_add_account ()"><code class="function">goa_provider_add_account()</code></a> and
 
552
<a class="link" href="GoaProvider.html#goa-provider-refresh-account" title="goa_provider_refresh_account ()"><code class="function">goa_provider_refresh_account()</code></a> will show a simple "Paste
 
553
authorization code here" instructions along with an entry and
 
554
button.</p>
 
555
<p>This is a virtual method where the default implementation returns
 
556
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p>
 
557
<div class="refsect3">
 
558
<a name="id-1.5.2.5.7.11.7"></a><h4>Parameters</h4>
 
559
<div class="informaltable"><table width="100%" border="0">
 
560
<colgroup>
 
561
<col width="150px" class="parameters_name">
 
562
<col class="parameters_description">
 
563
<col width="200px" class="parameters_annotations">
 
564
</colgroup>
 
565
<tbody><tr>
 
566
<td class="parameter_name"><p>provider</p></td>
 
567
<td class="parameter_description"><p>A <a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a>.</p></td>
 
568
<td class="parameter_annotations"> </td>
 
569
</tr></tbody>
 
570
</table></div>
 
571
</div>
 
572
<div class="refsect3">
 
573
<a name="id-1.5.2.5.7.11.8"></a><h4>Returns</h4>
 
574
<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the user interaction should happen in an external
 
575
browser, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> to use an embedded browser widget.</p>
 
576
<p></p>
 
577
</div>
 
578
</div>
 
579
<hr>
 
580
<div class="refsect2">
 
581
<a name="goa-oauth-provider-get-use-mobile-browser"></a><h3>goa_oauth_provider_get_use_mobile_browser ()</h3>
 
582
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
583
goa_oauth_provider_get_use_mobile_browser
 
584
                               (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>);</pre>
 
585
<p>Returns whether there is a need for the embedded browser to identify
 
586
itself as running on a mobile phone in order to get a more compact
 
587
version of the approval page.</p>
 
588
<p>This is a virtual method where the default implementation returns
 
589
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p>
 
590
<div class="refsect3">
 
591
<a name="id-1.5.2.5.7.12.6"></a><h4>Parameters</h4>
 
592
<div class="informaltable"><table width="100%" border="0">
 
593
<colgroup>
 
594
<col width="150px" class="parameters_name">
 
595
<col class="parameters_description">
 
596
<col width="200px" class="parameters_annotations">
 
597
</colgroup>
 
598
<tbody><tr>
 
599
<td class="parameter_name"><p>provider</p></td>
 
600
<td class="parameter_description"><p>A <a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a>.</p></td>
 
601
<td class="parameter_annotations"> </td>
 
602
</tr></tbody>
 
603
</table></div>
 
604
</div>
 
605
<div class="refsect3">
 
606
<a name="id-1.5.2.5.7.12.7"></a><h4>Returns</h4>
 
607
<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the embedded browser should identify itself as
 
608
running on a mobile platform, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p>
 
609
<p></p>
 
610
</div>
 
611
</div>
 
612
<hr>
 
613
<div class="refsect2">
 
614
<a name="goa-oauth-provider-is-deny-node"></a><h3>goa_oauth_provider_is_deny_node ()</h3>
 
615
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
616
goa_oauth_provider_is_deny_node (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>,
 
617
                                 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/webkitdomgtk/WebKitDOMNode.html"><span class="type">WebKitDOMNode</span></a> *node</code></em>);</pre>
 
618
<p>Checks whether <em class="parameter"><code>node</code></em>
 
619
 is the HTML UI element that the user can use
 
620
to deny permission to access his account. Usually they are either a
 
621
WebKitDOMHTMLButtonElement or a WebKitDOMHTMLInputElement.</p>
 
622
<p>Please note that providers may have multiple such elements in their
 
623
UI and this method should catch all of them.</p>
 
624
<p>This is a pure virtual method - a subclass must provide an
 
625
implementation.</p>
 
626
<div class="refsect3">
 
627
<a name="id-1.5.2.5.7.13.7"></a><h4>Parameters</h4>
 
628
<div class="informaltable"><table width="100%" border="0">
 
629
<colgroup>
 
630
<col width="150px" class="parameters_name">
 
631
<col class="parameters_description">
 
632
<col width="200px" class="parameters_annotations">
 
633
</colgroup>
 
634
<tbody>
 
635
<tr>
 
636
<td class="parameter_name"><p>provider</p></td>
 
637
<td class="parameter_description"><p>A <a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a>.</p></td>
 
638
<td class="parameter_annotations"> </td>
 
639
</tr>
 
640
<tr>
 
641
<td class="parameter_name"><p>node</p></td>
 
642
<td class="parameter_description"><p>A WebKitDOMNode.</p></td>
 
643
<td class="parameter_annotations"> </td>
 
644
</tr>
 
645
</tbody>
 
646
</table></div>
 
647
</div>
 
648
<div class="refsect3">
 
649
<a name="id-1.5.2.5.7.13.8"></a><h4>Returns</h4>
 
650
<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the <em class="parameter"><code>node</code></em>
 
651
can be used to deny permission.</p>
 
652
<p></p>
 
653
</div>
 
654
</div>
 
655
<hr>
 
656
<div class="refsect2">
 
657
<a name="goa-oauth-provider-is-identity-node"></a><h3>goa_oauth_provider_is_identity_node ()</h3>
 
658
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
659
goa_oauth_provider_is_identity_node (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>,
 
660
                                     <em class="parameter"><code><a href="/usr/share/gtk-doc/html/webkitdomgtk/WebKitDOMHTMLInputElement.html"><span class="type">WebKitDOMHTMLInputElement</span></a> *element</code></em>);</pre>
 
661
<p>Checks whether <em class="parameter"><code>element</code></em>
 
662
 is the HTML UI element that the user can
 
663
use to identify herself at the provider.</p>
 
664
<p>This is a pure virtual method - a subclass must provide an
 
665
implementation.</p>
 
666
<div class="refsect3">
 
667
<a name="id-1.5.2.5.7.14.6"></a><h4>Parameters</h4>
 
668
<div class="informaltable"><table width="100%" border="0">
 
669
<colgroup>
 
670
<col width="150px" class="parameters_name">
 
671
<col class="parameters_description">
 
672
<col width="200px" class="parameters_annotations">
 
673
</colgroup>
 
674
<tbody>
 
675
<tr>
 
676
<td class="parameter_name"><p>provider</p></td>
 
677
<td class="parameter_description"><p>A <a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a>.</p></td>
 
678
<td class="parameter_annotations"> </td>
 
679
</tr>
 
680
<tr>
 
681
<td class="parameter_name"><p>element</p></td>
 
682
<td class="parameter_description"><p>A WebKitDOMHTMLInputElement.</p></td>
 
683
<td class="parameter_annotations"> </td>
 
684
</tr>
 
685
</tbody>
 
686
</table></div>
 
687
</div>
 
688
<div class="refsect3">
 
689
<a name="id-1.5.2.5.7.14.7"></a><h4>Returns</h4>
 
690
<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the <em class="parameter"><code>element</code></em>
 
691
can be used to deny permission.</p>
 
692
<p></p>
 
693
</div>
 
694
</div>
 
695
<hr>
 
696
<div class="refsect2">
 
697
<a name="goa-oauth-provider-is-password-node"></a><h3>goa_oauth_provider_is_password_node ()</h3>
 
698
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
699
goa_oauth_provider_is_password_node (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>,
 
700
                                     <em class="parameter"><code><a href="/usr/share/gtk-doc/html/webkitdomgtk/WebKitDOMHTMLInputElement.html"><span class="type">WebKitDOMHTMLInputElement</span></a> *element</code></em>);</pre>
 
701
<p>Checks whether <em class="parameter"><code>element</code></em>
 
702
 is the HTML UI element that the user can
 
703
use to enter her password. This can be used to offer a
 
704
<a class="link" href="GoaPasswordBased.html" title="GoaPasswordBased"><span class="type">GoaPasswordBased</span></a> interface by saving the user's
 
705
password. Providers usually frown upon doing this, so this is not
 
706
recommended.</p>
 
707
<p>This is a virtual method where the default implementation returns
 
708
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p>
 
709
<div class="refsect3">
 
710
<a name="id-1.5.2.5.7.15.6"></a><h4>Parameters</h4>
 
711
<div class="informaltable"><table width="100%" border="0">
 
712
<colgroup>
 
713
<col width="150px" class="parameters_name">
 
714
<col class="parameters_description">
 
715
<col width="200px" class="parameters_annotations">
 
716
</colgroup>
 
717
<tbody>
 
718
<tr>
 
719
<td class="parameter_name"><p>provider</p></td>
 
720
<td class="parameter_description"><p>A <a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a>.</p></td>
 
721
<td class="parameter_annotations"> </td>
 
722
</tr>
 
723
<tr>
 
724
<td class="parameter_name"><p>element</p></td>
 
725
<td class="parameter_description"><p>A WebKitDOMHTMLInputElement</p></td>
 
726
<td class="parameter_annotations"> </td>
 
727
</tr>
 
728
</tbody>
 
729
</table></div>
 
730
</div>
 
731
<div class="refsect3">
 
732
<a name="id-1.5.2.5.7.15.7"></a><h4>Returns</h4>
 
733
<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>element</code></em>
 
734
can be used to enter the password.</p>
 
735
<p></p>
 
736
</div>
 
737
</div>
 
738
<hr>
 
739
<div class="refsect2">
 
740
<a name="goa-oauth-provider-add-account-key-values"></a><h3>goa_oauth_provider_add_account_key_values ()</h3>
 
741
<pre class="programlisting"><span class="returnvalue">void</span>
 
742
goa_oauth_provider_add_account_key_values
 
743
                               (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>,
 
744
                                <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariantBuilder"><span class="type">GVariantBuilder</span></a> *builder</code></em>);</pre>
 
745
<p>Hook for implementations to add key/value pairs to the key-file
 
746
when creating an account.</p>
 
747
<p>This is a virtual method where the default implementation does nothing.</p>
 
748
<div class="refsect3">
 
749
<a name="id-1.5.2.5.7.16.6"></a><h4>Parameters</h4>
 
750
<div class="informaltable"><table width="100%" border="0">
 
751
<colgroup>
 
752
<col width="150px" class="parameters_name">
 
753
<col class="parameters_description">
 
754
<col width="200px" class="parameters_annotations">
 
755
</colgroup>
 
756
<tbody>
 
757
<tr>
 
758
<td class="parameter_name"><p>provider</p></td>
 
759
<td class="parameter_description"><p>A <a class="link" href="GoaProvider.html" title="GoaProvider"><span class="type">GoaProvider</span></a>.</p></td>
 
760
<td class="parameter_annotations"> </td>
 
761
</tr>
 
762
<tr>
 
763
<td class="parameter_name"><p>builder</p></td>
 
764
<td class="parameter_description"><p>A <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariantBuilder"><span class="type">GVariantBuilder</span></a> for a <code class="literal">a{ss}</code> variant.</p></td>
 
765
<td class="parameter_annotations"> </td>
 
766
</tr>
 
767
</tbody>
 
768
</table></div>
 
769
</div>
 
770
</div>
 
771
<hr>
 
772
<div class="refsect2">
 
773
<a name="goa-oauth-provider-get-identity-sync"></a><h3>goa_oauth_provider_get_identity_sync ()</h3>
 
774
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
775
goa_oauth_provider_get_identity_sync (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>,
 
776
                                      <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *access_token</code></em>,
 
777
                                      <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *access_token_secret</code></em>,
 
778
                                      <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **out_presentation_identity</code></em>,
 
779
                                      <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
780
                                      <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
781
<p>Method that returns the identity corresponding to <em class="parameter"><code>access_token</code></em>
 
782
 and
 
783
<em class="parameter"><code>access_token_secret</code></em>
 
784
.</p>
 
785
<p>The identity is needed because all authentication happens out of
 
786
band. In addition to the identity, an implementation also returns a
 
787
<span class="emphasis"><em>presentation identity</em></span> that is more suitable
 
788
for presentation (the identity could be a GUID for example).</p>
 
789
<p>The calling thread is blocked while the identity is obtained.</p>
 
790
<p>This is a pure virtual method - a subclass must provide an
 
791
implementation.</p>
 
792
<div class="refsect3">
 
793
<a name="id-1.5.2.5.7.17.8"></a><h4>Parameters</h4>
 
794
<div class="informaltable"><table width="100%" border="0">
 
795
<colgroup>
 
796
<col width="150px" class="parameters_name">
 
797
<col class="parameters_description">
 
798
<col width="200px" class="parameters_annotations">
 
799
</colgroup>
 
800
<tbody>
 
801
<tr>
 
802
<td class="parameter_name"><p>provider</p></td>
 
803
<td class="parameter_description"><p>A <a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a>.</p></td>
 
804
<td class="parameter_annotations"> </td>
 
805
</tr>
 
806
<tr>
 
807
<td class="parameter_name"><p>access_token</p></td>
 
808
<td class="parameter_description"><p>A valid OAuth 1.0 access token.</p></td>
 
809
<td class="parameter_annotations"> </td>
 
810
</tr>
 
811
<tr>
 
812
<td class="parameter_name"><p>access_token_secret</p></td>
 
813
<td class="parameter_description"><p>The valid secret for <em class="parameter"><code>access_token</code></em>
 
814
.</p></td>
 
815
<td class="parameter_annotations"> </td>
 
816
</tr>
 
817
<tr>
 
818
<td class="parameter_name"><p>out_presentation_identity</p></td>
 
819
<td class="parameter_description"><p> Return location for presentation identity or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
 
820
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
 
821
</tr>
 
822
<tr>
 
823
<td class="parameter_name"><p>cancellable</p></td>
 
824
<td class="parameter_description"><p> A <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
 
825
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
 
826
</tr>
 
827
<tr>
 
828
<td class="parameter_name"><p>error</p></td>
 
829
<td class="parameter_description"><p>Return location for error or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
 
830
<td class="parameter_annotations"> </td>
 
831
</tr>
 
832
</tbody>
 
833
</table></div>
 
834
</div>
 
835
<div class="refsect3">
 
836
<a name="id-1.5.2.5.7.17.9"></a><h4>Returns</h4>
 
837
<p> The identity or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if error is set. The returned string
 
838
must be freed with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>.</p>
 
839
<p></p>
 
840
</div>
 
841
</div>
 
842
<hr>
 
843
<div class="refsect2">
 
844
<a name="goa-oauth-provider-get-access-token-sync"></a><h3>goa_oauth_provider_get_access_token_sync ()</h3>
 
845
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
846
goa_oauth_provider_get_access_token_sync
 
847
                               (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>,
 
848
                                <em class="parameter"><code><a class="link" href="GoaObject.html" title="GoaObject"><span class="type">GoaObject</span></a> *object</code></em>,
 
849
                                <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> force_refresh</code></em>,
 
850
                                <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **out_access_token_secret</code></em>,
 
851
                                <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *out_access_token_expires_in</code></em>,
 
852
                                <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
853
                                <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
854
<p>Synchronously gets an access token for <em class="parameter"><code>object</code></em>
 
855
. The calling thread
 
856
is blocked while the operation is pending.</p>
 
857
<p>The resulting token is typically read from the local cache so most
 
858
of the time only a local roundtrip to the storage for the token
 
859
cache (e.g. <span class="command"><strong>gnome-keyring-daemon</strong></span>) is
 
860
needed. However, the operation may involve refreshing the token
 
861
with the service provider so a full network round-trip may be
 
862
needed.</p>
 
863
<p>Note that multiple calls are serialized to avoid multiple
 
864
outstanding requests to the service provider.</p>
 
865
<p>This operation may fail if e.g. unable to refresh the credentials
 
866
or if network connectivity is not available. Note that even if a
 
867
token is returned, the returned token isn't guaranteed to work -
 
868
use <a class="link" href="GoaProvider.html#goa-provider-ensure-credentials-sync" title="goa_provider_ensure_credentials_sync ()"><code class="function">goa_provider_ensure_credentials_sync()</code></a> if you need
 
869
stronger guarantees.</p>
 
870
<div class="refsect3">
 
871
<a name="id-1.5.2.5.7.18.8"></a><h4>Parameters</h4>
 
872
<div class="informaltable"><table width="100%" border="0">
 
873
<colgroup>
 
874
<col width="150px" class="parameters_name">
 
875
<col class="parameters_description">
 
876
<col width="200px" class="parameters_annotations">
 
877
</colgroup>
 
878
<tbody>
 
879
<tr>
 
880
<td class="parameter_name"><p>provider</p></td>
 
881
<td class="parameter_description"><p>A <a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a>.</p></td>
 
882
<td class="parameter_annotations"> </td>
 
883
</tr>
 
884
<tr>
 
885
<td class="parameter_name"><p>object</p></td>
 
886
<td class="parameter_description"><p>A <a class="link" href="GoaObject.html" title="GoaObject"><span class="type">GoaObject</span></a>.</p></td>
 
887
<td class="parameter_annotations"> </td>
 
888
</tr>
 
889
<tr>
 
890
<td class="parameter_name"><p>force_refresh</p></td>
 
891
<td class="parameter_description"><p>If set to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, forces a refresh of the access token, if possible.</p></td>
 
892
<td class="parameter_annotations"> </td>
 
893
</tr>
 
894
<tr>
 
895
<td class="parameter_name"><p>out_access_token_secret</p></td>
 
896
<td class="parameter_description"><p> The secret for the return access token. </p></td>
 
897
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
 
898
</tr>
 
899
<tr>
 
900
<td class="parameter_name"><p>out_access_token_expires_in</p></td>
 
901
<td class="parameter_description"><p> Return location for how many seconds the returned token is valid for (0 if unknown) or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
 
902
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
 
903
</tr>
 
904
<tr>
 
905
<td class="parameter_name"><p>cancellable</p></td>
 
906
<td class="parameter_description"><p> A <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
 
907
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
 
908
</tr>
 
909
<tr>
 
910
<td class="parameter_name"><p>error</p></td>
 
911
<td class="parameter_description"><p>Return location for error or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
 
912
<td class="parameter_annotations"> </td>
 
913
</tr>
 
914
</tbody>
 
915
</table></div>
 
916
</div>
 
917
<div class="refsect3">
 
918
<a name="id-1.5.2.5.7.18.9"></a><h4>Returns</h4>
 
919
<p> The access token or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if error is set. The returned
 
920
string must be freed with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>.</p>
 
921
<p></p>
 
922
</div>
 
923
</div>
 
924
<hr>
 
925
<div class="refsect2">
 
926
<a name="goa-oauth-provider-parse-request-token-error"></a><h3>goa_oauth_provider_parse_request_token_error ()</h3>
 
927
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
928
goa_oauth_provider_parse_request_token_error
 
929
                               (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>,
 
930
                                <em class="parameter"><code><a href="/usr/share/gtk-doc/html/rest/RestProxyCall.html"><span class="type">RestProxyCall</span></a> *call</code></em>);</pre>
 
931
<p>Tries to parse the headers and payload within <em class="parameter"><code>call</code></em>
 
932
 to provide a
 
933
human readable error message in case the request token could not
 
934
be fetched.</p>
 
935
<p>This is a pure virtual method - a subclass must provide an
 
936
implementation.</p>
 
937
<div class="refsect3">
 
938
<a name="id-1.5.2.5.7.19.6"></a><h4>Parameters</h4>
 
939
<div class="informaltable"><table width="100%" border="0">
 
940
<colgroup>
 
941
<col width="150px" class="parameters_name">
 
942
<col class="parameters_description">
 
943
<col width="200px" class="parameters_annotations">
 
944
</colgroup>
 
945
<tbody>
 
946
<tr>
 
947
<td class="parameter_name"><p>provider</p></td>
 
948
<td class="parameter_description"><p>A <a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a>.</p></td>
 
949
<td class="parameter_annotations"> </td>
 
950
</tr>
 
951
<tr>
 
952
<td class="parameter_name"><p>call</p></td>
 
953
<td class="parameter_description"><p>The <a href="/usr/share/gtk-doc/html/rest/RestProxyCall.html"><span class="type">RestProxyCall</span></a> that was used to fetch the request token.</p></td>
 
954
<td class="parameter_annotations"> </td>
 
955
</tr>
 
956
</tbody>
 
957
</table></div>
 
958
</div>
 
959
<div class="refsect3">
 
960
<a name="id-1.5.2.5.7.19.7"></a><h4>Returns</h4>
 
961
<p> A human readable error message or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the cause of the
 
962
error could not be determined. The returned string must be freed with
 
963
<a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>.</p>
 
964
<p></p>
 
965
</div>
 
966
</div>
 
967
</div>
 
968
<div class="refsect1">
 
969
<a name="GoaOAuthProvider.other_details"></a><h2>Types and Values</h2>
137
970
<div class="refsect2">
138
971
<a name="GoaOAuthProvider-struct"></a><h3>struct GoaOAuthProvider</h3>
139
972
<pre class="programlisting">struct GoaOAuthProvider;</pre>
140
 
<p>
141
 
The <a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> structure contains only private data and should
142
 
only be accessed using the provided API.
143
 
</p>
 
973
<p>The <a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> structure contains only private data and should
 
974
only be accessed using the provided API.</p>
144
975
</div>
145
976
<hr>
146
977
<div class="refsect2">
188
1019
                                                WebKitDOMHTMLInputElement    *element);
189
1020
};
190
1021
</pre>
191
 
<p>
192
 
Class structure for <a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a>.
193
 
</p>
194
 
<div class="variablelist"><table border="0" class="variablelist">
195
 
<colgroup>
196
 
<col align="left" valign="top">
197
 
<col>
198
 
</colgroup>
199
 
<tbody>
200
 
<tr>
201
 
<td><p><span class="term"><a class="link" href="GoaProvider.html#GoaProviderClass" title="struct GoaProviderClass"><span class="type">GoaProviderClass</span></a> <em class="structfield"><code><a name="GoaOAuthProviderClass.parent-class"></a>parent_class</code></em>;</span></p></td>
202
 
<td>The parent class.</td>
203
 
</tr>
204
 
<tr>
205
 
<td><p><span class="term"><em class="structfield"><code><a name="GoaOAuthProviderClass.get-consumer-key"></a>get_consumer_key</code></em> ()</span></p></td>
206
 
<td>Virtual function for <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-consumer-key" title="goa_oauth_provider_get_consumer_key ()"><code class="function">goa_oauth_provider_get_consumer_key()</code></a>.</td>
207
 
</tr>
208
 
<tr>
209
 
<td><p><span class="term"><em class="structfield"><code><a name="GoaOAuthProviderClass.get-consumer-secret"></a>get_consumer_secret</code></em> ()</span></p></td>
210
 
<td>Virtual function for <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-consumer-secret" title="goa_oauth_provider_get_consumer_secret ()"><code class="function">goa_oauth_provider_get_consumer_secret()</code></a>.</td>
211
 
</tr>
212
 
<tr>
213
 
<td><p><span class="term"><em class="structfield"><code><a name="GoaOAuthProviderClass.get-request-uri"></a>get_request_uri</code></em> ()</span></p></td>
214
 
<td>Virtual function for <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-request-uri" title="goa_oauth_provider_get_request_uri ()"><code class="function">goa_oauth_provider_get_request_uri()</code></a>.</td>
215
 
</tr>
216
 
<tr>
217
 
<td><p><span class="term"><em class="structfield"><code><a name="GoaOAuthProviderClass.get-authorization-uri"></a>get_authorization_uri</code></em> ()</span></p></td>
218
 
<td>Virtual function for <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-authorization-uri" title="goa_oauth_provider_get_authorization_uri ()"><code class="function">goa_oauth_provider_get_authorization_uri()</code></a>.</td>
219
 
</tr>
220
 
<tr>
221
 
<td><p><span class="term"><em class="structfield"><code><a name="GoaOAuthProviderClass.get-token-uri"></a>get_token_uri</code></em> ()</span></p></td>
222
 
<td>Virtual function for <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-token-uri" title="goa_oauth_provider_get_token_uri ()"><code class="function">goa_oauth_provider_get_token_uri()</code></a>.</td>
223
 
</tr>
224
 
<tr>
225
 
<td><p><span class="term"><em class="structfield"><code><a name="GoaOAuthProviderClass.get-callback-uri"></a>get_callback_uri</code></em> ()</span></p></td>
226
 
<td>Virtual function for <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-callback-uri" title="goa_oauth_provider_get_callback_uri ()"><code class="function">goa_oauth_provider_get_callback_uri()</code></a>.</td>
227
 
</tr>
228
 
<tr>
229
 
<td><p><span class="term"><em class="structfield"><code><a name="GoaOAuthProviderClass.get-authentication-cookie"></a>get_authentication_cookie</code></em> ()</span></p></td>
230
 
<td>Virtual function for <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-authentication-cookie" title="goa_oauth_provider_get_authentication_cookie ()"><code class="function">goa_oauth_provider_get_authentication_cookie()</code></a>.</td>
231
 
</tr>
232
 
<tr>
233
 
<td><p><span class="term"><em class="structfield"><code><a name="GoaOAuthProviderClass.get-identity-sync"></a>get_identity_sync</code></em> ()</span></p></td>
234
 
<td>Virtual function for <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-identity-sync" title="goa_oauth_provider_get_identity_sync ()"><code class="function">goa_oauth_provider_get_identity_sync()</code></a>.</td>
235
 
</tr>
236
 
<tr>
237
 
<td><p><span class="term"><em class="structfield"><code><a name="GoaOAuthProviderClass.parse-request-token-error"></a>parse_request_token_error</code></em> ()</span></p></td>
238
 
<td>Virtual function for <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-parse-request-token-error" title="goa_oauth_provider_parse_request_token_error ()"><code class="function">goa_oauth_provider_parse_request_token_error()</code></a>.</td>
239
 
</tr>
240
 
<tr>
241
 
<td><p><span class="term"><em class="structfield"><code><a name="GoaOAuthProviderClass.build-authorization-uri"></a>build_authorization_uri</code></em> ()</span></p></td>
242
 
<td>Virtual function for <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-build-authorization-uri" title="goa_oauth_provider_build_authorization_uri ()"><code class="function">goa_oauth_provider_build_authorization_uri()</code></a>.</td>
243
 
</tr>
244
 
<tr>
245
 
<td><p><span class="term"><em class="structfield"><code><a name="GoaOAuthProviderClass.get-use-external-browser"></a>get_use_external_browser</code></em> ()</span></p></td>
246
 
<td>Virtual function for <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-use-external-browser" title="goa_oauth_provider_get_use_external_browser ()"><code class="function">goa_oauth_provider_get_use_external_browser()</code></a>.</td>
247
 
</tr>
248
 
<tr>
249
 
<td><p><span class="term"><em class="structfield"><code><a name="GoaOAuthProviderClass.get-use-mobile-browser"></a>get_use_mobile_browser</code></em> ()</span></p></td>
250
 
<td>Virtual function for <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-use-mobile-browser" title="goa_oauth_provider_get_use_mobile_browser ()"><code class="function">goa_oauth_provider_get_use_mobile_browser()</code></a>.</td>
251
 
</tr>
252
 
<tr>
253
 
<td><p><span class="term"><em class="structfield"><code><a name="GoaOAuthProviderClass.get-request-uri-params"></a>get_request_uri_params</code></em> ()</span></p></td>
254
 
<td>Virtual function for <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-request-uri-params" title="goa_oauth_provider_get_request_uri_params ()"><code class="function">goa_oauth_provider_get_request_uri_params()</code></a>.</td>
255
 
</tr>
256
 
<tr>
257
 
<td><p><span class="term"><em class="structfield"><code><a name="GoaOAuthProviderClass.add-account-key-values"></a>add_account_key_values</code></em> ()</span></p></td>
258
 
<td>Virtual function for <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-add-account-key-values" title="goa_oauth_provider_add_account_key_values ()"><code class="function">goa_oauth_provider_add_account_key_values()</code></a>.</td>
259
 
</tr>
260
 
<tr>
261
 
<td><p><span class="term"><em class="structfield"><code><a name="GoaOAuthProviderClass.is-deny-node"></a>is_deny_node</code></em> ()</span></p></td>
262
 
<td>Virtual function for <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-is-deny-node" title="goa_oauth_provider_is_deny_node ()"><code class="function">goa_oauth_provider_is_deny_node()</code></a>.</td>
263
 
</tr>
264
 
<tr>
265
 
<td><p><span class="term"><em class="structfield"><code><a name="GoaOAuthProviderClass.is-identity-node"></a>is_identity_node</code></em> ()</span></p></td>
266
 
<td>Virtual function for <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-is-identity-node" title="goa_oauth_provider_is_identity_node ()"><code class="function">goa_oauth_provider_is_identity_node()</code></a>.</td>
267
 
</tr>
268
 
<tr>
269
 
<td><p><span class="term"><em class="structfield"><code><a name="GoaOAuthProviderClass.is-password-node"></a>is_password_node</code></em> ()</span></p></td>
270
 
<td>Virtual function for <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-is-password-node" title="goa_oauth_provider_is_password_node ()"><code class="function">goa_oauth_provider_is_password_node()</code></a>.</td>
271
 
</tr>
272
 
</tbody>
273
 
</table></div>
274
 
</div>
275
 
<hr>
276
 
<div class="refsect2">
277
 
<a name="goa-oauth-provider-get-authentication-cookie"></a><h3>goa_oauth_provider_get_authentication_cookie ()</h3>
278
 
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       goa_oauth_provider_get_authentication_cookie
279
 
                                                        (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>);</pre>
280
 
<p>
281
 
Gets the name of a cookie whose presence indicates that the user has been able to
282
 
log in during the authorization step. This is used to modify the embedded web
283
 
browser UI that is presented to the user.
284
 
</p>
285
 
<p>
286
 
This is a pure virtual method - a subclass must provide an
287
 
implementation.
288
 
</p>
289
 
<div class="variablelist"><table border="0" class="variablelist">
290
 
<colgroup>
291
 
<col align="left" valign="top">
292
 
<col>
293
 
</colgroup>
294
 
<tbody>
295
 
<tr>
296
 
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
297
 
<td>A <a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a>.</td>
298
 
</tr>
299
 
<tr>
300
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
301
 
<td>A string owned by <em class="parameter"><code>provider</code></em> - do not free. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
302
 
</td>
303
 
</tr>
304
 
</tbody>
305
 
</table></div>
306
 
</div>
307
 
<hr>
308
 
<div class="refsect2">
309
 
<a name="goa-oauth-provider-get-request-uri"></a><h3>goa_oauth_provider_get_request_uri ()</h3>
310
 
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       goa_oauth_provider_get_request_uri  (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>);</pre>
311
 
<p>
312
 
Gets the request uri.
313
 
</p>
314
 
<p>
315
 
http://tools.ietf.org/html/rfc5849<span class="type">section-2.1</span>
316
 
</p>
317
 
<p>
318
 
This is a pure virtual method - a subclass must provide an
319
 
implementation.
320
 
</p>
321
 
<div class="variablelist"><table border="0" class="variablelist">
322
 
<colgroup>
323
 
<col align="left" valign="top">
324
 
<col>
325
 
</colgroup>
326
 
<tbody>
327
 
<tr>
328
 
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
329
 
<td>A <a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a>.</td>
330
 
</tr>
331
 
<tr>
332
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
333
 
<td>A string owned by <em class="parameter"><code>provider</code></em> - do not free. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
334
 
</td>
335
 
</tr>
336
 
</tbody>
337
 
</table></div>
338
 
</div>
339
 
<hr>
340
 
<div class="refsect2">
341
 
<a name="goa-oauth-provider-get-request-uri-params"></a><h3>goa_oauth_provider_get_request_uri_params ()</h3>
342
 
<pre class="programlisting"><span class="returnvalue">gchar</span> **            goa_oauth_provider_get_request_uri_params
343
 
                                                        (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>);</pre>
344
 
<p>
345
 
Gets additional parameters for the request URI.
346
 
</p>
347
 
<p>
348
 
http://tools.ietf.org/html/rfc5849<span class="type">section-2.1</span>
349
 
</p>
350
 
<p>
351
 
This is a virtual method where the default implementation returns
352
 
<code class="literal">NULL</code>.
353
 
</p>
354
 
<div class="variablelist"><table border="0" class="variablelist">
355
 
<colgroup>
356
 
<col align="left" valign="top">
357
 
<col>
358
 
</colgroup>
359
 
<tbody>
360
 
<tr>
361
 
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
362
 
<td>A <a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a>.</td>
363
 
</tr>
364
 
<tr>
365
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
366
 
<td>
367
 
<code class="literal">NULL</code> (for no parameters) or a
368
 
<code class="literal">NULL</code>-terminated array of (key, value) pairs that will be added to
369
 
the URI. The caller will free the returned value with <code class="function">g_strfreev()</code>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
370
 
</td>
371
 
</tr>
372
 
</tbody>
373
 
</table></div>
374
 
</div>
375
 
<hr>
376
 
<div class="refsect2">
377
 
<a name="goa-oauth-provider-get-authorization-uri"></a><h3>goa_oauth_provider_get_authorization_uri ()</h3>
378
 
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       goa_oauth_provider_get_authorization_uri
379
 
                                                        (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>);</pre>
380
 
<p>
381
 
Gets the authorization uri.
382
 
</p>
383
 
<p>
384
 
http://tools.ietf.org/html/rfc5849<span class="type">section-2.2</span>
385
 
</p>
386
 
<p>
387
 
This is a pure virtual method - a subclass must provide an
388
 
implementation.
389
 
</p>
390
 
<div class="variablelist"><table border="0" class="variablelist">
391
 
<colgroup>
392
 
<col align="left" valign="top">
393
 
<col>
394
 
</colgroup>
395
 
<tbody>
396
 
<tr>
397
 
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
398
 
<td>A <a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a>.</td>
399
 
</tr>
400
 
<tr>
401
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
402
 
<td>A string owned by <em class="parameter"><code>provider</code></em> - do not free. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
403
 
</td>
404
 
</tr>
405
 
</tbody>
406
 
</table></div>
407
 
</div>
408
 
<hr>
409
 
<div class="refsect2">
410
 
<a name="goa-oauth-provider-get-token-uri"></a><h3>goa_oauth_provider_get_token_uri ()</h3>
411
 
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       goa_oauth_provider_get_token_uri    (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>);</pre>
412
 
<p>
413
 
Gets the token uri.
414
 
</p>
415
 
<p>
416
 
http://tools.ietf.org/html/rfc5849<span class="type">section-2.3</span>
417
 
</p>
418
 
<p>
419
 
This is a pure virtual method - a subclass must provide an
420
 
implementation.
421
 
</p>
422
 
<div class="variablelist"><table border="0" class="variablelist">
423
 
<colgroup>
424
 
<col align="left" valign="top">
425
 
<col>
426
 
</colgroup>
427
 
<tbody>
428
 
<tr>
429
 
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
430
 
<td>A <a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a>.</td>
431
 
</tr>
432
 
<tr>
433
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
434
 
<td>A string owned by <em class="parameter"><code>provider</code></em> - do not free. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
435
 
</td>
436
 
</tr>
437
 
</tbody>
438
 
</table></div>
439
 
</div>
440
 
<hr>
441
 
<div class="refsect2">
442
 
<a name="goa-oauth-provider-get-callback-uri"></a><h3>goa_oauth_provider_get_callback_uri ()</h3>
443
 
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       goa_oauth_provider_get_callback_uri (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>);</pre>
444
 
<p>
445
 
Gets the callback uri.
446
 
</p>
447
 
<p>
448
 
http://tools.ietf.org/html/rfc5849<span class="type">section-2.1</span>
449
 
</p>
450
 
<p>
451
 
This is a pure virtual method - a subclass must provide an
452
 
implementation.
453
 
</p>
454
 
<div class="variablelist"><table border="0" class="variablelist">
455
 
<colgroup>
456
 
<col align="left" valign="top">
457
 
<col>
458
 
</colgroup>
459
 
<tbody>
460
 
<tr>
461
 
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
462
 
<td>A <a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a>.</td>
463
 
</tr>
464
 
<tr>
465
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
466
 
<td>A string owned by <em class="parameter"><code>provider</code></em> - do not free. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
467
 
</td>
468
 
</tr>
469
 
</tbody>
470
 
</table></div>
471
 
</div>
472
 
<hr>
473
 
<div class="refsect2">
474
 
<a name="goa-oauth-provider-get-consumer-key"></a><h3>goa_oauth_provider_get_consumer_key ()</h3>
475
 
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       goa_oauth_provider_get_consumer_key (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>);</pre>
476
 
<p>
477
 
Gets the consumer key identifying the client.
478
 
</p>
479
 
<p>
480
 
This is a pure virtual method - a subclass must provide an
481
 
implementation.
482
 
</p>
483
 
<div class="variablelist"><table border="0" class="variablelist">
484
 
<colgroup>
485
 
<col align="left" valign="top">
486
 
<col>
487
 
</colgroup>
488
 
<tbody>
489
 
<tr>
490
 
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
491
 
<td>A <a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a>.</td>
492
 
</tr>
493
 
<tr>
494
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
495
 
<td>A string owned by <em class="parameter"><code>provider</code></em> - do not free. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
496
 
</td>
497
 
</tr>
498
 
</tbody>
499
 
</table></div>
500
 
</div>
501
 
<hr>
502
 
<div class="refsect2">
503
 
<a name="goa-oauth-provider-get-consumer-secret"></a><h3>goa_oauth_provider_get_consumer_secret ()</h3>
504
 
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       goa_oauth_provider_get_consumer_secret
505
 
                                                        (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>);</pre>
506
 
<p>
507
 
Gets the consumer secret identifying the client.
508
 
</p>
509
 
<p>
510
 
This is a pure virtual method - a subclass must provide an
511
 
implementation.
512
 
</p>
513
 
<div class="variablelist"><table border="0" class="variablelist">
514
 
<colgroup>
515
 
<col align="left" valign="top">
516
 
<col>
517
 
</colgroup>
518
 
<tbody>
519
 
<tr>
520
 
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
521
 
<td>A <a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a>.</td>
522
 
</tr>
523
 
<tr>
524
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
525
 
<td>A string owned by <em class="parameter"><code>provider</code></em> - do not free. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
526
 
</td>
527
 
</tr>
528
 
</tbody>
529
 
</table></div>
530
 
</div>
531
 
<hr>
532
 
<div class="refsect2">
533
 
<a name="goa-oauth-provider-build-authorization-uri"></a><h3>goa_oauth_provider_build_authorization_uri ()</h3>
534
 
<pre class="programlisting"><span class="returnvalue">gchar</span> *             goa_oauth_provider_build_authorization_uri
535
 
                                                        (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>,
536
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *authorization_uri</code></em>,
537
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *escaped_oauth_token</code></em>);</pre>
538
 
<p>
539
 
Builds the URI that can be opened in a web browser (or embedded web
540
 
browser widget) to start authenticating an user.
541
 
</p>
542
 
<p>
543
 
The default implementation just returns the expected URI
544
 
(e.g. <code class="literal">http://example.com/dialog/oauth?auth_token=1234567890</code>)
545
 
</p>
546
 
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>override (and chain up) if you e.g. need to to pass additional
547
 
parameters.</p></li></ul></div>
548
 
<p>
549
 
</p>
550
 
<p>
551
 
The <em class="parameter"><code>authorization_uri</code></em> parameter originate from the result of the
552
 
the <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-authorization-uri" title="goa_oauth_provider_get_authorization_uri ()"><code class="function">goa_oauth_provider_get_authorization_uri()</code></a> method. The
553
 
<em class="parameter"><code>escaped_oauth_token</code></em> parameter is the temporary credentials identifier
554
 
escaped using <code class="function">g_uri_escape_string()</code>.
555
 
</p>
556
 
<div class="variablelist"><table border="0" class="variablelist">
557
 
<colgroup>
558
 
<col align="left" valign="top">
559
 
<col>
560
 
</colgroup>
561
 
<tbody>
562
 
<tr>
563
 
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
564
 
<td>A <a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a>.</td>
565
 
</tr>
566
 
<tr>
567
 
<td><p><span class="term"><em class="parameter"><code>authorization_uri</code></em> :</span></p></td>
568
 
<td>An authorization URI.</td>
569
 
</tr>
570
 
<tr>
571
 
<td><p><span class="term"><em class="parameter"><code>escaped_oauth_token</code></em> :</span></p></td>
572
 
<td>An escaped oauth token.</td>
573
 
</tr>
574
 
<tr>
575
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
576
 
<td>An authorization URI that must be freed with <code class="function">g_free()</code>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
577
 
</td>
578
 
</tr>
579
 
</tbody>
580
 
</table></div>
581
 
</div>
582
 
<hr>
583
 
<div class="refsect2">
584
 
<a name="goa-oauth-provider-get-use-external-browser"></a><h3>goa_oauth_provider_get_use_external_browser ()</h3>
585
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            goa_oauth_provider_get_use_external_browser
586
 
                                                        (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>);</pre>
587
 
<p>
588
 
Returns whether an external browser (the users default browser)
589
 
should be used for user interaction.
590
 
</p>
591
 
<p>
592
 
If an external browser is used, then the dialogs presented in
593
 
<a class="link" href="GoaProvider.html#goa-provider-add-account" title="goa_provider_add_account ()"><code class="function">goa_provider_add_account()</code></a> and
594
 
<a class="link" href="GoaProvider.html#goa-provider-refresh-account" title="goa_provider_refresh_account ()"><code class="function">goa_provider_refresh_account()</code></a> will show a simple "Paste
595
 
authorization code here" instructions along with an entry and
596
 
button.
597
 
</p>
598
 
<p>
599
 
This is a virtual method where the default implementation returns
600
 
<code class="literal">FALSE</code>.
601
 
</p>
602
 
<div class="variablelist"><table border="0" class="variablelist">
603
 
<colgroup>
604
 
<col align="left" valign="top">
605
 
<col>
606
 
</colgroup>
607
 
<tbody>
608
 
<tr>
609
 
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
610
 
<td>A <a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a>.</td>
611
 
</tr>
612
 
<tr>
613
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
614
 
<td>
615
 
<code class="literal">TRUE</code> if the user interaction should happen in an external
616
 
browser, <code class="literal">FALSE</code> to use an embedded browser widget.</td>
617
 
</tr>
618
 
</tbody>
619
 
</table></div>
620
 
</div>
621
 
<hr>
622
 
<div class="refsect2">
623
 
<a name="goa-oauth-provider-get-use-mobile-browser"></a><h3>goa_oauth_provider_get_use_mobile_browser ()</h3>
624
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            goa_oauth_provider_get_use_mobile_browser
625
 
                                                        (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>);</pre>
626
 
<p>
627
 
Returns whether there is a need for the embedded browser to identify
628
 
itself as running on a mobile phone in order to get a more compact
629
 
version of the approval page.
630
 
</p>
631
 
<p>
632
 
This is a virtual method where the default implementation returns
633
 
<code class="literal">FALSE</code>.
634
 
</p>
635
 
<div class="variablelist"><table border="0" class="variablelist">
636
 
<colgroup>
637
 
<col align="left" valign="top">
638
 
<col>
639
 
</colgroup>
640
 
<tbody>
641
 
<tr>
642
 
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
643
 
<td>A <a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a>.</td>
644
 
</tr>
645
 
<tr>
646
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
647
 
<td>
648
 
<code class="literal">TRUE</code> if the embedded browser should identify itself as
649
 
running on a mobile platform, <code class="literal">FALSE</code> otherwise.</td>
650
 
</tr>
651
 
</tbody>
652
 
</table></div>
653
 
</div>
654
 
<hr>
655
 
<div class="refsect2">
656
 
<a name="goa-oauth-provider-is-deny-node"></a><h3>goa_oauth_provider_is_deny_node ()</h3>
657
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            goa_oauth_provider_is_deny_node     (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>,
658
 
                                                         <em class="parameter"><code><span class="type">WebKitDOMNode</span> *node</code></em>);</pre>
659
 
<p>
660
 
Checks whether <em class="parameter"><code>node</code></em> is the HTML UI element that the user can use
661
 
to deny permission to access his account. Usually they are either a
662
 
WebKitDOMHTMLButtonElement or a WebKitDOMHTMLInputElement.
663
 
</p>
664
 
<p>
665
 
Please note that providers may have multiple such elements in their
666
 
UI and this method should catch all of them.
667
 
</p>
668
 
<p>
669
 
This is a pure virtual method - a subclass must provide an
670
 
implementation.
671
 
</p>
672
 
<div class="variablelist"><table border="0" class="variablelist">
673
 
<colgroup>
674
 
<col align="left" valign="top">
675
 
<col>
676
 
</colgroup>
677
 
<tbody>
678
 
<tr>
679
 
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
680
 
<td>A <a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a>.</td>
681
 
</tr>
682
 
<tr>
683
 
<td><p><span class="term"><em class="parameter"><code>node</code></em> :</span></p></td>
684
 
<td>A WebKitDOMNode.</td>
685
 
</tr>
686
 
<tr>
687
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
688
 
<td>
689
 
<code class="literal">TRUE</code> if the <em class="parameter"><code>node</code></em> can be used to deny permission.</td>
690
 
</tr>
691
 
</tbody>
692
 
</table></div>
693
 
</div>
694
 
<hr>
695
 
<div class="refsect2">
696
 
<a name="goa-oauth-provider-is-identity-node"></a><h3>goa_oauth_provider_is_identity_node ()</h3>
697
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            goa_oauth_provider_is_identity_node (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>,
698
 
                                                         <em class="parameter"><code><span class="type">WebKitDOMHTMLInputElement</span> *element</code></em>);</pre>
699
 
<p>
700
 
Checks whether <em class="parameter"><code>element</code></em> is the HTML UI element that the user can
701
 
use to identify herself at the provider.
702
 
</p>
703
 
<p>
704
 
This is a pure virtual method - a subclass must provide an
705
 
implementation.
706
 
</p>
707
 
<div class="variablelist"><table border="0" class="variablelist">
708
 
<colgroup>
709
 
<col align="left" valign="top">
710
 
<col>
711
 
</colgroup>
712
 
<tbody>
713
 
<tr>
714
 
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
715
 
<td>A <a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a>.</td>
716
 
</tr>
717
 
<tr>
718
 
<td><p><span class="term"><em class="parameter"><code>element</code></em> :</span></p></td>
719
 
<td>A WebKitDOMHTMLInputElement.</td>
720
 
</tr>
721
 
<tr>
722
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
723
 
<td>
724
 
<code class="literal">TRUE</code> if the <em class="parameter"><code>element</code></em> can be used to deny permission.</td>
725
 
</tr>
726
 
</tbody>
727
 
</table></div>
728
 
</div>
729
 
<hr>
730
 
<div class="refsect2">
731
 
<a name="goa-oauth-provider-is-password-node"></a><h3>goa_oauth_provider_is_password_node ()</h3>
732
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            goa_oauth_provider_is_password_node (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>,
733
 
                                                         <em class="parameter"><code><span class="type">WebKitDOMHTMLInputElement</span> *element</code></em>);</pre>
734
 
<p>
735
 
Checks whether <em class="parameter"><code>element</code></em> is the HTML UI element that the user can
736
 
use to enter her password.
737
 
</p>
738
 
<p>
739
 
This is a virtual method where the default implementation returns
740
 
<code class="literal">FALSE</code>.
741
 
</p>
742
 
<div class="variablelist"><table border="0" class="variablelist">
743
 
<colgroup>
744
 
<col align="left" valign="top">
745
 
<col>
746
 
</colgroup>
747
 
<tbody>
748
 
<tr>
749
 
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
750
 
<td>A <a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a>.</td>
751
 
</tr>
752
 
<tr>
753
 
<td><p><span class="term"><em class="parameter"><code>element</code></em> :</span></p></td>
754
 
<td>A WebKitDOMHTMLInputElement</td>
755
 
</tr>
756
 
<tr>
757
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
758
 
<td>
759
 
<code class="literal">TRUE</code> if <em class="parameter"><code>element</code></em> can be used to enter the password.</td>
760
 
</tr>
761
 
</tbody>
762
 
</table></div>
763
 
</div>
764
 
<hr>
765
 
<div class="refsect2">
766
 
<a name="goa-oauth-provider-add-account-key-values"></a><h3>goa_oauth_provider_add_account_key_values ()</h3>
767
 
<pre class="programlisting"><span class="returnvalue">void</span>                goa_oauth_provider_add_account_key_values
768
 
                                                        (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>,
769
 
                                                         <em class="parameter"><code><span class="type">GVariantBuilder</span> *builder</code></em>);</pre>
770
 
<p>
771
 
Hook for implementations to add key/value pairs to the key-file
772
 
when creating an account.
773
 
</p>
774
 
<p>
775
 
This is a virtual method where the default implementation does nothing.
776
 
</p>
777
 
<div class="variablelist"><table border="0" class="variablelist">
778
 
<colgroup>
779
 
<col align="left" valign="top">
780
 
<col>
781
 
</colgroup>
782
 
<tbody>
783
 
<tr>
784
 
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
785
 
<td>A <a class="link" href="GoaProvider.html" title="GoaProvider"><span class="type">GoaProvider</span></a>.</td>
786
 
</tr>
787
 
<tr>
788
 
<td><p><span class="term"><em class="parameter"><code>builder</code></em> :</span></p></td>
789
 
<td>A <span class="type">GVariantBuilder</span> for a <code class="literal">a{ss}</code> variant.</td>
790
 
</tr>
791
 
</tbody>
792
 
</table></div>
793
 
</div>
794
 
<hr>
795
 
<div class="refsect2">
796
 
<a name="goa-oauth-provider-get-identity-sync"></a><h3>goa_oauth_provider_get_identity_sync ()</h3>
797
 
<pre class="programlisting"><span class="returnvalue">gchar</span> *             goa_oauth_provider_get_identity_sync
798
 
                                                        (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>,
799
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *access_token</code></em>,
800
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *access_token_secret</code></em>,
801
 
                                                         <em class="parameter"><code><span class="type">gchar</span> **out_presentation_identity</code></em>,
802
 
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
803
 
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
804
 
<p>
805
 
Method that returns the identity corresponding to <em class="parameter"><code>access_token</code></em> and
806
 
<em class="parameter"><code>access_token_secret</code></em>.
807
 
</p>
808
 
<p>
809
 
The identity is needed because all authentication happens out of
810
 
band. In addition to the identity, an implementation also returns a
811
 
<span class="emphasis"><em>presentation identity</em></span> that is more suitable
812
 
for presentation (the identity could be a GUID for example).
813
 
</p>
814
 
<p>
815
 
The calling thread is blocked while the identity is obtained.
816
 
</p>
817
 
<p>
818
 
This is a pure virtual method - a subclass must provide an
819
 
implementation.
820
 
</p>
821
 
<div class="variablelist"><table border="0" class="variablelist">
822
 
<colgroup>
823
 
<col align="left" valign="top">
824
 
<col>
825
 
</colgroup>
826
 
<tbody>
827
 
<tr>
828
 
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
829
 
<td>A <a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a>.</td>
830
 
</tr>
831
 
<tr>
832
 
<td><p><span class="term"><em class="parameter"><code>access_token</code></em> :</span></p></td>
833
 
<td>A valid OAuth 1.0 access token.</td>
834
 
</tr>
835
 
<tr>
836
 
<td><p><span class="term"><em class="parameter"><code>access_token_secret</code></em> :</span></p></td>
837
 
<td>The valid secret for <em class="parameter"><code>access_token</code></em>.</td>
838
 
</tr>
839
 
<tr>
840
 
<td><p><span class="term"><em class="parameter"><code>out_presentation_identity</code></em> :</span></p></td>
841
 
<td>Return location for presentation identity or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
842
 
</td>
843
 
</tr>
844
 
<tr>
845
 
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
846
 
<td>A <span class="type">GCancellable</span> or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
847
 
</td>
848
 
</tr>
849
 
<tr>
850
 
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
851
 
<td>Return location for error or <code class="literal">NULL</code>.</td>
852
 
</tr>
853
 
<tr>
854
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
855
 
<td>The identity or <code class="literal">NULL</code> if error is set. The returned string
856
 
must be freed with <code class="function">g_free()</code>.</td>
857
 
</tr>
858
 
</tbody>
859
 
</table></div>
860
 
</div>
861
 
<hr>
862
 
<div class="refsect2">
863
 
<a name="goa-oauth-provider-get-access-token-sync"></a><h3>goa_oauth_provider_get_access_token_sync ()</h3>
864
 
<pre class="programlisting"><span class="returnvalue">gchar</span> *             goa_oauth_provider_get_access_token_sync
865
 
                                                        (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>,
866
 
                                                         <em class="parameter"><code><a class="link" href="GoaObject.html" title="GoaObject"><span class="type">GoaObject</span></a> *object</code></em>,
867
 
                                                         <em class="parameter"><code><span class="type">gboolean</span> force_refresh</code></em>,
868
 
                                                         <em class="parameter"><code><span class="type">gchar</span> **out_access_token_secret</code></em>,
869
 
                                                         <em class="parameter"><code><span class="type">gint</span> *out_access_token_expires_in</code></em>,
870
 
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
871
 
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
872
 
<p>
873
 
Synchronously gets an access token for <em class="parameter"><code>object</code></em>. The calling thread
874
 
is blocked while the operation is pending.
875
 
</p>
876
 
<p>
877
 
The resulting token is typically read from the local cache so most
878
 
of the time only a local roundtrip to the storage for the token
879
 
cache (e.g. <span class="command"><strong>gnome-keyring-daemon</strong></span>) is
880
 
needed. However, the operation may involve refreshing the token
881
 
with the service provider so a full network round-trip may be
882
 
needed.
883
 
</p>
884
 
<p>
885
 
Note that multiple calls are serialized to avoid multiple
886
 
outstanding requests to the service provider.
887
 
</p>
888
 
<p>
889
 
This operation may fail if e.g. unable to refresh the credentials
890
 
or if network connectivity is not available. Note that even if a
891
 
token is returned, the returned token isn't guaranteed to work -
892
 
use <a class="link" href="GoaProvider.html#goa-provider-ensure-credentials-sync" title="goa_provider_ensure_credentials_sync ()"><code class="function">goa_provider_ensure_credentials_sync()</code></a> if you need
893
 
stronger guarantees.
894
 
</p>
895
 
<div class="variablelist"><table border="0" class="variablelist">
896
 
<colgroup>
897
 
<col align="left" valign="top">
898
 
<col>
899
 
</colgroup>
900
 
<tbody>
901
 
<tr>
902
 
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
903
 
<td>A <a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a>.</td>
904
 
</tr>
905
 
<tr>
906
 
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
907
 
<td>A <a class="link" href="GoaObject.html" title="GoaObject"><span class="type">GoaObject</span></a>.</td>
908
 
</tr>
909
 
<tr>
910
 
<td><p><span class="term"><em class="parameter"><code>force_refresh</code></em> :</span></p></td>
911
 
<td>If set to <code class="literal">TRUE</code>, forces a refresh of the access token, if possible.</td>
912
 
</tr>
913
 
<tr>
914
 
<td><p><span class="term"><em class="parameter"><code>out_access_token_secret</code></em> :</span></p></td>
915
 
<td>The secret for the return access token. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
916
 
</td>
917
 
</tr>
918
 
<tr>
919
 
<td><p><span class="term"><em class="parameter"><code>out_access_token_expires_in</code></em> :</span></p></td>
920
 
<td>Return location for how many seconds the returned token is valid for (0 if unknown) or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
921
 
</td>
922
 
</tr>
923
 
<tr>
924
 
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
925
 
<td>A <span class="type">GCancellable</span> or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
926
 
</td>
927
 
</tr>
928
 
<tr>
929
 
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
930
 
<td>Return location for error or <code class="literal">NULL</code>.</td>
931
 
</tr>
932
 
<tr>
933
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
934
 
<td>The access token or <code class="literal">NULL</code> if error is set. The returned
935
 
string must be freed with <code class="function">g_free()</code>.</td>
936
 
</tr>
937
 
</tbody>
938
 
</table></div>
939
 
</div>
940
 
<hr>
941
 
<div class="refsect2">
942
 
<a name="goa-oauth-provider-parse-request-token-error"></a><h3>goa_oauth_provider_parse_request_token_error ()</h3>
943
 
<pre class="programlisting"><span class="returnvalue">gchar</span> *             goa_oauth_provider_parse_request_token_error
944
 
                                                        (<em class="parameter"><code><a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a> *provider</code></em>,
945
 
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/rest/RestProxyCall.html"><span class="type">RestProxyCall</span></a> *call</code></em>);</pre>
946
 
<p>
947
 
Tries to parse the headers and payload within <em class="parameter"><code>call</code></em> to provide a
948
 
human readable error message in case the request token could not
949
 
be fetched.
950
 
</p>
951
 
<p>
952
 
This is a pure virtual method - a subclass must provide an
953
 
implementation.
954
 
</p>
955
 
<div class="variablelist"><table border="0" class="variablelist">
956
 
<colgroup>
957
 
<col align="left" valign="top">
958
 
<col>
959
 
</colgroup>
960
 
<tbody>
961
 
<tr>
962
 
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
963
 
<td>A <a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a>.</td>
964
 
</tr>
965
 
<tr>
966
 
<td><p><span class="term"><em class="parameter"><code>call</code></em> :</span></p></td>
967
 
<td>The <a href="/usr/share/gtk-doc/html/rest/RestProxyCall.html"><span class="type">RestProxyCall</span></a> that was used to fetch the request token.</td>
968
 
</tr>
969
 
<tr>
970
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
971
 
<td>A human readable error message or <code class="literal">NULL</code> if the cause of the
972
 
error could not be determined. The returned string must be freed with
973
 
<code class="function">g_free()</code>.</td>
974
 
</tr>
975
 
</tbody>
976
 
</table></div>
 
1022
<p>Class structure for <a class="link" href="GoaOAuthProvider.html" title="GoaOAuthProvider"><span class="type">GoaOAuthProvider</span></a>.</p>
 
1023
<div class="refsect3">
 
1024
<a name="id-1.5.2.5.8.3.5"></a><h4>Members</h4>
 
1025
<div class="informaltable"><table width="100%" border="0">
 
1026
<colgroup>
 
1027
<col width="300px" class="struct_members_name">
 
1028
<col class="struct_members_description">
 
1029
<col width="200px" class="struct_members_annotations">
 
1030
</colgroup>
 
1031
<tbody>
 
1032
<tr>
 
1033
<td class="struct_member_name"><p><a class="link" href="GoaProvider.html#GoaProviderClass" title="GoaProviderClass"><span class="type">GoaProviderClass</span></a> <em class="structfield"><code><a name="GoaOAuthProviderClass.parent-class"></a>parent_class</code></em>;</p></td>
 
1034
<td class="struct_member_description"><p>The parent class.</p></td>
 
1035
<td class="struct_member_annotations"> </td>
 
1036
</tr>
 
1037
<tr>
 
1038
<td class="struct_member_name"><p><em class="structfield"><code><a name="GoaOAuthProviderClass.get-consumer-key"></a>get_consumer_key</code></em> ()</p></td>
 
1039
<td class="struct_member_description"><p>Virtual function for <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-consumer-key" title="goa_oauth_provider_get_consumer_key ()"><code class="function">goa_oauth_provider_get_consumer_key()</code></a>.</p></td>
 
1040
<td class="struct_member_annotations"> </td>
 
1041
</tr>
 
1042
<tr>
 
1043
<td class="struct_member_name"><p><em class="structfield"><code><a name="GoaOAuthProviderClass.get-consumer-secret"></a>get_consumer_secret</code></em> ()</p></td>
 
1044
<td class="struct_member_description"><p>Virtual function for <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-consumer-secret" title="goa_oauth_provider_get_consumer_secret ()"><code class="function">goa_oauth_provider_get_consumer_secret()</code></a>.</p></td>
 
1045
<td class="struct_member_annotations"> </td>
 
1046
</tr>
 
1047
<tr>
 
1048
<td class="struct_member_name"><p><em class="structfield"><code><a name="GoaOAuthProviderClass.get-request-uri"></a>get_request_uri</code></em> ()</p></td>
 
1049
<td class="struct_member_description"><p>Virtual function for <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-request-uri" title="goa_oauth_provider_get_request_uri ()"><code class="function">goa_oauth_provider_get_request_uri()</code></a>.</p></td>
 
1050
<td class="struct_member_annotations"> </td>
 
1051
</tr>
 
1052
<tr>
 
1053
<td class="struct_member_name"><p><em class="structfield"><code><a name="GoaOAuthProviderClass.get-authorization-uri"></a>get_authorization_uri</code></em> ()</p></td>
 
1054
<td class="struct_member_description"><p>Virtual function for <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-authorization-uri" title="goa_oauth_provider_get_authorization_uri ()"><code class="function">goa_oauth_provider_get_authorization_uri()</code></a>.</p></td>
 
1055
<td class="struct_member_annotations"> </td>
 
1056
</tr>
 
1057
<tr>
 
1058
<td class="struct_member_name"><p><em class="structfield"><code><a name="GoaOAuthProviderClass.get-token-uri"></a>get_token_uri</code></em> ()</p></td>
 
1059
<td class="struct_member_description"><p>Virtual function for <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-token-uri" title="goa_oauth_provider_get_token_uri ()"><code class="function">goa_oauth_provider_get_token_uri()</code></a>.</p></td>
 
1060
<td class="struct_member_annotations"> </td>
 
1061
</tr>
 
1062
<tr>
 
1063
<td class="struct_member_name"><p><em class="structfield"><code><a name="GoaOAuthProviderClass.get-callback-uri"></a>get_callback_uri</code></em> ()</p></td>
 
1064
<td class="struct_member_description"><p>Virtual function for <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-callback-uri" title="goa_oauth_provider_get_callback_uri ()"><code class="function">goa_oauth_provider_get_callback_uri()</code></a>.</p></td>
 
1065
<td class="struct_member_annotations"> </td>
 
1066
</tr>
 
1067
<tr>
 
1068
<td class="struct_member_name"><p><em class="structfield"><code><a name="GoaOAuthProviderClass.get-authentication-cookie"></a>get_authentication_cookie</code></em> ()</p></td>
 
1069
<td class="struct_member_description"><p>Virtual function for <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-authentication-cookie" title="goa_oauth_provider_get_authentication_cookie ()"><code class="function">goa_oauth_provider_get_authentication_cookie()</code></a>.</p></td>
 
1070
<td class="struct_member_annotations"> </td>
 
1071
</tr>
 
1072
<tr>
 
1073
<td class="struct_member_name"><p><em class="structfield"><code><a name="GoaOAuthProviderClass.get-identity-sync"></a>get_identity_sync</code></em> ()</p></td>
 
1074
<td class="struct_member_description"><p>Virtual function for <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-identity-sync" title="goa_oauth_provider_get_identity_sync ()"><code class="function">goa_oauth_provider_get_identity_sync()</code></a>.</p></td>
 
1075
<td class="struct_member_annotations"> </td>
 
1076
</tr>
 
1077
<tr>
 
1078
<td class="struct_member_name"><p><em class="structfield"><code><a name="GoaOAuthProviderClass.parse-request-token-error"></a>parse_request_token_error</code></em> ()</p></td>
 
1079
<td class="struct_member_description"><p>Virtual function for <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-parse-request-token-error" title="goa_oauth_provider_parse_request_token_error ()"><code class="function">goa_oauth_provider_parse_request_token_error()</code></a>.</p></td>
 
1080
<td class="struct_member_annotations"> </td>
 
1081
</tr>
 
1082
<tr>
 
1083
<td class="struct_member_name"><p><em class="structfield"><code><a name="GoaOAuthProviderClass.build-authorization-uri"></a>build_authorization_uri</code></em> ()</p></td>
 
1084
<td class="struct_member_description"><p>Virtual function for <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-build-authorization-uri" title="goa_oauth_provider_build_authorization_uri ()"><code class="function">goa_oauth_provider_build_authorization_uri()</code></a>.</p></td>
 
1085
<td class="struct_member_annotations"> </td>
 
1086
</tr>
 
1087
<tr>
 
1088
<td class="struct_member_name"><p><em class="structfield"><code><a name="GoaOAuthProviderClass.get-use-external-browser"></a>get_use_external_browser</code></em> ()</p></td>
 
1089
<td class="struct_member_description"><p>Virtual function for <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-use-external-browser" title="goa_oauth_provider_get_use_external_browser ()"><code class="function">goa_oauth_provider_get_use_external_browser()</code></a>.</p></td>
 
1090
<td class="struct_member_annotations"> </td>
 
1091
</tr>
 
1092
<tr>
 
1093
<td class="struct_member_name"><p><em class="structfield"><code><a name="GoaOAuthProviderClass.get-use-mobile-browser"></a>get_use_mobile_browser</code></em> ()</p></td>
 
1094
<td class="struct_member_description"><p>Virtual function for <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-use-mobile-browser" title="goa_oauth_provider_get_use_mobile_browser ()"><code class="function">goa_oauth_provider_get_use_mobile_browser()</code></a>.</p></td>
 
1095
<td class="struct_member_annotations"> </td>
 
1096
</tr>
 
1097
<tr>
 
1098
<td class="struct_member_name"><p><em class="structfield"><code><a name="GoaOAuthProviderClass.get-request-uri-params"></a>get_request_uri_params</code></em> ()</p></td>
 
1099
<td class="struct_member_description"><p>Virtual function for <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-get-request-uri-params" title="goa_oauth_provider_get_request_uri_params ()"><code class="function">goa_oauth_provider_get_request_uri_params()</code></a>.</p></td>
 
1100
<td class="struct_member_annotations"> </td>
 
1101
</tr>
 
1102
<tr>
 
1103
<td class="struct_member_name"><p><em class="structfield"><code><a name="GoaOAuthProviderClass.add-account-key-values"></a>add_account_key_values</code></em> ()</p></td>
 
1104
<td class="struct_member_description"><p>Virtual function for <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-add-account-key-values" title="goa_oauth_provider_add_account_key_values ()"><code class="function">goa_oauth_provider_add_account_key_values()</code></a>.</p></td>
 
1105
<td class="struct_member_annotations"> </td>
 
1106
</tr>
 
1107
<tr>
 
1108
<td class="struct_member_name"><p><em class="structfield"><code><a name="GoaOAuthProviderClass.is-deny-node"></a>is_deny_node</code></em> ()</p></td>
 
1109
<td class="struct_member_description"><p>Virtual function for <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-is-deny-node" title="goa_oauth_provider_is_deny_node ()"><code class="function">goa_oauth_provider_is_deny_node()</code></a>.</p></td>
 
1110
<td class="struct_member_annotations"> </td>
 
1111
</tr>
 
1112
<tr>
 
1113
<td class="struct_member_name"><p><em class="structfield"><code><a name="GoaOAuthProviderClass.is-identity-node"></a>is_identity_node</code></em> ()</p></td>
 
1114
<td class="struct_member_description"><p>Virtual function for <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-is-identity-node" title="goa_oauth_provider_is_identity_node ()"><code class="function">goa_oauth_provider_is_identity_node()</code></a>.</p></td>
 
1115
<td class="struct_member_annotations"> </td>
 
1116
</tr>
 
1117
<tr>
 
1118
<td class="struct_member_name"><p><em class="structfield"><code><a name="GoaOAuthProviderClass.is-password-node"></a>is_password_node</code></em> ()</p></td>
 
1119
<td class="struct_member_description"><p>Virtual function for <a class="link" href="GoaOAuthProvider.html#goa-oauth-provider-is-password-node" title="goa_oauth_provider_is_password_node ()"><code class="function">goa_oauth_provider_is_password_node()</code></a>.</p></td>
 
1120
<td class="struct_member_annotations"> </td>
 
1121
</tr>
 
1122
</tbody>
 
1123
</table></div>
 
1124
</div>
977
1125
</div>
978
1126
</div>
979
1127
</div>
980
1128
<div class="footer">
981
1129
<hr>
982
 
          Generated by GTK-Doc V1.19</div>
 
1130
          Generated by GTK-Doc V1.20</div>
983
1131
</body>
984
1132
</html>
 
 
b'\\ No newline at end of file'