libaccount-plugin-1.0-dev 0.1.8+16.04.20160201-0ubuntu1 / usr / share / gir-1.0 / AccountPlugin-1.0.gir

<?xml version="1.0"?>
<!-- This file was automatically generated from C sources - DO NOT EDIT!
To affect the contents of this file, edit the original C definitions,
and/or use gtk-doc annotations.  -->
<repository version="1.2"
            xmlns="http://www.gtk.org/introspection/core/1.0"
            xmlns:c="http://www.gtk.org/introspection/c/1.0"
            xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
  <include name="Accounts" version="1.0"/>
  <include name="GObject" version="2.0"/>
  <include name="Gtk" version="3.0"/>
  <c:include name="libaccount-plugin/account-plugin.h"/>
  <namespace name="AccountPlugin"
             version="1.0"
             shared-library="libaccount-plugin-1.0.so.0"
             c:identifier-prefixes="Ap"
             c:symbol-prefixes="ap">
    <class name="ApplicationPlugin"
           c:symbol-prefix="application_plugin"
           c:type="ApApplicationPlugin"
           parent="GObject.Object"
           glib:type-name="ApApplicationPlugin"
           glib:get-type="ap_application_plugin_get_type"
           glib:type-struct="ApplicationPluginClass">
      <doc xml:space="preserve">Use the accessor functions below.</doc>
      <virtual-method name="build_widget" invoker="build_widget">
        <doc xml:space="preserve">Build a UI widget to edit the application-specific account settings on the
#AgAccount associated with this plugin.
The plugin must emit the #ApApplicationPlugin::finished signal once the
widget has completed its tasks and can be destroyed.</doc>
        <return-value transfer-ownership="none">
          <doc xml:space="preserve">a #GtkWidget which till take care of
performing the needed tasks, or %NULL.</doc>
          <type name="Gtk.Widget" c:type="GtkWidget*"/>
        </return-value>
        <parameters>
          <instance-parameter name="self" transfer-ownership="none">
            <doc xml:space="preserve">the #ApApplicationPlugin.</doc>
            <type name="ApplicationPlugin" c:type="ApApplicationPlugin*"/>
          </instance-parameter>
        </parameters>
      </virtual-method>
      <method name="build_widget"
              c:identifier="ap_application_plugin_build_widget">
        <doc xml:space="preserve">Build a UI widget to edit the application-specific account settings on the
#AgAccount associated with this plugin.
The plugin must emit the #ApApplicationPlugin::finished signal once the
widget has completed its tasks and can be destroyed.</doc>
        <return-value transfer-ownership="none">
          <doc xml:space="preserve">a #GtkWidget which till take care of
performing the needed tasks, or %NULL.</doc>
          <type name="Gtk.Widget" c:type="GtkWidget*"/>
        </return-value>
        <parameters>
          <instance-parameter name="self" transfer-ownership="none">
            <doc xml:space="preserve">the #ApApplicationPlugin.</doc>
            <type name="ApplicationPlugin" c:type="ApApplicationPlugin*"/>
          </instance-parameter>
        </parameters>
      </method>
      <method name="emit_finished"
              c:identifier="ap_application_plugin_emit_finished">
        <doc xml:space="preserve">Emits the #ApApplicationPlugin::finished signal. This method is useful for
subclasses only.</doc>
        <return-value transfer-ownership="none">
          <type name="none" c:type="void"/>
        </return-value>
        <parameters>
          <instance-parameter name="self" transfer-ownership="none">
            <doc xml:space="preserve">the #ApApplicationPlugin.</doc>
            <type name="ApplicationPlugin" c:type="ApApplicationPlugin*"/>
          </instance-parameter>
        </parameters>
      </method>
      <method name="get_account"
              c:identifier="ap_application_plugin_get_account">
        <doc xml:space="preserve">Get the #AgAccount associated with this application_plugin instance.</doc>
        <return-value transfer-ownership="none">
          <doc xml:space="preserve">the #AgAccount, or %NULL.</doc>
          <type name="Accounts.Account" c:type="AgAccount*"/>
        </return-value>
        <parameters>
          <instance-parameter name="self" transfer-ownership="none">
            <doc xml:space="preserve">the #ApApplicationPlugin.</doc>
            <type name="ApplicationPlugin" c:type="ApApplicationPlugin*"/>
          </instance-parameter>
        </parameters>
      </method>
      <method name="get_application"
              c:identifier="ap_application_plugin_get_application">
        <doc xml:space="preserve">Get the #AgApplication associated with this plugin instance.</doc>
        <return-value transfer-ownership="none">
          <doc xml:space="preserve">the #AgApplication, or %NULL.</doc>
          <type name="Accounts.Application" c:type="AgApplication*"/>
        </return-value>
        <parameters>
          <instance-parameter name="self" transfer-ownership="none">
            <doc xml:space="preserve">the #ApApplicationPlugin.</doc>
            <type name="ApplicationPlugin" c:type="ApApplicationPlugin*"/>
          </instance-parameter>
        </parameters>
      </method>
      <method name="get_error" c:identifier="ap_application_plugin_get_error">
        <doc xml:space="preserve">Get whether the requested operation ended in an error.</doc>
        <return-value transfer-ownership="none">
          <doc xml:space="preserve">a #GError if an error occurred, %NULL otherwise.</doc>
          <type name="GLib.Error" c:type="const GError*"/>
        </return-value>
        <parameters>
          <instance-parameter name="self" transfer-ownership="none">
            <doc xml:space="preserve">the #ApApplicationPlugin.</doc>
            <type name="ApplicationPlugin" c:type="ApApplicationPlugin*"/>
          </instance-parameter>
        </parameters>
      </method>
      <method name="set_error" c:identifier="ap_application_plugin_set_error">
        <doc xml:space="preserve">Tell the application plugin that the requested operation ended in an error.
This method should be called by #ApApplicationPlugin subclasses only.</doc>
        <return-value transfer-ownership="none">
          <type name="none" c:type="void"/>
        </return-value>
        <parameters>
          <instance-parameter name="self" transfer-ownership="none">
            <doc xml:space="preserve">the #ApApplicationPlugin.</doc>
            <type name="ApplicationPlugin" c:type="ApApplicationPlugin*"/>
          </instance-parameter>
          <parameter name="error" transfer-ownership="none">
            <doc xml:space="preserve">the #GError to set on the plugin.</doc>
            <type name="GLib.Error" c:type="const GError*"/>
          </parameter>
        </parameters>
      </method>
      <property name="account"
                writable="1"
                construct-only="1"
                transfer-ownership="none">
        <doc xml:space="preserve">The #AgAccount associated with the plugin.</doc>
        <type name="Accounts.Account"/>
      </property>
      <property name="application"
                writable="1"
                construct-only="1"
                transfer-ownership="none">
        <doc xml:space="preserve">The #AgApplication associated with the plugin.</doc>
        <type name="Accounts.Application"/>
      </property>
      <field name="parent_instance">
        <type name="GObject.Object" c:type="GObject"/>
      </field>
      <field name="priv" readable="0" private="1">
        <type name="ApplicationPluginPrivate"
              c:type="ApApplicationPluginPrivate*"/>
      </field>
      <glib:signal name="finished" when="last">
        <doc xml:space="preserve">Emitted when the plugin UI has completed its task and can be dismissed.</doc>
        <return-value transfer-ownership="none">
          <type name="none" c:type="void"/>
        </return-value>
      </glib:signal>
    </class>
    <record name="ApplicationPluginClass"
            c:type="ApApplicationPluginClass"
            glib:is-gtype-struct-for="ApplicationPlugin">
      <doc xml:space="preserve">Base class for account application_plugins.</doc>
      <field name="parent_class">
        <type name="GObject.ObjectClass" c:type="GObjectClass"/>
      </field>
      <field name="build_widget">
        <callback name="build_widget">
          <return-value transfer-ownership="none">
            <doc xml:space="preserve">a #GtkWidget which till take care of
performing the needed tasks, or %NULL.</doc>
            <type name="Gtk.Widget" c:type="GtkWidget*"/>
          </return-value>
          <parameters>
            <parameter name="self" transfer-ownership="none">
              <doc xml:space="preserve">the #ApApplicationPlugin.</doc>
              <type name="ApplicationPlugin" c:type="ApApplicationPlugin*"/>
            </parameter>
          </parameters>
        </callback>
      </field>
      <field name="_ap_reserved2" introspectable="0">
        <callback name="_ap_reserved2">
          <return-value transfer-ownership="none">
            <type name="none" c:type="void"/>
          </return-value>
        </callback>
      </field>
      <field name="_ap_reserved3" introspectable="0">
        <callback name="_ap_reserved3">
          <return-value transfer-ownership="none">
            <type name="none" c:type="void"/>
          </return-value>
        </callback>
      </field>
      <field name="_ap_reserved4" introspectable="0">
        <callback name="_ap_reserved4">
          <return-value transfer-ownership="none">
            <type name="none" c:type="void"/>
          </return-value>
        </callback>
      </field>
      <field name="_ap_reserved5" introspectable="0">
        <callback name="_ap_reserved5">
          <return-value transfer-ownership="none">
            <type name="none" c:type="void"/>
          </return-value>
        </callback>
      </field>
      <field name="_ap_reserved6" introspectable="0">
        <callback name="_ap_reserved6">
          <return-value transfer-ownership="none">
            <type name="none" c:type="void"/>
          </return-value>
        </callback>
      </field>
      <field name="_ap_reserved7" introspectable="0">
        <callback name="_ap_reserved7">
          <return-value transfer-ownership="none">
            <type name="none" c:type="void"/>
          </return-value>
        </callback>
      </field>
    </record>
    <record name="ApplicationPluginPrivate"
            c:type="ApApplicationPluginPrivate"
            disguised="1">
    </record>
    <enumeration name="OAuthMechanism" c:type="ApOAuthMechanism">
      <doc xml:space="preserve">The authentication mechanism to be used.</doc>
      <member name="user_agent"
              value="0"
              c:identifier="AP_OAUTH_MECHANISM_USER_AGENT">
        <doc xml:space="preserve">OAuth 2.0, user-agent flow (default)</doc>
      </member>
      <member name="web_server"
              value="1"
              c:identifier="AP_OAUTH_MECHANISM_WEB_SERVER">
        <doc xml:space="preserve">OAuth 2.0, web-server flow</doc>
      </member>
      <member name="hmac_sha1"
              value="2"
              c:identifier="AP_OAUTH_MECHANISM_HMAC_SHA1">
        <doc xml:space="preserve">OAuth 1.0a, signing type: HMAC-SHA1</doc>
      </member>
      <member name="plaintext"
              value="3"
              c:identifier="AP_OAUTH_MECHANISM_PLAINTEXT">
        <doc xml:space="preserve">OAuth 1.0a, signing type: PLAINTEXT</doc>
      </member>
      <member name="rsa_sha1"
              value="4"
              c:identifier="AP_OAUTH_MECHANISM_RSA_SHA1">
        <doc xml:space="preserve">OAuth 1.0a, signing type: RSA-SHA1</doc>
      </member>
    </enumeration>
    <class name="OAuthPlugin"
           c:symbol-prefix="oauth_plugin"
           c:type="ApOAuthPlugin"
           parent="Plugin"
           glib:type-name="ApOAuthPlugin"
           glib:get-type="ap_oauth_plugin_get_type"
           glib:type-struct="OAuthPluginClass">
      <doc xml:space="preserve">Use the accessor functions below.</doc>
      <method name="set_account_oauth_parameters"
              c:identifier="ap_oauth_plugin_set_account_oauth_parameters">
        <doc xml:space="preserve">Sets the dictionary of OAuth parameters to be used by client applications
when authenticating the account. These are the parameters which will be
stored into the account configuration (those used by the plugin itself when
authenticating are those set with ap_oauth_plugin_set_oauth_parameters()).</doc>
        <return-value transfer-ownership="none">
          <type name="none" c:type="void"/>
        </return-value>
        <parameters>
          <instance-parameter name="self" transfer-ownership="none">
            <doc xml:space="preserve">the #ApOAuthPlugin.</doc>
            <type name="OAuthPlugin" c:type="ApOAuthPlugin*"/>
          </instance-parameter>
          <parameter name="oauth_params" transfer-ownership="none">
            <doc xml:space="preserve">a dictionary of OAuth parameters.</doc>
            <type name="GLib.HashTable" c:type="GHashTable*">
              <type name="utf8"/>
              <type name="GObject.Value"/>
            </type>
          </parameter>
        </parameters>
      </method>
      <method name="set_mechanism"
              c:identifier="ap_oauth_plugin_set_mechanism">
        <doc xml:space="preserve">Set the OAuth mechanism to be used when authenticating the account.</doc>
        <return-value transfer-ownership="none">
          <type name="none" c:type="void"/>
        </return-value>
        <parameters>
          <instance-parameter name="self" transfer-ownership="none">
            <doc xml:space="preserve">the #ApOAuthPlugin.</doc>
            <type name="OAuthPlugin" c:type="ApOAuthPlugin*"/>
          </instance-parameter>
          <parameter name="mechanism" transfer-ownership="none">
            <doc xml:space="preserve">the desired OAuth mechanism.</doc>
            <type name="OAuthMechanism" c:type="ApOAuthMechanism"/>
          </parameter>
        </parameters>
      </method>
      <method name="set_oauth_parameters"
              c:identifier="ap_oauth_plugin_set_oauth_parameters">
        <doc xml:space="preserve">Sets the dictionary of OAuth parameters to be used when authenticating the
account. Note that these parameters are not stored in the account and will
be used only by the account plugin.
To set the authentication parameters used by applications, use
ap_oauth_plugin_set_account_oauth_parameters().</doc>
        <return-value transfer-ownership="none">
          <type name="none" c:type="void"/>
        </return-value>
        <parameters>
          <instance-parameter name="self" transfer-ownership="none">
            <doc xml:space="preserve">the #ApOAuthPlugin.</doc>
            <type name="OAuthPlugin" c:type="ApOAuthPlugin*"/>
          </instance-parameter>
          <parameter name="oauth_params" transfer-ownership="none">
            <doc xml:space="preserve">a dictionary of OAuth parameters.</doc>
            <type name="GLib.HashTable" c:type="GHashTable*">
              <type name="utf8"/>
              <type name="GObject.Value"/>
            </type>
          </parameter>
        </parameters>
      </method>
      <property name="oauth-params"
                writable="1"
                construct-only="1"
                transfer-ownership="none">
        <doc xml:space="preserve">A dictionary of OAuth parameters, to be used when authenticating an
account.</doc>
        <type name="GLib.HashTable">
          <type name="gpointer" c:type="gpointer"/>
          <type name="gpointer" c:type="gpointer"/>
        </type>
      </property>
      <field name="parent_instance">
        <type name="Plugin" c:type="ApPlugin"/>
      </field>
      <field name="priv" readable="0" private="1">
        <type name="OAuthPluginPrivate" c:type="ApOAuthPluginPrivate*"/>
      </field>
    </class>
    <record name="OAuthPluginClass"
            c:type="ApOAuthPluginClass"
            glib:is-gtype-struct-for="OAuthPlugin">
      <doc xml:space="preserve">Base class for account plugins.</doc>
      <field name="parent_class">
        <type name="PluginClass" c:type="ApPluginClass"/>
      </field>
      <field name="_ap_reserved1" introspectable="0">
        <callback name="_ap_reserved1">
          <return-value transfer-ownership="none">
            <type name="none" c:type="void"/>
          </return-value>
        </callback>
      </field>
      <field name="_ap_reserved2" introspectable="0">
        <callback name="_ap_reserved2">
          <return-value transfer-ownership="none">
            <type name="none" c:type="void"/>
          </return-value>
        </callback>
      </field>
      <field name="_ap_reserved3" introspectable="0">
        <callback name="_ap_reserved3">
          <return-value transfer-ownership="none">
            <type name="none" c:type="void"/>
          </return-value>
        </callback>
      </field>
      <field name="_ap_reserved4" introspectable="0">
        <callback name="_ap_reserved4">
          <return-value transfer-ownership="none">
            <type name="none" c:type="void"/>
          </return-value>
        </callback>
      </field>
      <field name="_ap_reserved5" introspectable="0">
        <callback name="_ap_reserved5">
          <return-value transfer-ownership="none">
            <type name="none" c:type="void"/>
          </return-value>
        </callback>
      </field>
      <field name="_ap_reserved6" introspectable="0">
        <callback name="_ap_reserved6">
          <return-value transfer-ownership="none">
            <type name="none" c:type="void"/>
          </return-value>
        </callback>
      </field>
      <field name="_ap_reserved7" introspectable="0">
        <callback name="_ap_reserved7">
          <return-value transfer-ownership="none">
            <type name="none" c:type="void"/>
          </return-value>
        </callback>
      </field>
    </record>
    <record name="OAuthPluginPrivate"
            c:type="ApOAuthPluginPrivate"
            disguised="1">
    </record>
    <constant name="PLUGIN_CREDENTIALS_ID_FIELD"
              value="CredentialsId"
              c:type="AP_PLUGIN_CREDENTIALS_ID_FIELD">
      <doc xml:space="preserve">The field in the credentials database for storing the signon identity ID.</doc>
      <type name="utf8" c:type="gchar*"/>
    </constant>
    <class name="Plugin"
           c:symbol-prefix="plugin"
           c:type="ApPlugin"
           parent="GObject.Object"
           glib:type-name="ApPlugin"
           glib:get-type="ap_plugin_get_type"
           glib:type-struct="PluginClass">
      <doc xml:space="preserve">Use the accessor functions below.</doc>
      <virtual-method name="act_headless" invoker="act_headless">
        <doc xml:space="preserve">Perform the needed operation on the #AgAccount associated with this plugin.
This works similarly to the ap_plugin_build_widget() method, with the
difference that in this case there is no UI involved.
The plugin will emit the #ApPlugin::finished signal once it has
completed its tasks.</doc>
        <return-value transfer-ownership="none">
          <type name="none" c:type="void"/>
        </return-value>
        <parameters>
          <instance-parameter name="self" transfer-ownership="none">
            <doc xml:space="preserve">the #ApPlugin.</doc>
            <type name="Plugin" c:type="ApPlugin*"/>
          </instance-parameter>
        </parameters>
      </virtual-method>
      <virtual-method name="build_widget" invoker="build_widget">
        <doc xml:space="preserve">Build a UI widget to perform the needed operation on the #AgAccount
associated with this plugin:
- if the #AgAccount is a newly allocated instance (not stored on disk), then
  the plugin should proceed with the account creation. Otherwise,
- if the #ApPlugin:need-authentication property is set, the returned UI
  widget should provide a way for the user to reauthenticate the account;
- if none of the above conditions apply, the plugin should return a widget
  to allow editing the account global settings (that is, those settings
  which are common for all applications using the account).
The plugin will emit the #ApPlugin::finished signal once the widget has
completed its tasks and can be destroyed.</doc>
        <return-value transfer-ownership="none">
          <doc xml:space="preserve">a #GtkWidget which till take care of
performing the needed tasks, or %NULL.</doc>
          <type name="Gtk.Widget" c:type="GtkWidget*"/>
        </return-value>
        <parameters>
          <instance-parameter name="self" transfer-ownership="none">
            <doc xml:space="preserve">the #ApPlugin.</doc>
            <type name="Plugin" c:type="ApPlugin*"/>
          </instance-parameter>
        </parameters>
      </virtual-method>
      <virtual-method name="delete_account" invoker="delete_account">
        <doc xml:space="preserve">Delete the account. When the operation is finished, @callback will be
invoked; you can then call ap_plugin_delete_account_finish() to know if the
operation was successful.
This is a virtual method; the base implementation removes the account from
the accounts database and the accounts credentials from the Single Sign-On
database.</doc>
        <return-value transfer-ownership="none">
          <type name="none" c:type="void"/>
        </return-value>
        <parameters>
          <instance-parameter name="self" transfer-ownership="none">
            <doc xml:space="preserve">the #ApPlugin.</doc>
            <type name="Plugin" c:type="ApPlugin*"/>
          </instance-parameter>
          <parameter name="callback"
                     transfer-ownership="none"
                     nullable="1"
                     allow-none="1"
                     scope="async"
                     closure="1">
            <doc xml:space="preserve">a callback which will be invoked when the operation has been
completed.</doc>
            <type name="Gio.AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
          </parameter>
          <parameter name="user_data" transfer-ownership="none" closure="1">
            <doc xml:space="preserve">user data to be passed to the callback.</doc>
            <type name="gpointer" c:type="gpointer"/>
          </parameter>
        </parameters>
      </virtual-method>
      <method name="act_headless" c:identifier="ap_plugin_act_headless">
        <doc xml:space="preserve">Perform the needed operation on the #AgAccount associated with this plugin.
This works similarly to the ap_plugin_build_widget() method, with the
difference that in this case there is no UI involved.
The plugin will emit the #ApPlugin::finished signal once it has
completed its tasks.</doc>
        <return-value transfer-ownership="none">
          <type name="none" c:type="void"/>
        </return-value>
        <parameters>
          <instance-parameter name="self" transfer-ownership="none">
            <doc xml:space="preserve">the #ApPlugin.</doc>
            <type name="Plugin" c:type="ApPlugin*"/>
          </instance-parameter>
        </parameters>
      </method>
      <method name="build_widget" c:identifier="ap_plugin_build_widget">
        <doc xml:space="preserve">Build a UI widget to perform the needed operation on the #AgAccount
associated with this plugin:
- if the #AgAccount is a newly allocated instance (not stored on disk), then
  the plugin should proceed with the account creation. Otherwise,
- if the #ApPlugin:need-authentication property is set, the returned UI
  widget should provide a way for the user to reauthenticate the account;
- if none of the above conditions apply, the plugin should return a widget
  to allow editing the account global settings (that is, those settings
  which are common for all applications using the account).
The plugin will emit the #ApPlugin::finished signal once the widget has
completed its tasks and can be destroyed.</doc>
        <return-value transfer-ownership="none">
          <doc xml:space="preserve">a #GtkWidget which till take care of
performing the needed tasks, or %NULL.</doc>
          <type name="Gtk.Widget" c:type="GtkWidget*"/>
        </return-value>
        <parameters>
          <instance-parameter name="self" transfer-ownership="none">
            <doc xml:space="preserve">the #ApPlugin.</doc>
            <type name="Plugin" c:type="ApPlugin*"/>
          </instance-parameter>
        </parameters>
      </method>
      <method name="delete_account" c:identifier="ap_plugin_delete_account">
        <doc xml:space="preserve">Delete the account. When the operation is finished, @callback will be
invoked; you can then call ap_plugin_delete_account_finish() to know if the
operation was successful.
This is a virtual method; the base implementation removes the account from
the accounts database and the accounts credentials from the Single Sign-On
database.</doc>
        <return-value transfer-ownership="none">
          <type name="none" c:type="void"/>
        </return-value>
        <parameters>
          <instance-parameter name="self" transfer-ownership="none">
            <doc xml:space="preserve">the #ApPlugin.</doc>
            <type name="Plugin" c:type="ApPlugin*"/>
          </instance-parameter>
          <parameter name="callback"
                     transfer-ownership="none"
                     nullable="1"
                     allow-none="1"
                     scope="async"
                     closure="1">
            <doc xml:space="preserve">a callback which will be invoked when the operation has been
completed.</doc>
            <type name="Gio.AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
          </parameter>
          <parameter name="user_data" transfer-ownership="none">
            <doc xml:space="preserve">user data to be passed to the callback.</doc>
            <type name="gpointer" c:type="gpointer"/>
          </parameter>
        </parameters>
      </method>
      <method name="delete_account_finish"
              c:identifier="ap_plugin_delete_account_finish"
              throws="1">
        <doc xml:space="preserve">Finish the operation started with ap_plugin_delete_account().</doc>
        <return-value transfer-ownership="none">
          <doc xml:space="preserve">%TRUE if the operation succeeded, %FALSE otherwise.</doc>
          <type name="gboolean" c:type="gboolean"/>
        </return-value>
        <parameters>
          <instance-parameter name="self" transfer-ownership="none">
            <doc xml:space="preserve">the #ApPlugin.</doc>
            <type name="Plugin" c:type="ApPlugin*"/>
          </instance-parameter>
          <parameter name="result" transfer-ownership="none">
            <doc xml:space="preserve">the #GAsyncResult obtained from the #GAsyncReadyCallback passed to
ap_plugin_delete_account().</doc>
            <type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
          </parameter>
        </parameters>
      </method>
      <method name="emit_finished" c:identifier="ap_plugin_emit_finished">
        <doc xml:space="preserve">Emits the #ApPlugin::finished signal. This method is useful for subclasses
only.</doc>
        <return-value transfer-ownership="none">
          <type name="none" c:type="void"/>
        </return-value>
        <parameters>
          <instance-parameter name="self" transfer-ownership="none">
            <doc xml:space="preserve">the #ApPlugin.</doc>
            <type name="Plugin" c:type="ApPlugin*"/>
          </instance-parameter>
        </parameters>
      </method>
      <method name="get_account" c:identifier="ap_plugin_get_account">
        <doc xml:space="preserve">Get the #AgAccount associated with this plugin instance.</doc>
        <return-value transfer-ownership="none">
          <doc xml:space="preserve">the #AgAccount, or %NULL.</doc>
          <type name="Accounts.Account" c:type="AgAccount*"/>
        </return-value>
        <parameters>
          <instance-parameter name="self" transfer-ownership="none">
            <doc xml:space="preserve">the #ApPlugin.</doc>
            <type name="Plugin" c:type="ApPlugin*"/>
          </instance-parameter>
        </parameters>
      </method>
      <method name="get_cookies" c:identifier="ap_plugin_get_cookies">
        <doc xml:space="preserve">Get the HTTP cookies.</doc>
        <return-value transfer-ownership="none">
          <doc xml:space="preserve">a dictionary
with cookie name and value pairs, or %NULL.</doc>
          <type name="GLib.HashTable" c:type="GHashTable*">
            <type name="utf8"/>
            <type name="utf8"/>
          </type>
        </return-value>
        <parameters>
          <instance-parameter name="self" transfer-ownership="none">
            <doc xml:space="preserve">the #ApPlugin.</doc>
            <type name="Plugin" c:type="ApPlugin*"/>
          </instance-parameter>
        </parameters>
      </method>
      <method name="get_error" c:identifier="ap_plugin_get_error">
        <doc xml:space="preserve">Get whether the requested operation ended in an error.</doc>
        <return-value transfer-ownership="none">
          <doc xml:space="preserve">a #GError if an error occurred, %NULL otherwise.</doc>
          <type name="GLib.Error" c:type="const GError*"/>
        </return-value>
        <parameters>
          <instance-parameter name="self" transfer-ownership="none">
            <doc xml:space="preserve">the #ApPlugin.</doc>
            <type name="Plugin" c:type="ApPlugin*"/>
          </instance-parameter>
        </parameters>
      </method>
      <method name="get_ignore_cookies"
              c:identifier="ap_plugin_get_ignore_cookies">
        <doc xml:space="preserve">Get whether the provided cookies should be ignored when performing the
authentication.</doc>
        <return-value transfer-ownership="none">
          <doc xml:space="preserve">whether provided cookies should be ignored.</doc>
          <type name="gboolean" c:type="gboolean"/>
        </return-value>
        <parameters>
          <instance-parameter name="self" transfer-ownership="none">
            <doc xml:space="preserve">the #ApPlugin.</doc>
            <type name="Plugin" c:type="ApPlugin*"/>
          </instance-parameter>
        </parameters>
      </method>
      <method name="get_need_authentication"
              c:identifier="ap_plugin_get_need_authentication">
        <doc xml:space="preserve">Get whether the #AgAccount associated with this plugin instance needs to be
re-authenticated.</doc>
        <return-value transfer-ownership="none">
          <doc xml:space="preserve">%TRUE if the account needs re-authentication, %FALSE otherwise.</doc>
          <type name="gboolean" c:type="gboolean"/>
        </return-value>
        <parameters>
          <instance-parameter name="self" transfer-ownership="none">
            <doc xml:space="preserve">the #ApPlugin.</doc>
            <type name="Plugin" c:type="ApPlugin*"/>
          </instance-parameter>
        </parameters>
      </method>
      <method name="get_password" c:identifier="ap_plugin_get_password">
        <doc xml:space="preserve">Get the login password.</doc>
        <return-value transfer-ownership="none">
          <doc xml:space="preserve">the password, or %NULL.</doc>
          <type name="utf8" c:type="const gchar*"/>
        </return-value>
        <parameters>
          <instance-parameter name="self" transfer-ownership="none">
            <doc xml:space="preserve">the #ApPlugin.</doc>
            <type name="Plugin" c:type="ApPlugin*"/>
          </instance-parameter>
        </parameters>
      </method>
      <method name="get_provider" c:identifier="ap_plugin_get_provider">
        <doc xml:space="preserve">Get the #AgProvider associated with this plugin instance.</doc>
        <return-value transfer-ownership="none">
          <doc xml:space="preserve">the #AgProvider, or %NULL.</doc>
          <type name="Accounts.Provider" c:type="AgProvider*"/>
        </return-value>
        <parameters>
          <instance-parameter name="self" transfer-ownership="none">
            <doc xml:space="preserve">the #ApPlugin.</doc>
            <type name="Plugin" c:type="ApPlugin*"/>
          </instance-parameter>
        </parameters>
      </method>
      <method name="get_user_cancelled"
              c:identifier="ap_plugin_get_user_cancelled">
        <doc xml:space="preserve">Get whether the requested operation was cancelled by the user.</doc>
        <return-value transfer-ownership="none">
          <doc xml:space="preserve">%TRUE if the operation was cancelled, %FALSE otherwise.</doc>
          <type name="gboolean" c:type="gboolean"/>
        </return-value>
        <parameters>
          <instance-parameter name="self" transfer-ownership="none">
            <doc xml:space="preserve">the #ApPlugin.</doc>
            <type name="Plugin" c:type="ApPlugin*"/>
          </instance-parameter>
        </parameters>
      </method>
      <method name="get_username" c:identifier="ap_plugin_get_username">
        <doc xml:space="preserve">Get the login username.</doc>
        <return-value transfer-ownership="none">
          <doc xml:space="preserve">the username, or %NULL.</doc>
          <type name="utf8" c:type="const gchar*"/>
        </return-value>
        <parameters>
          <instance-parameter name="self" transfer-ownership="none">
            <doc xml:space="preserve">the #ApPlugin.</doc>
            <type name="Plugin" c:type="ApPlugin*"/>
          </instance-parameter>
        </parameters>
      </method>
      <method name="set_cookies" c:identifier="ap_plugin_set_cookies">
        <doc xml:space="preserve">Set the HTTP cookies. The plugin may use them while performing a web-based
authentication.</doc>
        <return-value transfer-ownership="none">
          <type name="none" c:type="void"/>
        </return-value>
        <parameters>
          <instance-parameter name="self" transfer-ownership="none">
            <doc xml:space="preserve">the #ApPlugin.</doc>
            <type name="Plugin" c:type="ApPlugin*"/>
          </instance-parameter>
          <parameter name="cookies" transfer-ownership="none">
            <doc xml:space="preserve">a #GHashTable with
cookie name and value pairs.</doc>
            <type name="GLib.HashTable" c:type="GHashTable*">
              <type name="utf8"/>
              <type name="utf8"/>
            </type>
          </parameter>
        </parameters>
      </method>
      <method name="set_credentials" c:identifier="ap_plugin_set_credentials">
        <doc xml:space="preserve">Set the user name and password. The plugin could use them for prefilling the
login form (or skip it altogether).</doc>
        <return-value transfer-ownership="none">
          <type name="none" c:type="void"/>
        </return-value>
        <parameters>
          <instance-parameter name="self" transfer-ownership="none">
            <doc xml:space="preserve">the #ApPlugin.</doc>
            <type name="Plugin" c:type="ApPlugin*"/>
          </instance-parameter>
          <parameter name="username" transfer-ownership="none">
            <doc xml:space="preserve">login username.</doc>
            <type name="utf8" c:type="const gchar*"/>
          </parameter>
          <parameter name="password" transfer-ownership="none">
            <doc xml:space="preserve">the user password, or %NULL.</doc>
            <type name="utf8" c:type="const gchar*"/>
          </parameter>
        </parameters>
      </method>
      <method name="set_error" c:identifier="ap_plugin_set_error">
        <doc xml:space="preserve">Tell the plugin that the requested operation ended in an error. This method
should be called by #ApPlugin subclasses only.</doc>
        <return-value transfer-ownership="none">
          <type name="none" c:type="void"/>
        </return-value>
        <parameters>
          <instance-parameter name="self" transfer-ownership="none">
            <doc xml:space="preserve">the #ApPlugin.</doc>
            <type name="Plugin" c:type="ApPlugin*"/>
          </instance-parameter>
          <parameter name="error" transfer-ownership="none">
            <doc xml:space="preserve">the #GError to set on the plugin.</doc>
            <type name="GLib.Error" c:type="const GError*"/>
          </parameter>
        </parameters>
      </method>
      <method name="set_ignore_cookies"
              c:identifier="ap_plugin_set_ignore_cookies">
        <doc xml:space="preserve">Tells the plugin implementation that all provided cookies should be ignored
when performing the authentication; an ApPlugin subclass might choose to
ignore cookies when the provided cookies are known not to be working.</doc>
        <return-value transfer-ownership="none">
          <type name="none" c:type="void"/>
        </return-value>
        <parameters>
          <instance-parameter name="self" transfer-ownership="none">
            <doc xml:space="preserve">the #ApPlugin.</doc>
            <type name="Plugin" c:type="ApPlugin*"/>
          </instance-parameter>
          <parameter name="ignore_cookies" transfer-ownership="none">
            <doc xml:space="preserve">whether provided cookies should be ignored.</doc>
            <type name="gboolean" c:type="gboolean"/>
          </parameter>
        </parameters>
      </method>
      <method name="set_need_authentication"
              c:identifier="ap_plugin_set_need_authentication">
        <doc xml:space="preserve">Tell the plugin that the #AgAccount associated with it needs to be
re-authenticated.</doc>
        <return-value transfer-ownership="none">
          <type name="none" c:type="void"/>
        </return-value>
        <parameters>
          <instance-parameter name="self" transfer-ownership="none">
            <doc xml:space="preserve">the #ApPlugin.</doc>
            <type name="Plugin" c:type="ApPlugin*"/>
          </instance-parameter>
          <parameter name="need_authentication" transfer-ownership="none">
            <doc xml:space="preserve">whether the plugin must perform the authentication.</doc>
            <type name="gboolean" c:type="gboolean"/>
          </parameter>
        </parameters>
      </method>
      <method name="set_user_cancelled"
              c:identifier="ap_plugin_set_user_cancelled">
        <doc xml:space="preserve">Tell the plugin that the requested operation was cancelled by the user. This
method should be called by #ApPlugin subclasses only.</doc>
        <return-value transfer-ownership="none">
          <type name="none" c:type="void"/>
        </return-value>
        <parameters>
          <instance-parameter name="self" transfer-ownership="none">
            <doc xml:space="preserve">the #ApPlugin.</doc>
            <type name="Plugin" c:type="ApPlugin*"/>
          </instance-parameter>
          <parameter name="cancelled" transfer-ownership="none">
            <doc xml:space="preserve">whether the plugin operation was cancelled by the user.</doc>
            <type name="gboolean" c:type="gboolean"/>
          </parameter>
        </parameters>
      </method>
      <property name="account"
                writable="1"
                construct-only="1"
                transfer-ownership="none">
        <doc xml:space="preserve">The #AgAccount associated with the plugin.</doc>
        <type name="Accounts.Account"/>
      </property>
      <property name="need-authentication"
                writable="1"
                transfer-ownership="none">
        <doc xml:space="preserve">Whether the plugin needs to be authenticated again.</doc>
        <type name="gboolean" c:type="gboolean"/>
      </property>
      <field name="parent_instance">
        <type name="GObject.Object" c:type="GObject"/>
      </field>
      <field name="priv" readable="0" private="1">
        <type name="PluginPrivate" c:type="ApPluginPrivate*"/>
      </field>
      <glib:signal name="finished" when="last">
        <doc xml:space="preserve">Emitted when the plugin UI has completed its task and can be dismissed.</doc>
        <return-value transfer-ownership="none">
          <type name="none" c:type="void"/>
        </return-value>
      </glib:signal>
    </class>
    <record name="PluginClass"
            c:type="ApPluginClass"
            glib:is-gtype-struct-for="Plugin">
      <doc xml:space="preserve">Base class for account plugins.</doc>
      <field name="parent_class">
        <type name="GObject.ObjectClass" c:type="GObjectClass"/>
      </field>
      <field name="build_widget">
        <callback name="build_widget">
          <return-value transfer-ownership="none">
            <doc xml:space="preserve">a #GtkWidget which till take care of
performing the needed tasks, or %NULL.</doc>
            <type name="Gtk.Widget" c:type="GtkWidget*"/>
          </return-value>
          <parameters>
            <parameter name="self" transfer-ownership="none">
              <doc xml:space="preserve">the #ApPlugin.</doc>
              <type name="Plugin" c:type="ApPlugin*"/>
            </parameter>
          </parameters>
        </callback>
      </field>
      <field name="delete_account">
        <callback name="delete_account">
          <return-value transfer-ownership="none">
            <type name="none" c:type="void"/>
          </return-value>
          <parameters>
            <parameter name="self" transfer-ownership="none">
              <doc xml:space="preserve">the #ApPlugin.</doc>
              <type name="Plugin" c:type="ApPlugin*"/>
            </parameter>
            <parameter name="callback"
                       transfer-ownership="none"
                       nullable="1"
                       allow-none="1"
                       scope="async"
                       closure="2">
              <doc xml:space="preserve">a callback which will be invoked when the operation has been
completed.</doc>
              <type name="Gio.AsyncReadyCallback"
                    c:type="GAsyncReadyCallback"/>
            </parameter>
            <parameter name="user_data" transfer-ownership="none" closure="2">
              <doc xml:space="preserve">user data to be passed to the callback.</doc>
              <type name="gpointer" c:type="gpointer"/>
            </parameter>
          </parameters>
        </callback>
      </field>
      <field name="act_headless">
        <callback name="act_headless">
          <return-value transfer-ownership="none">
            <type name="none" c:type="void"/>
          </return-value>
          <parameters>
            <parameter name="self" transfer-ownership="none">
              <doc xml:space="preserve">the #ApPlugin.</doc>
              <type name="Plugin" c:type="ApPlugin*"/>
            </parameter>
          </parameters>
        </callback>
      </field>
      <field name="_ap_reserved4" introspectable="0">
        <callback name="_ap_reserved4">
          <return-value transfer-ownership="none">
            <type name="none" c:type="void"/>
          </return-value>
        </callback>
      </field>
      <field name="_ap_reserved5" introspectable="0">
        <callback name="_ap_reserved5">
          <return-value transfer-ownership="none">
            <type name="none" c:type="void"/>
          </return-value>
        </callback>
      </field>
      <field name="_ap_reserved6" introspectable="0">
        <callback name="_ap_reserved6">
          <return-value transfer-ownership="none">
            <type name="none" c:type="void"/>
          </return-value>
        </callback>
      </field>
      <field name="_ap_reserved7" introspectable="0">
        <callback name="_ap_reserved7">
          <return-value transfer-ownership="none">
            <type name="none" c:type="void"/>
          </return-value>
        </callback>
      </field>
    </record>
    <record name="PluginPrivate" c:type="ApPluginPrivate" disguised="1">
    </record>
    <function name="client_has_plugin" c:identifier="ap_client_has_plugin">
      <doc xml:space="preserve">Checks if there is a valid account plugin for creating accounts having
@provider as provider.</doc>
      <return-value transfer-ownership="none">
        <doc xml:space="preserve">%TRUE if a plugin is found, %FALSE otherwise.</doc>
        <type name="gboolean" c:type="gboolean"/>
      </return-value>
      <parameters>
        <parameter name="provider" transfer-ownership="none">
          <doc xml:space="preserve">the account provider.</doc>
          <type name="Accounts.Provider" c:type="AgProvider*"/>
        </parameter>
      </parameters>
    </function>
    <function name="client_load_application_plugin"
              c:identifier="ap_client_load_application_plugin">
      <doc xml:space="preserve">Load the application plugin for editing the @application specific settings
of @account.</doc>
      <return-value transfer-ownership="full">
        <doc xml:space="preserve">a new #ApApplicationPlugin if a valid plugin was
found, %NULL otherwise.</doc>
        <type name="ApplicationPlugin" c:type="ApApplicationPlugin*"/>
      </return-value>
      <parameters>
        <parameter name="application" transfer-ownership="none">
          <doc xml:space="preserve">the #AgApplication.</doc>
          <type name="Accounts.Application" c:type="AgApplication*"/>
        </parameter>
        <parameter name="account" transfer-ownership="none">
          <doc xml:space="preserve">the #AgAccount to be edited.</doc>
          <type name="Accounts.Account" c:type="AgAccount*"/>
        </parameter>
      </parameters>
    </function>
    <function name="client_load_plugin" c:identifier="ap_client_load_plugin">
      <doc xml:space="preserve">Load the account plugin for @account.</doc>
      <return-value transfer-ownership="full">
        <doc xml:space="preserve">a new #ApPlugin if a valid plugin was found, %NULL
otherwise.</doc>
        <type name="Plugin" c:type="ApPlugin*"/>
      </return-value>
      <parameters>
        <parameter name="account" transfer-ownership="none">
          <doc xml:space="preserve">the #AgAccount to be created/edited.</doc>
          <type name="Accounts.Account" c:type="AgAccount*"/>
        </parameter>
      </parameters>
    </function>
    <function name="module_get_object_type"
              c:identifier="ap_module_get_object_type">
      <return-value transfer-ownership="none">
        <type name="GType" c:type="GType"/>
      </return-value>
    </function>
  </namespace>
</repository>