|  |  |  | Evolution-Data-Server Manual: Address Book Backend (libedata-book) |  | 
|---|---|---|---|---|
| Top | Description | Object Hierarchy | ||||
struct EBookBackendSync; gboolean e_book_backend_sync_construct (EBookBackendSync *backend); void e_book_backend_sync_remove (EBookBackendSync *backend,EDataBook *book,guint32 opid,GError **perror); void e_book_backend_sync_create_contact (EBookBackendSync *backend,EDataBook *book,guint32 opid,const gchar *vcard,EContact **contact,GError **perror); void e_book_backend_sync_remove_contacts (EBookBackendSync *backend,EDataBook *book,guint32 opid,GList *id_list,GList **removed_ids,GError **perror); void e_book_backend_sync_modify_contact (EBookBackendSync *backend,EDataBook *book,guint32 opid,const gchar *vcard,EContact **contact,GError **perror); void e_book_backend_sync_get_contact (EBookBackendSync *backend,EDataBook *book,guint32 opid,const gchar *id,gchar **vcard,GError **perror); void e_book_backend_sync_get_contact_list (EBookBackendSync *backend,EDataBook *book,guint32 opid,const gchar *query,GList **contacts,GError **perror); void e_book_backend_sync_get_changes (EBookBackendSync *backend,EDataBook *book,guint32 opid,const gchar *change_id,GList **changes,GError **perror); void e_book_backend_sync_authenticate_user (EBookBackendSync *backend,EDataBook *book,guint32 opid,const gchar *user,const gchar *passwd,const gchar *auth_method,GError **perror); void e_book_backend_sync_get_required_fields (EBookBackendSync *backend,EDataBook *book,guint32 opid,GList **fields,GError **perror); void e_book_backend_sync_get_supported_fields (EBookBackendSync *backend,EDataBook *book,guint32 opid,GList **fields,GError **perror); void e_book_backend_sync_get_supported_auth_methods (EBookBackendSync *backend,EDataBook *book,guint32 opid,GList **methods,GError **perror);
gboolean            e_book_backend_sync_construct       (EBookBackendSync *backend);
Does nothing.
| 
 | an EBookBackendSync | 
| Returns : | TRUE. | 
void e_book_backend_sync_remove (EBookBackendSync *backend,EDataBook *book,guint32 opid,GError **perror);
Remove book's database and storage overhead from the storage
medium. This will delete all contacts in book.
| 
 | an EBookBackendSync | 
| 
 | an EDataBook | 
| 
 | the unique ID of the operation | 
void e_book_backend_sync_create_contact (EBookBackendSync *backend,EDataBook *book,guint32 opid,const gchar *vcard,EContact **contact,GError **perror);
Creates a new contact with the contents of vcard in backend.
| 
 | an EBookBackendSync | 
| 
 | an EDataBook | 
| 
 | the unique ID of the operation | 
| 
 | a VCard representation of a contact | 
| 
 | a pointer to a location to store the resulting EContact | 
void e_book_backend_sync_remove_contacts (EBookBackendSync *backend,EDataBook *book,guint32 opid,GList *id_list,GList **removed_ids,GError **perror);
Removes the contacts specified by id_list from backend. The returned list
of removed contacts is in the same format as the passed-in list, and must be
freed by the caller.
| 
 | an EBookBackendSync | 
| 
 | an EDataBook | 
| 
 | the unique ID of the operation | 
| 
 | a GList of pointers to unique contact ID strings | 
| 
 | a pointer to a location to store a list of the contacts actually removed | 
void e_book_backend_sync_modify_contact (EBookBackendSync *backend,EDataBook *book,guint32 opid,const gchar *vcard,EContact **contact,GError **perror);
Modifies the contact specified by the ID embedded in vcard, to
reflect the full contents of vcard.
| 
 | an EBookBackendSync | 
| 
 | an EDataBook | 
| 
 | the unique ID of the operation | 
| 
 | the string representation of a contact | 
| 
 | a pointer to a location to store the resulting EContact | 
void e_book_backend_sync_get_contact (EBookBackendSync *backend,EDataBook *book,guint32 opid,const gchar *id,gchar **vcard,GError **perror);
Gets a contact from book.
| 
 | an EBookBackendSync | 
| 
 | an EDataBook | 
| 
 | the unique ID of the operation | 
| 
 | a unique contact ID | 
| 
 | a pointer to a location to store the resulting VCard string | 
void e_book_backend_sync_get_contact_list (EBookBackendSync *backend,EDataBook *book,guint32 opid,const gchar *query,GList **contacts,GError **perror);
Gets a list of contacts from book. The list and its elements must be freed
by the caller.
| 
 | an EBookBackendSync | 
| 
 | an EDataBook | 
| 
 | the unique ID of the operation | 
| 
 | an s-expression of the query to perform | 
| 
 | a pointer to a location to store the resulting list of VCard strings | 
void e_book_backend_sync_get_changes (EBookBackendSync *backend,EDataBook *book,guint32 opid,const gchar *change_id,GList **changes,GError **perror);
Gets the changes made to book since the last call to this function.
The returned list will contain items of CORBA type
EDataBookChange.
| 
 | an EBookBackendSync | 
| 
 | an EDataBook | 
| 
 | the unique ID of the operation | 
| 
 | a unique changes ID | 
| 
 | a pointer to a location to store the resulting list of changes | 
void e_book_backend_sync_authenticate_user (EBookBackendSync *backend,EDataBook *book,guint32 opid,const gchar *user,const gchar *passwd,const gchar *auth_method,GError **perror);
Authenticates user against book.
| 
 | an EBookBackendSync | 
| 
 | an EDataBook | 
| 
 | the unique ID of the operation | 
| 
 | the user's name | 
| 
 | the user's password | 
| 
 | the authentication method desired | 
void e_book_backend_sync_get_required_fields (EBookBackendSync *backend,EDataBook *book,guint32 opid,GList **fields,GError **perror);
Gets a list of the fields required for all contacts in book. The
fields are represented by strings from e_contact_field_name. The list
and its contents must be freed by the caller.
| 
 | an EBookBackendSync | 
| 
 | an EDataBook | 
| 
 | the unique ID of the operation | 
| 
 | a pointer to a location to store the fields | 
void e_book_backend_sync_get_supported_fields (EBookBackendSync *backend,EDataBook *book,guint32 opid,GList **fields,GError **perror);
Gets a list of the fields supported for contacts in book. Other fields
may not be stored. The fields are represented by strings from e_contact_field_name.
The list and its contents must be freed by the caller.
| 
 | an EBookBackendSync | 
| 
 | an EDataBook | 
| 
 | the unique ID of the operation | 
| 
 | a pointer to a location to store the fields | 
void e_book_backend_sync_get_supported_auth_methods (EBookBackendSync *backend,EDataBook *book,guint32 opid,GList **methods,GError **perror);
Gets a list of the authentication methods supported by book. The
methods are represented by strings. The list and its contents must
be freed by the caller.
| 
 | an EBookBackendSync | 
| 
 | an EDataBook | 
| 
 | the unique ID of the operation | 
| 
 | a pointer to a location to store the methods |