![]() |
![]() |
![]() |
Evolution-Data-Server Manual: Address Book Backend (libedata-book) | ![]() |
---|---|---|---|---|
Top | Description |
struct EBookBackendSync; gboolean e_book_backend_sync_construct (EBookBackendSync *backend
); void e_book_backend_sync_open (EBookBackendSync *backend
,EDataBook *book
,GCancellable *cancellable
,gboolean only_if_exists
,GError **error
); void e_book_backend_sync_remove (EBookBackendSync *backend
,EDataBook *book
,GCancellable *cancellable
,GError **error
); void e_book_backend_sync_refresh (EBookBackendSync *backend
,EDataBook *book
,GCancellable *cancellable
,GError **error
); gboolean e_book_backend_sync_get_backend_property (EBookBackendSync *backend
,EDataBook *book
,GCancellable *cancellable
,const gchar *prop_name
,gchar **prop_value
,GError **error
); gboolean e_book_backend_sync_set_backend_property (EBookBackendSync *backend
,EDataBook *book
,GCancellable *cancellable
,const gchar *prop_name
,const gchar *prop_value
,GError **error
); void e_book_backend_sync_create_contact (EBookBackendSync *backend
,EDataBook *book
,GCancellable *cancellable
,const gchar *vcard
,EContact **contact
,GError **error
); void e_book_backend_sync_remove_contacts (EBookBackendSync *backend
,EDataBook *book
,GCancellable *cancellable
,const GSList *id_list
,GSList **removed_ids
,GError **error
); void e_book_backend_sync_modify_contact (EBookBackendSync *backend
,EDataBook *book
,GCancellable *cancellable
,const gchar *vcard
,EContact **contact
,GError **error
); void e_book_backend_sync_get_contact (EBookBackendSync *backend
,EDataBook *book
,GCancellable *cancellable
,const gchar *id
,gchar **vcard
,GError **error
); void e_book_backend_sync_get_contact_list (EBookBackendSync *backend
,EDataBook *book
,GCancellable *cancellable
,const gchar *query
,GSList **contacts
,GError **error
); void e_book_backend_sync_get_contact_list_uids (EBookBackendSync *backend
,EDataBook *book
,GCancellable *cancellable
,const gchar *query
,GSList **contacts_uids
,GError **error
); void e_book_backend_sync_authenticate_user (EBookBackendSync *backend
,GCancellable *cancellable
,ECredentials *credentials
,GError **error
);
struct EBookBackendSync { EBookBackend parent_object; EBookBackendSyncPrivate *priv; };
gboolean e_book_backend_sync_construct (EBookBackendSync *backend
);
Does nothing.
|
an EBookBackendSync |
Returns : |
TRUE . |
void e_book_backend_sync_open (EBookBackendSync *backend
,EDataBook *book
,GCancellable *cancellable
,gboolean only_if_exists
,GError **error
);
Opens backend
, which can involve connecting it to a remote server.
|
an EBookBackendSync |
|
an EDataBook |
|
a GCancellable for the operation |
|
whether open only if exists |
|
GError to set, when something fails |
Since 3.2
void e_book_backend_sync_remove (EBookBackendSync *backend
,EDataBook *book
,GCancellable *cancellable
,GError **error
);
Remove book
's database and storage overhead from the storage
medium. This will delete all contacts in book
.
|
an EBookBackendSync |
|
an EDataBook |
|
a GCancellable for the operation |
|
GError to set, when something fails |
void e_book_backend_sync_refresh (EBookBackendSync *backend
,EDataBook *book
,GCancellable *cancellable
,GError **error
);
Calls the refresh_sync method on the given backend.
|
An EBookBackendSync object. |
|
An EDataBook object. |
|
a GCancellable for the operation |
|
Out parameter for a GError. |
Since 3.2
gboolean e_book_backend_sync_get_backend_property (EBookBackendSync *backend
,EDataBook *book
,GCancellable *cancellable
,const gchar *prop_name
,gchar **prop_value
,GError **error
);
Calls the get_backend_property_sync method on the given backend.
|
an EBookBackendSync |
|
an EDataBook |
|
a GCancellable for the operation |
|
Property name whose value to retrieve. |
|
Return value of the prop_name . |
|
GError to set, when something fails |
Returns : |
whether processed this property. Returning FALSE means to pass
the call to the EBookBackend parent class, thus neither error should be
set in this case. |
Since 3.2
gboolean e_book_backend_sync_set_backend_property (EBookBackendSync *backend
,EDataBook *book
,GCancellable *cancellable
,const gchar *prop_name
,const gchar *prop_value
,GError **error
);
Calls the set_backend_property_sync method on the given backend.
|
an EBookBackendSync |
|
an EDataBook |
|
a GCancellable for the operation |
|
Property name to set. |
|
New value of the prop_name . |
|
GError to set, when something fails |
Returns : |
whether processed this property. Returning FALSE means to pass
the call to the EBookBackend parent class, thus neither error should be
set in this case. |
Since 3.2
void e_book_backend_sync_create_contact (EBookBackendSync *backend
,EDataBook *book
,GCancellable *cancellable
,const gchar *vcard
,EContact **contact
,GError **error
);
Creates a new contact with the contents of vcard
in backend
.
|
an EBookBackendSync |
|
an EDataBook |
|
a GCancellable for the operation |
|
a VCard representation of a contact |
|
a pointer to a location to store the resulting EContact |
|
GError to set, when something fails |
void e_book_backend_sync_remove_contacts (EBookBackendSync *backend
,EDataBook *book
,GCancellable *cancellable
,const GSList *id_list
,GSList **removed_ids
,GError **error
);
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 |
|
a GCancellable for the operation |
|
a GSList of pointers to unique contact ID strings |
|
a pointer to a location to store a list of the contacts actually removed |
|
GError to set, when something fails |
void e_book_backend_sync_modify_contact (EBookBackendSync *backend
,EDataBook *book
,GCancellable *cancellable
,const gchar *vcard
,EContact **contact
,GError **error
);
Modifies the contact specified by the ID embedded in vcard
, to
reflect the full contents of vcard
.
|
an EBookBackendSync |
|
an EDataBook |
|
a GCancellable for the operation |
|
the string representation of a contact |
|
a pointer to a location to store the resulting EContact |
|
GError to set, when something fails |
void e_book_backend_sync_get_contact (EBookBackendSync *backend
,EDataBook *book
,GCancellable *cancellable
,const gchar *id
,gchar **vcard
,GError **error
);
Gets a contact from book
.
|
an EBookBackendSync |
|
an EDataBook |
|
a GCancellable for 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
,GCancellable *cancellable
,const gchar *query
,GSList **contacts
,GError **error
);
Gets a list of contacts from book
. The list and its elements must be freed
by the caller.
|
an EBookBackendSync |
|
an EDataBook |
|
a GCancellable for the operation |
|
an s-expression of the query to perform |
|
a pointer to a location to store the resulting list of VCard strings |
|
GError to set, when something fails |
void e_book_backend_sync_get_contact_list_uids (EBookBackendSync *backend
,EDataBook *book
,GCancellable *cancellable
,const gchar *query
,GSList **contacts_uids
,GError **error
);
Gets a list of contact UIDS from book
. The list and its elements must be freed
by the caller.
|
an EBookBackendSync |
|
an EDataBook |
|
a GCancellable for the operation |
|
an s-expression of the query to perform |
|
a pointer to a location to store the resulting list of UID strings |
|
GError to set, when something fails |
Since 3.2
void e_book_backend_sync_authenticate_user (EBookBackendSync *backend
,GCancellable *cancellable
,ECredentials *credentials
,GError **error
);
Authenticates backend
with given credentials
.
|
an EBookBackendSync |
|
a GCancellable for the operation |
|
an ECredentials to authenticate with |
|
GError to set, when something fails |