![]() |
![]() |
![]() |
Evolution API Reference: libedata-book, the Addressbook backend library | ![]() |
---|---|---|---|---|
struct EDataBook; EDataBook* e_data_book_new (EBookBackend *backend, ESource *source, GNOME_Evolution_Addressbook_BookListener listener); GNOME_Evolution_Addressbook_BookListener e_data_book_get_listener (EDataBook *book); EBookBackend* e_data_book_get_backend (EDataBook *book); ESource* e_data_book_get_source (EDataBook *book); void e_data_book_respond_open (EDataBook *book, guint32 opid, GNOME_Evolution_Addressbook_CallStatus status); void e_data_book_respond_remove (EDataBook *book, guint32 opid, GNOME_Evolution_Addressbook_CallStatus status); void e_data_book_respond_create (EDataBook *book, guint32 opid, GNOME_Evolution_Addressbook_CallStatus status, EContact *contact); void e_data_book_respond_remove_contacts (EDataBook *book, guint32 opid, GNOME_Evolution_Addressbook_CallStatus status, GList *ids); void e_data_book_respond_modify (EDataBook *book, guint32 opid, GNOME_Evolution_Addressbook_CallStatus status, EContact *contact); void e_data_book_respond_authenticate_user (EDataBook *book, guint32 opid, GNOME_Evolution_Addressbook_CallStatus status); void e_data_book_respond_get_supported_fields (EDataBook *book, guint32 opid, GNOME_Evolution_Addressbook_CallStatus status, GList *fields); void e_data_book_respond_get_required_fields (EDataBook *book, guint32 opid, GNOME_Evolution_Addressbook_CallStatus status, GList *fields); void e_data_book_respond_get_supported_auth_methods (EDataBook *book, guint32 opid, GNOME_Evolution_Addressbook_CallStatus status, GList *fields); void e_data_book_respond_get_book_view (EDataBook *book, guint32 opid, GNOME_Evolution_Addressbook_CallStatus status, EDataBookView *book_view); void e_data_book_respond_get_contact (EDataBook *book, guint32 opid, GNOME_Evolution_Addressbook_CallStatus status, char *vcard); void e_data_book_respond_get_contact_list (EDataBook *book, guint32 opid, GNOME_Evolution_Addressbook_CallStatus status, GList *cards); void e_data_book_respond_get_changes (EDataBook *book, guint32 opid, GNOME_Evolution_Addressbook_CallStatus status, GList *changes); void e_data_book_report_writable (EDataBook *book, gboolean writable); void e_data_book_report_connection_status (EDataBook *book, gboolean is_online); void e_data_book_report_auth_required (EDataBook *book);
EDataBook* e_data_book_new (EBookBackend *backend, ESource *source, GNOME_Evolution_Addressbook_BookListener listener);
Create a new EDataBook using backend
for storage, source
as the
storage location and listener
for reporting status.
|
an EBookBackend |
|
an ESource |
|
a GNOME_Evolution_Addressbook_BookListener CORBA object |
Returns : |
A new EDataBook. |
GNOME_Evolution_Addressbook_BookListener e_data_book_get_listener (EDataBook *book);
Gets the CORBA listener associated with book
.
|
an EDataBook |
Returns : |
A GNOME_Evolution_Addressbook_BookListener. |
EBookBackend* e_data_book_get_backend (EDataBook *book);
Gets the EBookBackend being used to store data for book
.
|
an EDataBook |
Returns : |
The EBookBackend being used. |
ESource* e_data_book_get_source (EDataBook *book);
Gets the ESource associated with book
.
|
an EDataBook |
Returns : |
An ESource. |
void e_data_book_respond_open (EDataBook *book, guint32 opid, GNOME_Evolution_Addressbook_CallStatus status);
Respond to an 'open' request specified by opid
on book
,
indicating status
as the outcome.
|
an EDataBook |
|
the operation ID that generated the response |
|
the outcome of the operation |
void e_data_book_respond_remove (EDataBook *book, guint32 opid, GNOME_Evolution_Addressbook_CallStatus status);
Respond to a 'remove' request to remove all of book
's data,
specified by opid
, indicating status
as the outcome.
|
an EDataBook |
|
the operation ID that generated the response |
|
the outcome of the operation |
void e_data_book_respond_create (EDataBook *book, guint32 opid, GNOME_Evolution_Addressbook_CallStatus status, EContact *contact);
Respond to a 'create' request specified by opid
on book
,
indicating status
as the outcome.
|
an EDataBook |
|
the operation ID that generated the response |
|
the outcome of the operation |
|
the contact created, or NULL
|
void e_data_book_respond_remove_contacts (EDataBook *book, guint32 opid, GNOME_Evolution_Addressbook_CallStatus status, GList *ids);
Respond to a 'remove contacts' request specified by opid
on book
,
indicating status
as the outcome.
|
an EDataBook |
|
the operation ID that generated the response |
|
the outcome of the operation |
|
a list of contact IDs removed |
void e_data_book_respond_modify (EDataBook *book, guint32 opid, GNOME_Evolution_Addressbook_CallStatus status, EContact *contact);
Respond to a 'modify' request specified by opid
on book
,
indicating status
as the outcome.
|
an EDataBook |
|
the operation ID that generated the response |
|
the outcome of the operation |
|
the modified EContact |
void e_data_book_respond_authenticate_user (EDataBook *book, guint32 opid, GNOME_Evolution_Addressbook_CallStatus status);
Respond to an 'authenticate' request specified by opid
on book
,
indicating status
as the outcome.
|
an EDataBook |
|
the operation ID that generated the response |
|
the outcome of the operation |
void e_data_book_respond_get_supported_fields (EDataBook *book, guint32 opid, GNOME_Evolution_Addressbook_CallStatus status, GList *fields);
Respond to a 'get supported fields' request specified by opid
on book
,
indicating status
as the outcome.
|
an EDataBook |
|
the operation ID that generated the response |
|
the outcome of the operation |
|
a list of supported field names |
void e_data_book_respond_get_required_fields (EDataBook *book, guint32 opid, GNOME_Evolution_Addressbook_CallStatus status, GList *fields);
Respond to a 'get required fields' request specified by opid
on book
,
indicating status
as the outcome.
|
an EDataBook |
|
the operation ID that generated the response |
|
the outcome of the operation |
|
a list of required field names |
void e_data_book_respond_get_supported_auth_methods (EDataBook *book, guint32 opid, GNOME_Evolution_Addressbook_CallStatus status, GList *fields);
Respond to a 'get supported auth methods' request specified by opid
on book
,
indicating status
as the outcome.
|
an EDataBook |
|
the operation ID that generated the response |
|
the outcome of the operation |
|
void e_data_book_respond_get_book_view (EDataBook *book, guint32 opid, GNOME_Evolution_Addressbook_CallStatus status, EDataBookView *book_view);
Respond to a 'get book view' request specified by opid
on book
,
indicating status
as the outcome.
|
an EDataBook |
|
the operation ID that generated the response |
|
the outcome of the operation |
|
the EDataBookView created |
void e_data_book_respond_get_contact (EDataBook *book, guint32 opid, GNOME_Evolution_Addressbook_CallStatus status, char *vcard);
Respond to a 'get contact' request specified by opid
on book
,
indicating status
as the outcome.
|
an EDataBook |
|
the operation ID that generated the response |
|
the outcome of the operation |
|
the found VCard, or NULL
|
void e_data_book_respond_get_contact_list (EDataBook *book, guint32 opid, GNOME_Evolution_Addressbook_CallStatus status, GList *cards);
Respond to a 'get contact list' request specified by opid
on book
,
indicating status
as the outcome.
|
an EDataBook |
|
the operation ID that generated the response |
|
the outcome of the operation |
|
void e_data_book_respond_get_changes (EDataBook *book, guint32 opid, GNOME_Evolution_Addressbook_CallStatus status, GList *changes);
Respond to a 'get changes' request specified by opid
on book
,
indicating status
as the outcome.
|
an EDataBook |
|
the operation ID that generated the response |
|
the outcome of the operation |
|
a list of GNOME_Evolution_Addressbook_BookChangeItem items |
void e_data_book_report_writable (EDataBook *book, gboolean writable);
Notify listeners that book
's writeable status has changed
to writable
.
|
an EDataBook |
|
TRUE if book is writeable, FALSE otherwise
|
void e_data_book_report_connection_status (EDataBook *book, gboolean is_online);
Notify listeners that book
requires authentication.
|
an EDataBook |
|