8
8
<link rel="up" href="ch07.html" title="Core">
9
9
<link rel="prev" href="goa-Utilities.html" title="Utilities">
10
10
<link rel="next" href="GoaOAuthProvider.html" title="GoaOAuthProvider">
11
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
53
53
<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>);
54
54
<a class="link" href="GoaObject.html" title="GoaObject"><span class="returnvalue">GoaObject</span></a> * <a class="link" href="GoaProvider.html#goa-provider-add-account" title="goa_provider_add_account ()">goa_provider_add_account</a> (<em class="parameter"><code><a class="link" href="GoaProvider.html" title="GoaProvider"><span class="type">GoaProvider</span></a> *provider</code></em>,
55
55
<em class="parameter"><code><a class="link" href="GoaClient.html" title="GoaClient"><span class="type">GoaClient</span></a> *client</code></em>,
56
<em class="parameter"><code><span class="type">GtkDialog</span> *dialog</code></em>,
57
<em class="parameter"><code><span class="type">GtkBox</span> *vbox</code></em>,
56
<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkDialog.html"><span class="type">GtkDialog</span></a> *dialog</code></em>,
57
<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkBox.html"><span class="type">GtkBox</span></a> *vbox</code></em>,
58
58
<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>);
59
59
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GoaProvider.html#goa-provider-refresh-account" title="goa_provider_refresh_account ()">goa_provider_refresh_account</a> (<em class="parameter"><code><a class="link" href="GoaProvider.html" title="GoaProvider"><span class="type">GoaProvider</span></a> *provider</code></em>,
60
60
<em class="parameter"><code><a class="link" href="GoaClient.html" title="GoaClient"><span class="type">GoaClient</span></a> *client</code></em>,
61
61
<em class="parameter"><code><a class="link" href="GoaObject.html" title="GoaObject"><span class="type">GoaObject</span></a> *object</code></em>,
62
<em class="parameter"><code><span class="type">GtkWindow</span> *parent</code></em>,
62
<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkWindow.html"><span class="type">GtkWindow</span></a> *parent</code></em>,
63
63
<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>);
64
64
<span class="returnvalue">void</span> <a class="link" href="GoaProvider.html#goa-provider-show-account" title="goa_provider_show_account ()">goa_provider_show_account</a> (<em class="parameter"><code><a class="link" href="GoaProvider.html" title="GoaProvider"><span class="type">GoaProvider</span></a> *provider</code></em>,
65
65
<em class="parameter"><code><a class="link" href="GoaClient.html" title="GoaClient"><span class="type">GoaClient</span></a> *client</code></em>,
66
66
<em class="parameter"><code><a class="link" href="GoaObject.html" title="GoaObject"><span class="type">GoaObject</span></a> *object</code></em>,
67
<em class="parameter"><code><span class="type">GtkBox</span> *vbox</code></em>,
68
<em class="parameter"><code><span class="type">GtkTable</span> *table</code></em>);
67
<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkBox.html"><span class="type">GtkBox</span></a> *vbox</code></em>,
68
<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkTable.html"><span class="type">GtkTable</span></a> *table</code></em>);
69
69
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GoaProvider.html#goa-provider-store-credentials-sync" title="goa_provider_store_credentials_sync ()">goa_provider_store_credentials_sync</a> (<em class="parameter"><code><a class="link" href="GoaProvider.html" title="GoaProvider"><span class="type">GoaProvider</span></a> *provider</code></em>,
70
70
<em class="parameter"><code><a class="link" href="GoaObject.html" title="GoaObject"><span class="type">GoaObject</span></a> *object</code></em>,
71
71
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *credentials</code></em>,
250
250
Gets a name for <em class="parameter"><code>provider</code></em> and <em class="parameter"><code>object</code></em> that is suitable for display
251
251
in an user interface. The returned value may depend on <em class="parameter"><code>object</code></em> (if
252
it's not <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>) - for example, hosted accounts might return a
252
it's not <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>) - for example, hosted accounts might return a
373
373
<a name="goa-provider-add-account"></a><h3>goa_provider_add_account ()</h3>
374
374
<pre class="programlisting"><a class="link" href="GoaObject.html" title="GoaObject"><span class="returnvalue">GoaObject</span></a> * goa_provider_add_account (<em class="parameter"><code><a class="link" href="GoaProvider.html" title="GoaProvider"><span class="type">GoaProvider</span></a> *provider</code></em>,
375
375
<em class="parameter"><code><a class="link" href="GoaClient.html" title="GoaClient"><span class="type">GoaClient</span></a> *client</code></em>,
376
<em class="parameter"><code><span class="type">GtkDialog</span> *dialog</code></em>,
377
<em class="parameter"><code><span class="type">GtkBox</span> *vbox</code></em>,
376
<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkDialog.html"><span class="type">GtkDialog</span></a> *dialog</code></em>,
377
<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkBox.html"><span class="type">GtkBox</span></a> *vbox</code></em>,
378
378
<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>
380
380
This method brings up the user interface necessary to create a new
392
392
If an account was successfully created, a <a class="link" href="GoaObject.html" title="GoaObject"><span class="type">GoaObject</span></a> for the
393
created account is returned. If <em class="parameter"><code>dialog</code></em> is dismissed, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is
393
created account is returned. If <em class="parameter"><code>dialog</code></em> is dismissed, <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> is
394
394
returned and <em class="parameter"><code>error</code></em> is set to <a class="link" href="goa-GoaError.html#GOA-ERROR-DIALOG-DISMISSED:CAPS"><code class="literal">GOA_ERROR_DIALOG_DISMISSED</code></a>. If an
395
395
account couldn't be created then <em class="parameter"><code>error</code></em> is set.
422
422
<td><p><span class="term"><em class="parameter"><code>dialog</code></em> :</span></p></td>
423
<td>A <span class="type">GtkDialog</span>.</td>
423
<td>A <a href="http://library.gnome.org/devel/gtk3/GtkDialog.html"><span class="type">GtkDialog</span></a>.</td>
426
426
<td><p><span class="term"><em class="parameter"><code>vbox</code></em> :</span></p></td>
427
<td>A vertically oriented <span class="type">GtkBox</span> to put content in.</td>
427
<td>A vertically oriented <a href="http://library.gnome.org/devel/gtk3/GtkBox.html"><span class="type">GtkBox</span></a> to put content in.</td>
430
430
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
431
<td>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>.</td>
431
<td>Return location for error or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
434
434
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
435
435
<td>The <a class="link" href="GoaObject.html" title="GoaObject"><span class="type">GoaObject</span></a> for the created account (must be relased
436
with <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>) or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>error</code></em> is set.</td>
436
with <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>) or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>error</code></em> is set.</td>
444
444
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> goa_provider_refresh_account (<em class="parameter"><code><a class="link" href="GoaProvider.html" title="GoaProvider"><span class="type">GoaProvider</span></a> *provider</code></em>,
445
445
<em class="parameter"><code><a class="link" href="GoaClient.html" title="GoaClient"><span class="type">GoaClient</span></a> *client</code></em>,
446
446
<em class="parameter"><code><a class="link" href="GoaObject.html" title="GoaObject"><span class="type">GoaObject</span></a> *object</code></em>,
447
<em class="parameter"><code><span class="type">GtkWindow</span> *parent</code></em>,
447
<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkWindow.html"><span class="type">GtkWindow</span></a> *parent</code></em>,
448
448
<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>
450
450
This method brings up the user interface necessary for refreshing
452
452
typically involves having the user log in to the account again.
455
Implementations should use <em class="parameter"><code>parent</code></em> (unless <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>) as the transient
455
Implementations should use <em class="parameter"><code>parent</code></em> (unless <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>) as the transient
456
456
parent of any created windows/dialogs.
482
482
<td><p><span class="term"><em class="parameter"><code>parent</code></em> :</span></p></td>
483
<td>Transient parent of dialogs or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
483
<td>Transient parent of dialogs or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
487
487
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
488
<td>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>.</td>
488
<td>Return location for error or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
491
491
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
502
502
<pre class="programlisting"><span class="returnvalue">void</span> goa_provider_show_account (<em class="parameter"><code><a class="link" href="GoaProvider.html" title="GoaProvider"><span class="type">GoaProvider</span></a> *provider</code></em>,
503
503
<em class="parameter"><code><a class="link" href="GoaClient.html" title="GoaClient"><span class="type">GoaClient</span></a> *client</code></em>,
504
504
<em class="parameter"><code><a class="link" href="GoaObject.html" title="GoaObject"><span class="type">GoaObject</span></a> *object</code></em>,
505
<em class="parameter"><code><span class="type">GtkBox</span> *vbox</code></em>,
506
<em class="parameter"><code><span class="type">GtkTable</span> *table</code></em>);</pre>
505
<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkBox.html"><span class="type">GtkBox</span></a> *vbox</code></em>,
506
<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkTable.html"><span class="type">GtkTable</span></a> *table</code></em>);</pre>
508
508
Method used to add widgets in the control panel for the account
509
509
represented by <em class="parameter"><code>object</code></em>.
577
577
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
578
<td>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>. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
578
<td>A <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
582
582
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
583
<td>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>.</td>
583
<td>Return location for error or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
586
586
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
624
624
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
625
<td>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>. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
625
<td>A <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
629
629
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
630
<td>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>.</td>
630
<td>Return location for error or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
633
633
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
634
634
<td>A <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> (never floating)
635
with credentials or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>error</code></em> is set. Free with
635
with credentials or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>error</code></em> is set. Free with
636
636
<a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#g-variant-unref"><code class="function">g_variant_unref()</code></a>. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
753
753
<td><p><span class="term"><em class="parameter"><code>out_expires_in</code></em> :</span></p></td>
754
<td>Return location for how long the expired credentials are good 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>. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span>
754
<td>Return location for how long the expired credentials are good for (0 if unknown) or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>]</span>
758
758
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
759
<td>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>. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
759
<td>A <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
763
763
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
764
<td>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>.</td>
764
<td>Return location for error or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
767
767
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
856
856
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
857
857
<td>A <a class="link" href="GoaProvider.html" title="GoaProvider"><span class="type">GoaProvider</span></a> (that must be freed
858
with <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>) or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if not found. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
858
with <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>) or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if not found. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>