The #EBookCache being used for this meta backend.
Adds view to backend for querying.
an #EDataBookView
Creates a binding between source_property on source and target_property
on target.
Whenever the source_property is changed the target_property is
updated using the same value. For instance:
g_object_bind_property (action, "active", widget, "sensitive", 0);
Will result in the "sensitive" property of the widget #GObject instance to be updated with the same value of the "active" property of the action #GObject instance.
If flags contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well.
The binding will automatically be removed when either the source or the
target instances are finalized. To remove the binding without affecting the
source and the target you can just call g_object_unref() on the returned
#GBinding instance.
Removing the binding by calling g_object_unref() on it must only be done if
the binding, source and target are only used from a single thread and it
is clear that both source and target outlive the binding. Especially it
is not safe to rely on this if the binding, source or target can be
finalized from different threads. Keep another reference to the binding and
use g_binding_unbind() instead to be on the safe side.
A #GObject can have multiple bindings.
the property on source to bind
the target #GObject
the property on target to bind
flags to pass to #GBinding
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers.
the property on source to bind
the target #GObject
the property on target to bind
flags to pass to #GBinding
a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default
a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default
This method is called on backend in direct read access mode.
The config argument is the same configuration string which
the same backend reported in the #EDataBookDirect returned
by e_book_backend_get_direct_book().
The configuration string is optional and is used to ensure that direct access backends are properly configured to interface with the same data as the running server side backend.
The configuration string for the given backend
This is called always before any operation which requires a connection to the remote side. It can fail with an #E_CLIENT_ERROR_REPOSITORY_OFFLINE error to indicate that the remote side cannot be currently reached. Other errors are propagated to the caller/client side. This method is not called when the backend is offline.
The descendant should also call e_book_backend_set_writable() after successful connect to the remote side. This value is stored for later use, when being opened offline.
The credentials parameter consists of the previously used credentials.
It's always %NULL with the first connection attempt. To get the credentials,
just set the out_auth_result to %E_SOURCE_AUTHENTICATION_REQUIRED for
the first time and the function will be called again once the credentials
are available. See the documentation of #ESourceAuthenticationResult for
other available results.
The out parameters are passed to e_backend_schedule_credentials_required()
and are ignored when the descendant returns %TRUE, aka they are used
only if the connection fails. The out_certificate_pem and out_certificate_errors
should be used together and they can be left untouched if the failure reason was
not related to certificate. Use out_auth_result %E_SOURCE_AUTHENTICATION_UNKNOWN
to indicate other error than credentials error, otherwise the error is used
according to out_auth_result value.
It is mandatory to implement this virtual method by the descendant.
an #ENamedParameters with previously used credentials, or %NULL
optional #GCancellable object, or %NULL
Checks whether contains an email_address. When the email_address
contains multiple addresses, then returns %TRUE when at least one
address exists in the address book.
If an error occurs, the function will set error and return %FALSE.
Finishes the operation started with e_book_backend_contains_email().
If an error occurred, the function will set error and return %FALSE.
a #GAsyncResult
Checks whether contains an email_address. When the email_address
contains multiple addresses, then returns %TRUE when at least one
address exists in the address book.
If an error occurs, the function will set error and return %FALSE.
an email address
optional #GCancellable object, or %NULL
Creates one or more new contacts from vcards, and deposits an #EContact
instance for each newly-created contact in out_contacts.
The returned #EContact instances are referenced for thread-safety and must be unreferenced with g_object_unref() when finished with them.
If an error occurs, the function will set error and return %FALSE.
Finishes the operation started with e_book_backend_create_contacts().
An #EContact instance for each newly-created contact is deposited in
out_contacts. The returned #EContact instances are referenced for
thread-safety and must be unreferenced with g_object_unref() when
finished with them.
If an error occurred, the function will set error and return %FALSE.
a #GAsyncResult
a #GQueue in which to deposit results
Creates one or more new contacts from vcards, and deposits an #EContact
instance for each newly-created contact in out_contacts.
The returned #EContact instances are referenced for thread-safety and must be unreferenced with g_object_unref() when finished with them.
If an error occurs, the function will set error and return %FALSE.
a %NULL-terminated array of vCard strings
bit-or of #EBookOperationFlags
a #GQueue in which to deposit results
optional #GCancellable object, or %NULL
Creates a new #EDataBookCursor for the given backend if the backend
has cursor support. If the backend does not support cursors then
an %E_CLIENT_ERROR_NOT_SUPPORTED error will be set in error.
Backends can also refuse to create cursors for some values of sort_fields
and report more specific errors.
The returned cursor belongs to backend and should be destroyed
with e_book_backend_delete_cursor() when no longer needed.
the #EContactFields to sort by
the #EBookCursorSortTypes for the sorted fields
the number of fields in the sort_fields and sort_types
Asynchronously calls the e_backend_credentials_required_sync() on the backend,
to inform clients that credentials are required.
When the operation is finished, callback will be called. You can then
call e_backend_credentials_required_finish() to get the result of the operation.
an #ESourceCredentialsReason, why the credentials are required
PEM-encoded secure connection certificate, or an empty string
a bit-or of #GTlsCertificateFlags for secure connection certificate
a #GError with a description of the previous credentials error, or %NULL
optional #GCancellable object, or %NULL
a #GAsyncReadyCallback to call when the request is satisfied
Finishes the operation started with e_backend_credentials_required().
If an error occurs, the function sets error and returns %FALSE.
a #GAsyncResult
Synchronously lets the clients know that the backned requires credentials to be properly opened. It's a proxy function for e_source_invoke_credentials_required_sync(), where can be found more information about actual parameters meaning.
The provided credentials are received through #EBackendClass.authenticate_sync() method asynchronously.
If an error occurs, the function sets error and returns %FALSE.
an #ESourceCredentialsReason, why the credentials are required
PEM-encoded secure connection certificate, or an empty string
a bit-or of #GTlsCertificateFlags for secure connection certificate
a #GError with a description of the previous credentials error, or %NULL
optional #GCancellable object, or %NULL
Requests backend to release and destroy cursor, this
will trigger an %E_CLIENT_ERROR_INVALID_ARG error if cursor
is not owned by backend.
the #EDataBookCursor to destroy
This is called when the backend goes into offline mode or
when the disconnect is required. The implementation should
not report any error when it is called and the meta_backend
is not connected.
It is mandatory to implement this virtual method by the descendant.
optional #GCancellable object, or %NULL
Thread-safe variation of e_book_backend_get_cache_dir().
Use this function when accessing backend from multiple threads.
The returned string should be freed with g_free() when no longer needed.
Fetches a copy of the currently configured locale for the addressbook
Returns the last known synchronization tag, the same as used to call e_book_meta_backend_get_changes_sync().
Free the returned string with g_free(), when no longer needed.
Empties the local cache by removing all known contacts from it and notifies about such removal any opened views.
optional #GCancellable object, or %NULL
Ensures that the meta_backend is connected to its destination.
optional #GCancellable object, or %NULL
Makes sure that the "online" property is updated, that is, if there is any destination reachability test pending, it'll be done immediately and the only state will be updated as well.
optional #GCancellable object, or %NULL
Makes sure that the associated ESource::connection-status is connected. This is useful in cases when the backend can connect to the destination without invoking #EBackendClass.authenticate_sync(), possibly through e_backend_schedule_authenticate().
This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().
Calls func for each existing view (as returned by e_book_backend_list_views()).
The func can return %FALSE to stop early.
Notifies each view of the backend about progress. When only_completed_views
is %TRUE, notifies only completed views.
whether notify in completed views only
percent complete
message describing the operation in progress, or %NULL
Increases the freeze count on object. If the freeze count is
non-zero, the emission of "notify" signals on object is
stopped. The signals are queued until the freeze count is decreased
to zero. Duplicate notifications are squashed so that at most one
#GObject::notify signal is emitted for each property modified while the
object is frozen.
This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.
Obtains the value of the backend property named prop_name.
Freed the returned string with g_free() when finished with it.
a backend property name
Returns the cache directory path used by backend.
Gathers the changes since the last check which had been done on the remote side.
The last_sync_tag can be used as a tag of the last check. This can be %NULL,
when there was no previous call or when the descendant doesn't store any
such tags. The out_new_sync_tag can be populated with a value to be stored
and used the next time.
The out_repeat can be set to %TRUE when the descendant didn't finish
read of all the changes. In that case the meta_backend calls this
function again with the out_new_sync_tag as the last_sync_tag, but also
notifies about the found changes immediately. The is_repeat is set
to %TRUE as well in this case, otherwise it's %FALSE.
The descendant can populate also EBookMetaBackendInfo::object of
the out_created_objects and out_modified_objects, if known, in which
case this will be used instead of loading it with e_book_meta_backend_load_contact_sync().
It is optional to implement this virtual method by the descendant. The default implementation calls e_book_meta_backend_list_existing_sync() and then compares the list with the current content of the local cache and populates the respective lists appropriately.
Each output #GSList should be freed with g_slist_free_full (objects, e_book_meta_backend_info_free); when no longer needed.
optional sync tag from the last check
set to %TRUE when this is the repeated call
optional #GCancellable object, or %NULL
This value has meaning only if e_book_meta_backend_get_ever_connected() is %TRUE.
Obtains an #EContact for uid.
The returned #EContact is referenced for thread-safety and must be unreferenced with g_object_unref() when finished with it.
If an error occurs, the function will set error and return %NULL.
Finishes the operation started with e_book_backend_get_contact_finish().
The returned #EContact is referenced for thread-safety and must be unreferenced with g_object_unref() when finished with it.
If an error occurred, the function will set error and return %NULL.
a #GAsyncResult
Obtains a set of #EContact instances which satisfy the criteria specified
in query, and deposits them in out_contacts.
The returned #EContact instances are referenced for thread-safety and must be unreferenced with g_object_unref() when finished with them.
If an error occurs, the function will set error and return %FALSE.
Note that an empty result set does not necessarily imply an error.
Finishes the operation started with e_book_backend_get_contact_list().
The matching #EContact instances are deposited in out_contacts. The
returned #EContact instances are referenced for thread-safety and must
be unreferenced with g_object_unref() when finished with them.
If an error occurred, the function will set error and return %FALSE.
Note that an empty result set does not necessarily imply an error.
a #GAsyncResult
a #GQueue in which to deposit results
Obtains a set of #EContact instances which satisfy the criteria specified
in query, and deposits them in out_contacts.
The returned #EContact instances are referenced for thread-safety and must be unreferenced with g_object_unref() when finished with them.
If an error occurs, the function will set error and return %FALSE.
Note that an empty result set does not necessarily imply an error.
a search query in S-expression format
a #GQueue in which to deposit results
optional #GCancellable object, or %NULL
Obtains a set of ID strings for contacts which satisfy the criteria
specified in query, and deposits them in out_uids.
The returned ID strings must be freed with g_free() with finished with them.
If an error occurs, the function will set error and return %FALSE.
Note that an empty result set does not necessarily imply an error.
Finishes the operation started with e_book_backend_get_contact_list_uids_finish().
ID strings for the matching contacts are deposited in out_uids, and
must be freed with g_free() when finished with them.
If an error occurs, the function will set error and return %FALSE.
Note that an empty result set does not necessarily imply an error.
a #GAsyncResult
a #GQueue in which to deposit results
Obtains a set of ID strings for contacts which satisfy the criteria
specified in query, and deposits them in out_uids.
The returned ID strings must be freed with g_free() with finished with them.
If an error occurs, the function will set error and return %FALSE.
Note that an empty result set does not necessarily imply an error.
a search query in S-expression format
a #GQueue in which to deposit results
optional #GCancellable object, or %NULL
Obtains an #EContact for uid.
The returned #EContact is referenced for thread-safety and must be unreferenced with g_object_unref() when finished with it.
If an error occurs, the function will set error and return %NULL.
a contact ID
optional #GCancellable object, or %NULL
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
Provides destination server host name and port to which
the backend connects. This is used to determine required
connection point for e_backend_is_destination_reachable().
The host is a newly allocated string, which will be freed
with g_free(). When backend sets both host and port, then
it should return %TRUE, indicating it's a remote backend.
Default implementation returns %FALSE, which is treated
like the backend is local, no checking for server reachability
is possible.
Tries to create an #EDataBookDirect for backend if
backend supports direct read access.
Returns the online state of backend: %TRUE if backend is online,
%FALSE if offline.
If the #EBackend:connectable property is non-%NULL, the backend will
automatically determine whether the network service should be reachable,
and hence whether the backend is #EBackend:online. But subclasses may
override the online state if, for example, a connection attempt fails.
Gets a property of an object.
The value can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().
Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.
the name of the property to get
return location for the property value
This function gets back user data pointers stored via g_object_set_qdata().
A #GQuark, naming the user data pointer
Returns the data source registry to which #EBackend:source belongs.
Returns the #ESource to which backend is paired.
It is optional to implement this virtual method by the descendants. It is used to receive SSL error details when any online operation returns E_CLIENT_ERROR, E_CLIENT_ERROR_TLS_NOT_AVAILABLE error.
Gets an instance of #EUserPrompter, associated with this backend.
The returned instance is owned by the backend.
Returns whether backend will accept changes to its data content.
Gets n_properties properties for an object.
Obtained properties will be set to values. All properties must be valid.
Warnings will be emitted and undefined behaviour may result if invalid
properties are passed in.
the names of each property to get
the values of each property to get
Changes all URL photos and logos which point to a local file in contact
to inline type, aka adds the file content into the contact.
This is called automatically before e_book_meta_backend_save_contact_sync().
The reverse operation is e_book_meta_backend_store_inline_photos_sync().
an #EContact to work with
optional #GCancellable object, or %NULL
Checks whether the backend<!-- -->'s destination server, as returned
by e_backend_get_destination_address(), is reachable.
If the e_backend_get_destination_address() returns %FALSE, this function
returns %TRUE, meaning the destination is always reachable.
This uses #GNetworkMonitor's g_network_monitor_can_reach()
for reachability tests.
a #GCancellable instance, or %NULL
Checks whether object has a [floating][floating-ref] reference.
Checks if backend's storage has been opened (and
authenticated, if necessary) and the backend itself
is ready for accessing. This property is changed automatically
after the backend is successfully opened.
Checks if we can write to backend.
Used to get list of all existing objects on the remote side. The descendant
can optionally provide out_new_sync_tag, which will be stored on success, if
not %NULL. The descendant can populate also EBookMetaBackendInfo::object of
the out_existing_objects, if known, in which case this will be used instead
of loading it with e_book_meta_backend_load_contact_sync().
It is mandatory to implement this virtual method by the descendant, unless it implements its own #EBookMetaBackendClass.get_changes_sync().
The out_existing_objects #GSList should be freed with
g_slist_free_full (objects, e_book_meta_backend_info_free);
when no longer needed.
optional #GCancellable object, or %NULL
Returns a list of #EDataBookView instances added with e_book_backend_add_view().
The views returned in the list are referenced for thread-safety. They must each be unreferenced with g_object_unref() when finished with them. Free the returned list itself with g_list_free().
An easy way to free the list properly in one step is as follows:
|[ g_list_free_full (list, g_object_unref);
Loads a contact from the remote side.
It is mandatory to implement this virtual method by the descendant.
The returned out_contact should be freed with g_object_unref(),
when no longer needed.
The returned out_extra should be freed with g_free(), when no longer
needed.
a contact UID
optional extra data stored with the contact, or %NULL
optional #GCancellable object, or %NULL
Modifies one or more contacts according to vcards.
If an error occurs, the function will set error and return %FALSE.
Finishes the operation started with e_book_backend_modify_contacts().
If an error occurred, the function will set error and return %FALSE.
a #GAsyncResult
Modifies one or more contacts according to vcards.
If an error occurs, the function will set error and return %FALSE.
a %NULL-terminated array of vCard strings
bit-or of #EBookOperationFlags
optional #GCancellable object, or %NULL
Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.
Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.
the name of a property installed on the class of object.
Emits a "notify" signal for the property specified by pspec on object.
This function omits the property name lookup, hence it is faster than g_object_notify().
One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:
enum
{
PROP_0,
PROP_FOO,
PROP_LAST
};
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
0, 100,
50,
G_PARAM_READWRITE);
g_object_class_install_property (gobject_class,
PROP_FOO,
properties[PROP_FOO]);
}
and then notify a change on the "foo" property with:
g_object_notify_by_pspec (self, properties[PROP_FOO]);
the #GParamSpec of a property installed on the class of object.
Notifies all of backend's book views that the current set of
notifications is complete; use this after a series of
e_book_backend_notify_update() and e_book_backend_notify_remove() calls.
Notifies each backend listener about an error. This is meant to be used for cases where is no GError return possibility, to notify user about an issue.
an error message
Notifies clients about property value change.
property name, which changed
new property value
Notifies all of backend's book views that the contact with UID
id has been removed.
e_data_book_respond_remove_contacts() calls this function for you. You only need to call this from your backend if contacts are removed by another (non-PAS-using) client.
a contact id
Notifies all of backend's book views about the new or modified
contacts contact.
e_data_book_respond_create_contacts() and e_data_book_respond_modify_contacts() call this function for you. You only need to call this from your backend if contacts are created or modified by another (non-PAS-using) client.
a new or modified contact
"Opens" the backend. Opening a backend is something of an outdated
concept, but the operation is hanging around for a little while longer.
This usually involves some custom initialization logic, and testing of
remote authentication if applicable.
If an error occurs, the function will set error and return %FALSE.
Finishes the operation started with e_book_backend_open().
If an error occurred, the function will set error and return %FALSE.
a #GAsyncResult
"Opens" the backend. Opening a backend is something of an outdated
concept, but the operation is hanging around for a little while longer.
This usually involves some custom initialization logic, and testing of
remote authentication if applicable.
If an error occurs, the function will set error and return %FALSE.
optional #GCancellable object, or %NULL
Obtains the #GSimpleAsyncResult for opid and sets result_queue as a
place to deposit results prior to completing the #GSimpleAsyncResult.
an operation ID given to #EDataBook
return location for a #GQueue, or %NULL
Let's the backend know that it'll be shut down shortly, no client connects
to it anymore. The backend can free any resources which reference it, for
example the opened views.
Processes given changes by updating local cache content accordingly.
The meta_backend processes the changes like being online and particularly
requires to be online to load created and modified objects when needed.
a #GSList of #EBookMetaBackendInfo object infos which had been created
a #GSList of #EBookMetaBackendInfo object infos which had been modified
a #GSList of #EBookMetaBackendInfo object infos which had been removed
optional #GCancellable object, or %NULL
Returns the socket endpoint for the network service to which backend
is a client, or %NULL if backend does not use network sockets.
The initial value of the #EBackend:connectable property is derived from
the #ESourceAuthentication extension of the backend's #EBackend:source
property, if the extension is present.
The returned #GSocketConnectable is referenced for thread-safety and must be unreferenced with g_object_unref() when finished with it.
Returns the #EDataBook for backend. The #EDataBook is essentially
the glue between incoming D-Bus requests and backend's native API.
An #EDataBook should be set only once after backend is first created.
If an #EDataBook has not yet been set, the function returns %NULL.
The returned #EDataBook is referenced for thread-safety and must be unreferenced with g_object_unref() when finished with it.
Returns the #GMainContext on which event sources for backend are to
be attached.
The returned #GMainContext is referenced for thread-safety and must be unreferenced with g_main_context_unref() when finished with it.
Returns the #GProxyResolver for backend (if applicable), as indicated
by the #ESourceAuthentication:proxy-uid of backend's #EBackend:source
or one of its ancestors.
The returned #GProxyResolver is referenced for thread-safety and must be unreferenced with g_object_unref() when finished with it.
Increase the reference count of object, and possibly remove the
[floating][floating-ref] reference, if object has a floating reference.
In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.
Since GLib 2.56, the type of object will be propagated to the return type
under the same conditions as for g_object_ref().
Initiates a refresh for backend, if the backend supports refreshing.
The actual refresh operation completes on its own time. This function
merely initiates the operation.
If an error occurs while initiating the refresh, the function will set
error and return %FALSE. If the backend does not support refreshing,
the function will set an %E_CLIENT_ERROR_NOT_SUPPORTED error and return
%FALSE.
Finishes the refresh initiation started with e_book_backend_refresh().
If an error occurred while initiating the refresh, the function will set
error and return %FALSE. If the backend does not support refreshing,
the function will set an %E_CLIENT_ERROR_NOT_SUPPORTED error and return
%FALSE.
a #GAsyncResult
Refreshes the meta_backend immediately. To just schedule refresh
operation call e_book_meta_backend_schedule_refresh().
optional #GCancellable object, or %NULL
Removes a contact from the remote side. The object is not %NULL when
it's removing locally deleted object in offline mode. Being it %NULL,
the descendant can obtain the object from the #EBookCache.
It is mandatory to implement this virtual method by the writable descendant.
an #EConflictResolution to use
a contact UID
extra data being saved with the contact in the local cache, or %NULL
corresponding vCard object, as stored in the local cache, or %NULL
bit-or of #EBookOperationFlags
optional #GCancellable object, or %NULL
Removes one or more contacts according to uids.
If an error occurs, the function will set error and return %FALSE.
Finishes the operation started with e_book_backend_remove_contacts().
If an error occurred, the function will set error and return %FALSE.
a #GAsyncResult
Removes one or more contacts according to uids.
If an error occurs, the function will set error and return %FALSE.
a %NULL-terminated array of contact ID strings
bit-or of #EBookOperationFlags
optional #GCancellable object, or %NULL
Removes view from backend.
an #EDataBookView
Determines, whether current source content requires reconnect of the backend.
It is optional to implement this virtual method by the descendant. The default implementation compares %E_SOURCE_EXTENSION_AUTHENTICATION and %E_SOURCE_EXTENSION_WEBDAV_BACKEND, if existing in the source, with the values after the last successful connect and returns %TRUE when they changed. It always return %TRUE when there was no successful connect done yet.
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
Saves one contact into the remote side. When the overwrite_existing is %TRUE, then
the descendant can overwrite an object with the same UID on the remote side
(usually used for modify). The conflict_resolution defines what to do when
the remote side had made any changes to the object since the last update.
The contact has already converted locally stored photos and logos
into inline variants, thus it's not needed to call
e_book_meta_backend_inline_local_photos_sync() by the descendant.
The out_new_uid can be populated with a UID of the saved contact as the server
assigned it to it. This UID, if set, is loaded from the remote side afterwards,
also to see whether any changes had been made to the contact by the remote side.
The out_new_extra can be populated with a new extra data to save with the contact.
Left it %NULL, to keep the same value as the extra.
The descendant can use an #E_CLIENT_ERROR_OUT_OF_SYNC error to indicate that
the save failed due to made changes on the remote side, and let the meta_backend
resolve this conflict based on the conflict_resolution on its own.
The #E_CLIENT_ERROR_OUT_OF_SYNC error should not be used when the descendant
is able to resolve the conflicts itself.
It is mandatory to implement this virtual method by the writable descendant.
%TRUE when can overwrite existing contacts, %FALSE otherwise
one of #EConflictResolution, what to do on conflicts
an #EContact to save
extra data saved with the contacts in an #EBookCache
bit-or of EBookOperationFlags
optional #GCancellable object, or %NULL
Schedules a new authenticate session, cancelling any previously run.
This is usually done automatically, when an 'authenticate' signal is
received for the associated #ESource. With %NULL credentials an attempt
without it is run.
a credentials to use to authenticate, or %NULL
Asynchronously invokes e_backend_credentials_required(), but installs its
own callback which only prints a runtime warning on the console when
the call fails. The who_calls is a prefix of the console message.
This is useful when the caller just wants to start the operation
without having actual place where to show the operation result.
an #ESourceCredentialsReason, why the credentials are required
PEM-encoded secure connection certificate, or an empty string
a bit-or of #GTlsCertificateFlags for secure connection certificate
a #GError with a description of the previous credentials error, or %NULL
optional #GCancellable object, or %NULL
an identification who calls this
Schedules user function func to be run in a dedicated thread as
a blocking operation.
The function adds its own reference to use_cancellable, if not %NULL.
The error returned from func is propagated to client using
e_book_backend_notify_error() function. If it's not desired,
then left the error unchanged and notify about errors manually.
an optional #GCancellable to use for func
a function to call in a dedicated thread
Schedules refresh of the content of the meta_backend. If there's any
already scheduled, then the function does nothing.
Use e_book_meta_backend_refresh_sync() to refresh the meta_backend
immediately.
Searches meta_backend with given expression expr and returns
found contacts as a #GSList of #EContact out_contacts.
Free the returned out_contacts with g_slist_free_full (contacts, g_object_unref);
when no longer needed.
When the expr is %NULL, all objects are returned. To get
UID-s instead, call e_book_meta_backend_search_uids_sync().
It is optional to implement this virtual method by the descendant.
The default implementation searches meta_backend's cache. It's also
not required to be online for searching, thus meta_backend doesn't
ensure it.
a search expression, or %NULL
%TRUE, when return #EContact filled with UID and REV only, %FALSE to return full contacts
optional #GCancellable object, or %NULL
Searches meta_backend with given expression expr and returns
found contact UID-s as a #GSList out_contacts.
Free the returned out_uids with g_slist_free_full (uids, g_free);
when no longer needed.
When the expr is %NULL, all UID-s are returned. To get #EContact(s)
instead, call e_book_meta_backend_search_sync().
It is optional to implement this virtual method by the descendant.
The default implementation searches meta_backend's cache. It's also
not required to be online for searching, thus meta_backend doesn't
ensure it.
a search expression, or %NULL
optional #GCancellable object, or %NULL
Sets the cache as the cache to be used by the meta_backend.
By default, a cache.db in EBookBackend::cache-dir is created
in the constructed method. This function can be used to override
the default.
Note the meta_backend adds its own reference to the cache.
an #EBookCache to use
Sets the cache directory path for use by backend.
Note that #EBookBackend is initialized with a default cache directory path which should suffice for most cases. Backends should not override the default path without good reason.
a local cache directory path
Sets the socket endpoint for the network service to which backend is
a client. This can be %NULL if backend does not use network sockets.
The initial value of the #EBackend:connectable property is derived from
the #ESourceAuthentication extension of the backend's #EBackend:source
property, if the extension is present.
a #GSocketConnectable, or %NULL
Sets whether the meta_backend connected to a writable destination.
This value has meaning only if e_book_meta_backend_get_ever_connected()
is %TRUE.
This is used by the meta_backend itself, during the opening phase,
to set the backend writable or not also in the offline mode.
value to set
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
If the object already had an association with that name, the old association will be destroyed.
Internally, the key is converted to a #GQuark using g_quark_from_string().
This means a copy of key is kept permanently (even after object has been
finalized) — so it is recommended to only use a small, bounded set of values
for key in your program, to avoid the #GQuark storage growing unbounded.
name of the key
data to associate with that key
Sets the #EDataBook for backend. The #EDataBook is essentially the
glue between incoming D-Bus requests and backend's native API.
An #EDataBook should be set only once after backend is first created.
an #EDataBook
Sets whether the meta_backend ever made a successful connection
to its destination.
This is used by the meta_backend itself, during the opening phase,
when it had not been connected yet, then it does so immediately, to
eventually report settings error easily.
value to set
Notify the addressbook backend that the current locale has changed, this is important for backends which support ordered result lists which are locale sensitive.
the new locale for the addressbook
optional #GCancellable object, or %NULL
Sets the online state of backend: %TRUE if backend is online,
FALSE if offline.
If the #EBackend:connectable property is non-%NULL, the backend will
automatically determine whether the network service should be reachable,
and hence whether the backend is #EBackend:online. But subclasses may
override the online state if, for example, a connection attempt fails.
the online state
Sets a property on an object.
the name of the property to set
the value
Sets whether backend will accept changes to its data content.
whether backend is writable
Splits objects into created/modified/removed lists according to current local
cache content. Only the out_removed_objects can be %NULL, others cannot.
The function modifies objects by moving its 'data' to corresponding out
lists and sets the objects 'data' to %NULL.
Each output #GSList should be freed with g_slist_free_full (objects, e_book_meta_backend_info_free); when no longer needed.
The caller is still responsible to free objects as well.
a #GSList of #EBookMetaBackendInfo object infos to split
optional #GCancellable object, or %NULL
Starts running the query specified by view, emitting signals for
matching contacts.
the #EDataBookView to start
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
This function gets back user data pointers stored via
g_object_set_qdata() and removes the data from object
without invoking its destroy() function (if any was
set).
Usually, calling this function is only required to update
user data pointers with a destroy notifier, for example:
void
object_add_to_user_list (GObject *object,
const gchar *new_string)
{
// the quark, naming the object data
GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
// retrieve the old string list
GList *list = g_object_steal_qdata (object, quark_string_list);
// prepend new string
list = g_list_prepend (list, g_strdup (new_string));
// this changed 'list', so we need to set it again
g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
}
static void
free_string_list (gpointer data)
{
GList *node, *list = data;
for (node = list; node; node = node->next)
g_free (node->data);
g_list_free (list);
}
Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().
A #GQuark, naming the user data pointer
Stops running the query specified by view, emitting no more signals.
the #EDataBookView to stop
Changes all inline photos and logos to URL type in contact, which
will point to a local file instead, beside the cache file.
This is called automatically after e_book_meta_backend_load_contact_sync().
The reverse operation is e_book_meta_backend_inline_local_photos_sync().
an #EContact to work with
optional #GCancellable object, or %NULL
Reverts the effect of a previous call to
g_object_freeze_notify(). The freeze count is decreased on object
and when it reaches zero, queued "notify" signals are emitted.
Duplicate notifications for each property are squashed so that at most one #GObject::notify signal is emitted for each property, in the reverse order in which they have been queued.
It is an error to call this function when the freeze count is zero.
Initiates a user trust prompt with given parameters.
When the operation is finished, callback will be called. You can then
call e_backend_trust_prompt_finish() to get the result of the operation.
an #ENamedParameters with values for the trust prompt
optional #GCancellable object, or %NULL
a #GAsyncReadyCallback to call when the request is satisfied
Finishes the operation started with e_backend_trust_prompt().
If an error occurred, the function will set error and return
%E_TRUST_PROMPT_RESPONSE_UNKNOWN.
a #GAsyncResult
Asks a user a trust prompt with given parameters, and returns what
user responded. This blocks until the response is delivered.
an #ENamedParameters with values for the trust prompt
optional #GCancellable object, or %NULL
Decreases the reference count of object. When its reference count
drops to 0, the object is finalized (i.e. its memory is freed).
If the pointer to the #GObject may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to %NULL rather than retain a dangling pointer to a potentially invalid #GObject instance. Use g_clear_object() for this.
This is called always before any operation which requires a connection to the remote side. It can fail with an #E_CLIENT_ERROR_REPOSITORY_OFFLINE error to indicate that the remote side cannot be currently reached. Other errors are propagated to the caller/client side. This method is not called when the backend is offline.
The descendant should also call e_book_backend_set_writable() after successful connect to the remote side. This value is stored for later use, when being opened offline.
The credentials parameter consists of the previously used credentials.
It's always %NULL with the first connection attempt. To get the credentials,
just set the out_auth_result to %E_SOURCE_AUTHENTICATION_REQUIRED for
the first time and the function will be called again once the credentials
are available. See the documentation of #ESourceAuthenticationResult for
other available results.
The out parameters are passed to e_backend_schedule_credentials_required()
and are ignored when the descendant returns %TRUE, aka they are used
only if the connection fails. The out_certificate_pem and out_certificate_errors
should be used together and they can be left untouched if the failure reason was
not related to certificate. Use out_auth_result %E_SOURCE_AUTHENTICATION_UNKNOWN
to indicate other error than credentials error, otherwise the error is used
according to out_auth_result value.
It is mandatory to implement this virtual method by the descendant.
an #ENamedParameters with previously used credentials, or %NULL
optional #GCancellable object, or %NULL
This is called when the backend goes into offline mode or
when the disconnect is required. The implementation should
not report any error when it is called and the meta_backend
is not connected.
It is mandatory to implement this virtual method by the descendant.
optional #GCancellable object, or %NULL
Gathers the changes since the last check which had been done on the remote side.
The last_sync_tag can be used as a tag of the last check. This can be %NULL,
when there was no previous call or when the descendant doesn't store any
such tags. The out_new_sync_tag can be populated with a value to be stored
and used the next time.
The out_repeat can be set to %TRUE when the descendant didn't finish
read of all the changes. In that case the meta_backend calls this
function again with the out_new_sync_tag as the last_sync_tag, but also
notifies about the found changes immediately. The is_repeat is set
to %TRUE as well in this case, otherwise it's %FALSE.
The descendant can populate also EBookMetaBackendInfo::object of
the out_created_objects and out_modified_objects, if known, in which
case this will be used instead of loading it with e_book_meta_backend_load_contact_sync().
It is optional to implement this virtual method by the descendant. The default implementation calls e_book_meta_backend_list_existing_sync() and then compares the list with the current content of the local cache and populates the respective lists appropriately.
Each output #GSList should be freed with g_slist_free_full (objects, e_book_meta_backend_info_free); when no longer needed.
optional sync tag from the last check
set to %TRUE when this is the repeated call
optional #GCancellable object, or %NULL
Provides destination server host name and port to which
the backend connects. This is used to determine required
connection point for e_backend_is_destination_reachable().
The host is a newly allocated string, which will be freed
with g_free(). When backend sets both host and port, then
it should return %TRUE, indicating it's a remote backend.
Default implementation returns %FALSE, which is treated
like the backend is local, no checking for server reachability
is possible.
It is optional to implement this virtual method by the descendants. It is used to receive SSL error details when any online operation returns E_CLIENT_ERROR, E_CLIENT_ERROR_TLS_NOT_AVAILABLE error.
Used to get list of all existing objects on the remote side. The descendant
can optionally provide out_new_sync_tag, which will be stored on success, if
not %NULL. The descendant can populate also EBookMetaBackendInfo::object of
the out_existing_objects, if known, in which case this will be used instead
of loading it with e_book_meta_backend_load_contact_sync().
It is mandatory to implement this virtual method by the descendant, unless it implements its own #EBookMetaBackendClass.get_changes_sync().
The out_existing_objects #GSList should be freed with
g_slist_free_full (objects, e_book_meta_backend_info_free);
when no longer needed.
optional #GCancellable object, or %NULL
Loads a contact from the remote side.
It is mandatory to implement this virtual method by the descendant.
The returned out_contact should be freed with g_object_unref(),
when no longer needed.
The returned out_extra should be freed with g_free(), when no longer
needed.
a contact UID
optional extra data stored with the contact, or %NULL
optional #GCancellable object, or %NULL
Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.
Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.
Let's the backend know that it'll be shut down shortly, no client connects
to it anymore. The backend can free any resources which reference it, for
example the opened views.
Removes a contact from the remote side. The object is not %NULL when
it's removing locally deleted object in offline mode. Being it %NULL,
the descendant can obtain the object from the #EBookCache.
It is mandatory to implement this virtual method by the writable descendant.
an #EConflictResolution to use
a contact UID
extra data being saved with the contact in the local cache, or %NULL
corresponding vCard object, as stored in the local cache, or %NULL
bit-or of #EBookOperationFlags
optional #GCancellable object, or %NULL
Determines, whether current source content requires reconnect of the backend.
It is optional to implement this virtual method by the descendant. The default implementation compares %E_SOURCE_EXTENSION_AUTHENTICATION and %E_SOURCE_EXTENSION_WEBDAV_BACKEND, if existing in the source, with the values after the last successful connect and returns %TRUE when they changed. It always return %TRUE when there was no successful connect done yet.
Saves one contact into the remote side. When the overwrite_existing is %TRUE, then
the descendant can overwrite an object with the same UID on the remote side
(usually used for modify). The conflict_resolution defines what to do when
the remote side had made any changes to the object since the last update.
The contact has already converted locally stored photos and logos
into inline variants, thus it's not needed to call
e_book_meta_backend_inline_local_photos_sync() by the descendant.
The out_new_uid can be populated with a UID of the saved contact as the server
assigned it to it. This UID, if set, is loaded from the remote side afterwards,
also to see whether any changes had been made to the contact by the remote side.
The out_new_extra can be populated with a new extra data to save with the contact.
Left it %NULL, to keep the same value as the extra.
The descendant can use an #E_CLIENT_ERROR_OUT_OF_SYNC error to indicate that
the save failed due to made changes on the remote side, and let the meta_backend
resolve this conflict based on the conflict_resolution on its own.
The #E_CLIENT_ERROR_OUT_OF_SYNC error should not be used when the descendant
is able to resolve the conflicts itself.
It is mandatory to implement this virtual method by the writable descendant.
%TRUE when can overwrite existing contacts, %FALSE otherwise
one of #EConflictResolution, what to do on conflicts
an #EContact to save
extra data saved with the contacts in an #EBookCache
bit-or of EBookOperationFlags
optional #GCancellable object, or %NULL
Searches meta_backend with given expression expr and returns
found contacts as a #GSList of #EContact out_contacts.
Free the returned out_contacts with g_slist_free_full (contacts, g_object_unref);
when no longer needed.
When the expr is %NULL, all objects are returned. To get
UID-s instead, call e_book_meta_backend_search_uids_sync().
It is optional to implement this virtual method by the descendant.
The default implementation searches meta_backend's cache. It's also
not required to be online for searching, thus meta_backend doesn't
ensure it.
a search expression, or %NULL
%TRUE, when return #EContact filled with UID and REV only, %FALSE to return full contacts
optional #GCancellable object, or %NULL
Searches meta_backend with given expression expr and returns
found contact UID-s as a #GSList out_contacts.
Free the returned out_uids with g_slist_free_full (uids, g_free);
when no longer needed.
When the expr is %NULL, all UID-s are returned. To get #EContact(s)
instead, call e_book_meta_backend_search_sync().
It is optional to implement this virtual method by the descendant.
The default implementation searches meta_backend's cache. It's also
not required to be online for searching, thus meta_backend doesn't
ensure it.
a search expression, or %NULL
optional #GCancellable object, or %NULL
This function essentially limits the life time of the closure to
the life time of the object. That is, when the object is finalized,
the closure is invalidated by calling g_closure_invalidate() on
it, in order to prevent invocations of the closure with a finalized
(nonexisting) object. Also, g_object_ref() and g_object_unref() are
added as marshal guards to the closure, to ensure that an extra
reference count is held on object during invocation of the
closure. Usually, this function will be called on closures that
use this object as closure data.
#GClosure to watch
Find the #GParamSpec with the given name for an
interface. Generally, the interface vtable passed in as g_iface
will be the default vtable from g_type_default_interface_ref(), or,
if you know the interface has already been loaded,
g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
name of a property to look up.
Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.
This function is meant to be called from the interface's default
vtable initialization function (the class_init member of
#GTypeInfo.) It must not be called after after class_init has
been called for any object types implementing this interface.
If pspec is a floating reference, it will be consumed.
any interface vtable for the interface, or the default vtable for the interface.
the #GParamSpec for the new property
Lists the properties of an interface.Generally, the interface
vtable passed in as g_iface will be the default vtable from
g_type_default_interface_ref(), or, if you know the interface has
already been loaded, g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
Creates a new instance of a #GObject subtype and sets its properties.
Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.
the type id of the #GObject subtype to instantiate
an array of #GParameter
Contains only private data that should be read and manipulated using the functions below.