<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="EBookBackendSync">
<refmeta>
<refentrytitle role="top_of_page">EBookBackendSync</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBEDATA-BOOK Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>EBookBackendSync</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>



typedef     <link linkend="EBookBackendSyncStatus">EBookBackendSyncStatus</link>;
struct      <link linkend="EBookBackendSync-struct">EBookBackendSync</link>;
<link linkend="gboolean">gboolean</link>    <link linkend="e-book-backend-sync-construct">e_book_backend_sync_construct</link>   (<link linkend="EBookBackendSync">EBookBackendSync</link> *backend);
<link linkend="EBookBackendSyncStatus">EBookBackendSyncStatus</link> <link linkend="e-book-backend-sync-remove">e_book_backend_sync_remove</link>
                                            (<link linkend="EBookBackendSync">EBookBackendSync</link> *backend,
                                             <link linkend="EDataBook">EDataBook</link> *book,
                                             <link linkend="guint32">guint32</link> opid);
<link linkend="EBookBackendSyncStatus">EBookBackendSyncStatus</link> <link linkend="e-book-backend-sync-create-contact">e_book_backend_sync_create_contact</link>
                                            (<link linkend="EBookBackendSync">EBookBackendSync</link> *backend,
                                             <link linkend="EDataBook">EDataBook</link> *book,
                                             <link linkend="guint32">guint32</link> opid,
                                             const <link linkend="char">char</link> *vcard,
                                             <link linkend="EContact">EContact</link> **contact);
<link linkend="EBookBackendSyncStatus">EBookBackendSyncStatus</link> <link linkend="e-book-backend-sync-remove-contacts">e_book_backend_sync_remove_contacts</link>
                                            (<link linkend="EBookBackendSync">EBookBackendSync</link> *backend,
                                             <link linkend="EDataBook">EDataBook</link> *book,
                                             <link linkend="guint32">guint32</link> opid,
                                             <link linkend="GList">GList</link> *id_list,
                                             <link linkend="GList">GList</link> **removed_ids);
<link linkend="EBookBackendSyncStatus">EBookBackendSyncStatus</link> <link linkend="e-book-backend-sync-modify-contact">e_book_backend_sync_modify_contact</link>
                                            (<link linkend="EBookBackendSync">EBookBackendSync</link> *backend,
                                             <link linkend="EDataBook">EDataBook</link> *book,
                                             <link linkend="guint32">guint32</link> opid,
                                             const <link linkend="char">char</link> *vcard,
                                             <link linkend="EContact">EContact</link> **contact);
<link linkend="EBookBackendSyncStatus">EBookBackendSyncStatus</link> <link linkend="e-book-backend-sync-get-contact">e_book_backend_sync_get_contact</link>
                                            (<link linkend="EBookBackendSync">EBookBackendSync</link> *backend,
                                             <link linkend="EDataBook">EDataBook</link> *book,
                                             <link linkend="guint32">guint32</link> opid,
                                             const <link linkend="char">char</link> *id,
                                             <link linkend="char">char</link> **vcard);
<link linkend="EBookBackendSyncStatus">EBookBackendSyncStatus</link> <link linkend="e-book-backend-sync-get-contact-list">e_book_backend_sync_get_contact_list</link>
                                            (<link linkend="EBookBackendSync">EBookBackendSync</link> *backend,
                                             <link linkend="EDataBook">EDataBook</link> *book,
                                             <link linkend="guint32">guint32</link> opid,
                                             const <link linkend="char">char</link> *query,
                                             <link linkend="GList">GList</link> **contacts);
<link linkend="EBookBackendSyncStatus">EBookBackendSyncStatus</link> <link linkend="e-book-backend-sync-get-changes">e_book_backend_sync_get_changes</link>
                                            (<link linkend="EBookBackendSync">EBookBackendSync</link> *backend,
                                             <link linkend="EDataBook">EDataBook</link> *book,
                                             <link linkend="guint32">guint32</link> opid,
                                             const <link linkend="char">char</link> *change_id,
                                             <link linkend="GList">GList</link> **changes);
<link linkend="EBookBackendSyncStatus">EBookBackendSyncStatus</link> <link linkend="e-book-backend-sync-authenticate-user">e_book_backend_sync_authenticate_user</link>
                                            (<link linkend="EBookBackendSync">EBookBackendSync</link> *backend,
                                             <link linkend="EDataBook">EDataBook</link> *book,
                                             <link linkend="guint32">guint32</link> opid,
                                             const <link linkend="char">char</link> *user,
                                             const <link linkend="char">char</link> *passwd,
                                             const <link linkend="char">char</link> *auth_method);
<link linkend="EBookBackendSyncStatus">EBookBackendSyncStatus</link> <link linkend="e-book-backend-sync-get-required-fields">e_book_backend_sync_get_required_fields</link>
                                            (<link linkend="EBookBackendSync">EBookBackendSync</link> *backend,
                                             <link linkend="EDataBook">EDataBook</link> *book,
                                             <link linkend="guint32">guint32</link> opid,
                                             <link linkend="GList">GList</link> **fields);
<link linkend="EBookBackendSyncStatus">EBookBackendSyncStatus</link> <link linkend="e-book-backend-sync-get-supported-fields">e_book_backend_sync_get_supported_fields</link>
                                            (<link linkend="EBookBackendSync">EBookBackendSync</link> *backend,
                                             <link linkend="EDataBook">EDataBook</link> *book,
                                             <link linkend="guint32">guint32</link> opid,
                                             <link linkend="GList">GList</link> **fields);
<link linkend="EBookBackendSyncStatus">EBookBackendSyncStatus</link> <link linkend="e-book-backend-sync-get-supported-auth-methods">e_book_backend_sync_get_supported_auth_methods</link>
                                            (<link linkend="EBookBackendSync">EBookBackendSync</link> *backend,
                                             <link linkend="EDataBook">EDataBook</link> *book,
                                             <link linkend="guint32">guint32</link> opid,
                                             <link linkend="GList">GList</link> **methods);


</synopsis>
</refsynopsisdiv>

<refsect1 role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>

  <link linkend="GObject">GObject</link>
   +----<link linkend="EBookBackend">EBookBackend</link>
         +----EBookBackendSync
</synopsis>

</refsect1>








<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>

</para>
</refsect1>

<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="EBookBackendSyncStatus" role="typedef"/>EBookBackendSyncStatus</title>
<indexterm><primary>EBookBackendSyncStatus</primary></indexterm><programlisting>typedef GNOME_Evolution_Addressbook_CallStatus EBookBackendSyncStatus;
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="EBookBackendSync-struct" role="struct"/>struct EBookBackendSync</title>
<indexterm><primary>EBookBackendSync</primary></indexterm><programlisting>struct EBookBackendSync;</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="e-book-backend-sync-construct" role="function"/>e_book_backend_sync_construct ()</title>
<indexterm><primary>e_book_backend_sync_construct</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    e_book_backend_sync_construct   (<link linkend="EBookBackendSync">EBookBackendSync</link> *backend);</programlisting>
<para>
Does nothing.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="EBookBackendSync"><type>EBookBackendSync</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-book-backend-sync-remove" role="function"/>e_book_backend_sync_remove ()</title>
<indexterm><primary>e_book_backend_sync_remove</primary></indexterm><programlisting><link linkend="EBookBackendSyncStatus">EBookBackendSyncStatus</link> e_book_backend_sync_remove
                                            (<link linkend="EBookBackendSync">EBookBackendSync</link> *backend,
                                             <link linkend="EDataBook">EDataBook</link> *book,
                                             <link linkend="guint32">guint32</link> opid);</programlisting>
<para>
Remove <parameter>book</parameter>'s database and storage overhead from the storage
medium. This will delete all contacts in <parameter>book</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="EBookBackendSync"><type>EBookBackendSync</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>book</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="EDataBook"><type>EDataBook</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>opid</parameter>&nbsp;:</term>
<listitem><simpara> the unique ID of the operation
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> An <link linkend="EBookBackendSyncStatus"><type>EBookBackendSyncStatus</type></link> indicating the outcome of the operation.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-book-backend-sync-create-contact" role="function"/>e_book_backend_sync_create_contact ()</title>
<indexterm><primary>e_book_backend_sync_create_contact</primary></indexterm><programlisting><link linkend="EBookBackendSyncStatus">EBookBackendSyncStatus</link> e_book_backend_sync_create_contact
                                            (<link linkend="EBookBackendSync">EBookBackendSync</link> *backend,
                                             <link linkend="EDataBook">EDataBook</link> *book,
                                             <link linkend="guint32">guint32</link> opid,
                                             const <link linkend="char">char</link> *vcard,
                                             <link linkend="EContact">EContact</link> **contact);</programlisting>
<para>
Creates a new contact with the contents of <parameter>vcard</parameter> in <parameter>backend</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="EBookBackendSync"><type>EBookBackendSync</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>book</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="EDataBook"><type>EDataBook</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>opid</parameter>&nbsp;:</term>
<listitem><simpara> the unique ID of the operation
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>vcard</parameter>&nbsp;:</term>
<listitem><simpara> a VCard representation of a contact
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>contact</parameter>&nbsp;:</term>
<listitem><simpara> a pointer to a location to store the resulting <link linkend="EContact"><type>EContact</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> An <link linkend="EBookBackendSyncStatus"><type>EBookBackendSyncStatus</type></link> indicating the outcome of the operation.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-book-backend-sync-remove-contacts" role="function"/>e_book_backend_sync_remove_contacts ()</title>
<indexterm><primary>e_book_backend_sync_remove_contacts</primary></indexterm><programlisting><link linkend="EBookBackendSyncStatus">EBookBackendSyncStatus</link> e_book_backend_sync_remove_contacts
                                            (<link linkend="EBookBackendSync">EBookBackendSync</link> *backend,
                                             <link linkend="EDataBook">EDataBook</link> *book,
                                             <link linkend="guint32">guint32</link> opid,
                                             <link linkend="GList">GList</link> *id_list,
                                             <link linkend="GList">GList</link> **removed_ids);</programlisting>
<para>
Removes the contacts specified by <parameter>id_list</parameter> from <parameter>backend</parameter>. The returned list
of removed contacts is in the same format as the passed-in list, and must be
freed by the caller.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="EBookBackendSync"><type>EBookBackendSync</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>book</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="EDataBook"><type>EDataBook</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>opid</parameter>&nbsp;:</term>
<listitem><simpara> the unique ID of the operation
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>id_list</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GList"><type>GList</type></link> of pointers to unique contact ID strings
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>removed_ids</parameter>&nbsp;:</term>
<listitem><simpara> a pointer to a location to store a list of the contacts actually removed
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> An <link linkend="EBookBackendSyncStatus"><type>EBookBackendSyncStatus</type></link> indicating the outcome of the operation.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-book-backend-sync-modify-contact" role="function"/>e_book_backend_sync_modify_contact ()</title>
<indexterm><primary>e_book_backend_sync_modify_contact</primary></indexterm><programlisting><link linkend="EBookBackendSyncStatus">EBookBackendSyncStatus</link> e_book_backend_sync_modify_contact
                                            (<link linkend="EBookBackendSync">EBookBackendSync</link> *backend,
                                             <link linkend="EDataBook">EDataBook</link> *book,
                                             <link linkend="guint32">guint32</link> opid,
                                             const <link linkend="char">char</link> *vcard,
                                             <link linkend="EContact">EContact</link> **contact);</programlisting>
<para>
Modifies the contact specified by the ID embedded in <parameter>vcard</parameter>, to
reflect the full contents of <parameter>vcard</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="EBookBackendSync"><type>EBookBackendSync</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>book</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="EDataBook"><type>EDataBook</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>opid</parameter>&nbsp;:</term>
<listitem><simpara> the unique ID of the operation
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>vcard</parameter>&nbsp;:</term>
<listitem><simpara> the string representation of a contact
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>contact</parameter>&nbsp;:</term>
<listitem><simpara> a pointer to a location to store the resulting <link linkend="EContact"><type>EContact</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> An <link linkend="EBookBackendSyncStatus"><type>EBookBackendSyncStatus</type></link> indicating the outcome of the operation.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-book-backend-sync-get-contact" role="function"/>e_book_backend_sync_get_contact ()</title>
<indexterm><primary>e_book_backend_sync_get_contact</primary></indexterm><programlisting><link linkend="EBookBackendSyncStatus">EBookBackendSyncStatus</link> e_book_backend_sync_get_contact
                                            (<link linkend="EBookBackendSync">EBookBackendSync</link> *backend,
                                             <link linkend="EDataBook">EDataBook</link> *book,
                                             <link linkend="guint32">guint32</link> opid,
                                             const <link linkend="char">char</link> *id,
                                             <link linkend="char">char</link> **vcard);</programlisting>
<para>
Gets a contact from <parameter>book</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="EBookBackendSync"><type>EBookBackendSync</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>book</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="EDataBook"><type>EDataBook</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>opid</parameter>&nbsp;:</term>
<listitem><simpara> the unique ID of the operation
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>id</parameter>&nbsp;:</term>
<listitem><simpara> a unique contact ID
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>vcard</parameter>&nbsp;:</term>
<listitem><simpara> a pointer to a location to store the resulting VCard string
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> An <link linkend="EBookBackendSyncStatus"><type>EBookBackendSyncStatus</type></link> indicating the outcome of the operation.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-book-backend-sync-get-contact-list" role="function"/>e_book_backend_sync_get_contact_list ()</title>
<indexterm><primary>e_book_backend_sync_get_contact_list</primary></indexterm><programlisting><link linkend="EBookBackendSyncStatus">EBookBackendSyncStatus</link> e_book_backend_sync_get_contact_list
                                            (<link linkend="EBookBackendSync">EBookBackendSync</link> *backend,
                                             <link linkend="EDataBook">EDataBook</link> *book,
                                             <link linkend="guint32">guint32</link> opid,
                                             const <link linkend="char">char</link> *query,
                                             <link linkend="GList">GList</link> **contacts);</programlisting>
<para>
Gets a list of contacts from <parameter>book</parameter>. The list and its elements must be freed
by the caller.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="EBookBackendSync"><type>EBookBackendSync</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>book</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="EDataBook"><type>EDataBook</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>opid</parameter>&nbsp;:</term>
<listitem><simpara> the unique ID of the operation
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>query</parameter>&nbsp;:</term>
<listitem><simpara> an s-expression of the query to perform
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>contacts</parameter>&nbsp;:</term>
<listitem><simpara> a pointer to a location to store the resulting list of VCard strings
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> An <link linkend="EBookBackendSyncStatus"><type>EBookBackendSyncStatus</type></link> indicating the outcome of the operation.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-book-backend-sync-get-changes" role="function"/>e_book_backend_sync_get_changes ()</title>
<indexterm><primary>e_book_backend_sync_get_changes</primary></indexterm><programlisting><link linkend="EBookBackendSyncStatus">EBookBackendSyncStatus</link> e_book_backend_sync_get_changes
                                            (<link linkend="EBookBackendSync">EBookBackendSync</link> *backend,
                                             <link linkend="EDataBook">EDataBook</link> *book,
                                             <link linkend="guint32">guint32</link> opid,
                                             const <link linkend="char">char</link> *change_id,
                                             <link linkend="GList">GList</link> **changes);</programlisting>
<para>
Gets the changes made to <parameter>book</parameter> since the last call to this function.
The returned list will contain items of CORBA type
<link linkend="GNOME-Evolution-Addressbook-BookChangeItem"><type>GNOME_Evolution_Addressbook_BookChangeItem</type></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="EBookBackendSync"><type>EBookBackendSync</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>book</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="EDataBook"><type>EDataBook</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>opid</parameter>&nbsp;:</term>
<listitem><simpara> the unique ID of the operation
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>change_id</parameter>&nbsp;:</term>
<listitem><simpara> a unique changes ID
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>changes</parameter>&nbsp;:</term>
<listitem><simpara> a pointer to a location to store the resulting list of changes
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> An <link linkend="EBookBackendSyncStatus"><type>EBookBackendSyncStatus</type></link> indicating the outcome of the operation.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-book-backend-sync-authenticate-user" role="function"/>e_book_backend_sync_authenticate_user ()</title>
<indexterm><primary>e_book_backend_sync_authenticate_user</primary></indexterm><programlisting><link linkend="EBookBackendSyncStatus">EBookBackendSyncStatus</link> e_book_backend_sync_authenticate_user
                                            (<link linkend="EBookBackendSync">EBookBackendSync</link> *backend,
                                             <link linkend="EDataBook">EDataBook</link> *book,
                                             <link linkend="guint32">guint32</link> opid,
                                             const <link linkend="char">char</link> *user,
                                             const <link linkend="char">char</link> *passwd,
                                             const <link linkend="char">char</link> *auth_method);</programlisting>
<para>
Authenticates <parameter>user</parameter> against <parameter>book</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="EBookBackendSync"><type>EBookBackendSync</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>book</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="EDataBook"><type>EDataBook</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>opid</parameter>&nbsp;:</term>
<listitem><simpara> the unique ID of the operation
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user</parameter>&nbsp;:</term>
<listitem><simpara> the user's name
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>passwd</parameter>&nbsp;:</term>
<listitem><simpara> the user's password
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>auth_method</parameter>&nbsp;:</term>
<listitem><simpara> the authentication method desired
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> An <link linkend="EBookBackendSyncStatus"><type>EBookBackendSyncStatus</type></link> indicating the outcome of the operation.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-book-backend-sync-get-required-fields" role="function"/>e_book_backend_sync_get_required_fields ()</title>
<indexterm><primary>e_book_backend_sync_get_required_fields</primary></indexterm><programlisting><link linkend="EBookBackendSyncStatus">EBookBackendSyncStatus</link> e_book_backend_sync_get_required_fields
                                            (<link linkend="EBookBackendSync">EBookBackendSync</link> *backend,
                                             <link linkend="EDataBook">EDataBook</link> *book,
                                             <link linkend="guint32">guint32</link> opid,
                                             <link linkend="GList">GList</link> **fields);</programlisting>
<para>
Gets a list of the fields required for all contacts in <parameter>book</parameter>. The
fields are represented by strings from <link linkend="e-contact-field-name"><type>e_contact_field_name</type></link>. The list
and its contents must be freed by the caller.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="EBookBackendSync"><type>EBookBackendSync</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>book</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="EDataBook"><type>EDataBook</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>opid</parameter>&nbsp;:</term>
<listitem><simpara> the unique ID of the operation
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>fields</parameter>&nbsp;:</term>
<listitem><simpara> a pointer to a location to store the fields
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> An <link linkend="EBookBackendSyncStatus"><type>EBookBackendSyncStatus</type></link> indicating the outcome of the operation.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-book-backend-sync-get-supported-fields" role="function"/>e_book_backend_sync_get_supported_fields ()</title>
<indexterm><primary>e_book_backend_sync_get_supported_fields</primary></indexterm><programlisting><link linkend="EBookBackendSyncStatus">EBookBackendSyncStatus</link> e_book_backend_sync_get_supported_fields
                                            (<link linkend="EBookBackendSync">EBookBackendSync</link> *backend,
                                             <link linkend="EDataBook">EDataBook</link> *book,
                                             <link linkend="guint32">guint32</link> opid,
                                             <link linkend="GList">GList</link> **fields);</programlisting>
<para>
Gets a list of the fields supported for contacts in <parameter>book</parameter>. Other fields
may not be stored. The fields are represented by strings from <link linkend="e-contact-field-name"><type>e_contact_field_name</type></link>.
The list and its contents must be freed by the caller.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="EBookBackendSync"><type>EBookBackendSync</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>book</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="EDataBook"><type>EDataBook</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>opid</parameter>&nbsp;:</term>
<listitem><simpara> the unique ID of the operation
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>fields</parameter>&nbsp;:</term>
<listitem><simpara> a pointer to a location to store the fields
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> An <link linkend="EBookBackendSyncStatus"><type>EBookBackendSyncStatus</type></link> indicating the outcome of the operation.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-book-backend-sync-get-supported-auth-methods" role="function"/>e_book_backend_sync_get_supported_auth_methods ()</title>
<indexterm><primary>e_book_backend_sync_get_supported_auth_methods</primary></indexterm><programlisting><link linkend="EBookBackendSyncStatus">EBookBackendSyncStatus</link> e_book_backend_sync_get_supported_auth_methods
                                            (<link linkend="EBookBackendSync">EBookBackendSync</link> *backend,
                                             <link linkend="EDataBook">EDataBook</link> *book,
                                             <link linkend="guint32">guint32</link> opid,
                                             <link linkend="GList">GList</link> **methods);</programlisting>
<para>
Gets a list of the authentication methods supported by <parameter>book</parameter>. The
methods are represented by strings. The list and its contents must
be freed by the caller.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="EBookBackendSync"><type>EBookBackendSync</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>book</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="EDataBook"><type>EDataBook</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>opid</parameter>&nbsp;:</term>
<listitem><simpara> the unique ID of the operation
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>methods</parameter>&nbsp;:</term>
<listitem><simpara> a pointer to a location to store the methods
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> An <link linkend="EBookBackendSyncStatus"><type>EBookBackendSyncStatus</type></link> indicating the outcome of the operation.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>
