The #ECalCache being used for this meta backend.
Adds a copy of zone to cache and emits an
#ETimezoneCache::timezone-added signal. The cache will use the TZID
string returned by i_cal_timezone_get_tzid() as the lookup key, which can
be passed to e_timezone_cache_get_timezone() to obtain zone again.
If the cache already has an #ICalTimezone with the same TZID string
as zone, the cache will remain unchanged to avoid invalidating any
#ICalTimezone pointers which may have already been returned through
e_timezone_cache_get_timezone().
Finishes the operation started with e_cal_backend_add_timezone().
If an error occurred, the function will set error and return %FALSE.
a #GAsyncResult
Adds the timezone described by tzobject to backend.
If an error occurs, the function will set error and return %FALSE.
an iCalendar VTIMEZONE string
optional #GCancellable object, or %NULL
Adds a view to the list of live views being run by the given backend. Doing so means that any listener on the view will get notified of any change that affect the live view.
An #EDataCalView object.
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 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_cal_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
Calls the create_objects_sync method on the given backend.
Finishes the operation started with e_cal_backend_create_objects().
A unique ID string for each newly-created object is deposited in out_uids.
Free the returned ID strings with g_free() 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 iCalendar objects from calobjs, and deposits
the unique ID string for each newly-created object in out_uids.
Free the returned ID strings with g_free() when finished with them.
If an error occurs, the function will set error and return %FALSE.
a %NULL-terminated array of iCalendar strings
bit-or of #ECalOperationFlags
a #GQueue in which to deposit results
optional #GCancellable object, or %NULL
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
Calls the discard_alarm_sync method on the given backend.
Finishes the operation started with e_cal_backend_discard_alarm().
If an error occurred, the function will set error and return %FALSE.
a #GAsyncResult
Discards the VALARM object with a unique ID of alarm_uid from the
iCalendar object identified by uid and, optionally, rid.
If an error occurs, the function will set error and return %FALSE.
a unique ID for an iCalendar object
a recurrence ID, or %NULL
a unique ID for an iCalendar VALARM object
bit-or of #ECalOperationFlags
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
Thread-safe variation of e_cal_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.
Returns the last known synchronization tag, the same as used to call e_cal_meta_backend_get_changes_sync().
Free the returned string with g_free(), when no longer needed.
Empties the local cache by removing all known components from it and notifies about such removal any opened views. It removes also all known time zones.
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_cal_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.
Extracts all VTIMEZONE components from the vcalendar and adds them
to the memory cache, thus they are available when needed. The function does
nothing when the vcalendar doesn't hold a VCALENDAR component.
Set the remove_existing argument to %TRUE to remove all cached timezones
first and then add the existing in the vcalendar, or set it to %FALSE
to preserver existing timezones and merge them with those in vcalendar.
a VCALENDAR #ICalComponent
whether to remove any existing first
optional #GCancellable object, or %NULL
Calls the get_attachment_uris_sync method on the given backend.
Finishes the operation started with e_cal_backend_get_attachment_uris().
The requested attachment URI strings are deposited in out_attachment_uris.
Free the returned strings with g_free() 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
Inspects the iCalendar object specified by uid and, optionally, rid
for attachments and deposits a URI string for each attachment in
out_attachment_uris. Free the returned strings 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 unique ID for an iCalendar object
a recurrence ID, or %NULL
a #GQueue in which to deposit results
optional #GCancellable object, or %NULL
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 ECalMetaBackendInfo::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_cal_meta_backend_load_component_sync().
It is optional to implement this virtual method by the descendant. The default implementation calls e_cal_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_cal_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_cal_meta_backend_get_ever_connected() is %TRUE.
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.
Calls the get_free_busy_sync method on the given backend.
Finishes the operation started with e_cal_backend_get_free_busy().
The free/busy results can be returned through the e_data_cal_report_free_busy_data() function asynchronously. The out_freebusy will contain all the returned data, possibly again, thus the client is responsible for the data merge, if needed.
If an error occurred, the function will set error and return %FALSE.
a #GAsyncResult
iCalendar strings with overall returned Free/Busy data
Obtains a free/busy object for the list of users in the time interval
between start and end.
The free/busy results can be returned through the e_data_cal_report_free_busy_data() function asynchronously. The out_freebusy will contain all the returned data, possibly again, thus the client is responsible for the data merge, if needed.
If an error occurs, the function will set error and return %FALSE.
start time
end time
a %NULL-terminated array of user strings
iCalendar strings with overall returned Free/Busy data
optional #GCancellable object, or %NULL
Gets the kind of components the given backend stores.
Calls the get_object_sync method on the given backend.
Finishes the operation started with e_cal_backend_get_object().
The returned string is an iCalendar object describing either single component or a vCalendar object, which includes also detached instances. It should be freed when no longer needed.
If an error occurs, the function will set error and return %NULL.
a #GAsyncResult
Calls the get_object_list_sync method on the given backend.
Finishes the operation started with e_cal_backend_get_object_list().
The matching iCalendar instances are deposited in out_objects.
The returned instances should be freed with g_free() 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 iCalendar string instances which satisfy the criteria
specified in query, and deposits them in out_objects.
The returned instances should 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 search query in S-expression format
a #GQueue in which to deposit results
optional #GCancellable object, or %NULL
Obtains an iCalendar string for an object identified by its uid and,
optionally, rid.
The returned string should be freed with g_free() when finished with it.
If an error occurs, the function will set error and return %NULL.
a unique ID for an iCalendar object
a recurrence ID, or %NULL
optional #GCancellable object, or %NULL
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.
Obtains an #ICalTimezone by its TZID string. If no match is found,
the function returns %NULL. The returned #ICalTimezone is owned by
the cache and should not be modified or freed.
Finishes the operation started with e_cal_backend_get_timezone().
Free the returned string with g_free() when finished with it.
If an error occurred, the function will set error and return %NULL.
a #GAsyncResult
Obtains the VTIMEZONE object identified by tzid. Free the returned
string with g_free() when finished with it.
If an error occurs, the function will set error and return %NULL.
a unique ID for an iCalendar VTIMEZONE object
optional #GCancellable object, or %NULL
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 attachments which point to a local file in component
to inline attachments, aka adds the file content into the component.
It also populates FILENAME parameter on the attachment.
This is called automatically before e_cal_meta_backend_save_component_sync().
The reverse operation is e_cal_meta_backend_store_inline_attachments_sync().
an #ICalComponent 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.
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 ECalMetaBackendInfo::object of
the out_existing_objects, if known, in which case this will be used instead
of loading it with e_cal_meta_backend_load_component_sync().
It is mandatory to implement this virtual method by the descendant, unless it implements its own #ECalMetaBackendClass.get_changes_sync().
The out_existing_objects #GSList should be freed with
g_slist_free_full (objects, e_cal_meta_backend_info_free);
when no longer needed.
optional #GCancellable object, or %NULL
Returns a list of #ICalTimezone instances that were explicitly added to
the cache through e_timezone_cache_add_timezone(). In particular, any
built-in time zone data that e_timezone_cache_get_timezone() may use to
match a TZID string is excluded from the returned list.
Free the returned list with g_list_free(). The list elements are owned
by the cache and should not be modified or freed.
Returns a list of #EDataCalView instances added with e_cal_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 component from the remote side. Any detached instances should be
returned together with the master object. The out_component can be either
a VCALENDAR component, which would contain the master object and all of
its detached instances, eventually also used time zones, or the requested
component of type VEVENT, VJOURNAL or VTODO.
It is mandatory to implement this virtual method by the descendant.
The returned out_component 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 component UID
optional extra data stored with the component, or %NULL
optional #GCancellable object, or %NULL
Merges all the instances provided in instances list into one VCALENDAR
object, which would eventually contain also all the used timezones.
The instances list should contain the master object and eventually all
the detached instances for one component (they all have the same UID).
Any TZID property parameters can be replaced with corresponding timezone location, which will not influence the timezone itself.
component instances to merge
whether to replace TZID-s with locations
Calls the modify_objects_sync method on the given backend.
Finishes the operation started with e_cal_backend_modify_objects().
If an error occurred, the function will set error and return %FALSE.
a #GAsyncResult
Modifies one or more iCalendar objects according to calobjs and mod.
If an error occurs, the function will set error and return %FALSE.
a %NULL-terminated array of iCalendar strings
modification type for recurrences
bit-or of #ECalOperationFlags
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 each of the backend's listeners about a modified object.
Uses the #EDataCalView's fields-of-interest to filter out unwanted information from ical strings sent over the bus.
the #ECalComponent before the modification
the #ECalComponent after the modification
Notifies each of the backend's listeners about a removed object.
Uses the #EDataCalView's fields-of-interest to filter out unwanted information from ical strings sent over the bus.
the Id of the removed object
the removed component
the component after the removal. This only applies to recurrent appointments that had an instance removed. In that case, this function notifies a modification instead of a removal.
Notifies each of the backend's listeners about an error
Error message
Notifies client about property value change.
property name, which changed
new property value
Calls the open_sync method on the given backend.
Finishes the operation started with e_cal_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 #EDataCal
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 #ECalMetaBackendInfo object infos which had been created
a #GSList of #ECalMetaBackendInfo object infos which had been modified
a #GSList of #ECalMetaBackendInfo object infos which had been removed
optional #GCancellable object, or %NULL
Calls the receive_objects_sync method on the given backend.
Finishes the operation started with e_cal_backend_receive_objects().
If an error occurred, the function will set error and erturn %FALSE.
a #GAsyncResult
Receives the set of iCalendar objects specified by calobj. This is used
for iTIP confirmation and cancellation messages for scheduled meetings.
If an error occurs, the function will set error and return %FALSE.
an iCalendar string
bit-or of #ECalOperationFlags
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 #EDataCal for backend. The #EDataCal is essentially
the glue between incoming D-Bus requests and backend's native API.
An #EDataCal should be set only once after backend is first created.
If an #EDataCal has not yet been set, the function returns %NULL.
The returned #EDataCal 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().
Calls the refresh_sync method on the given backend.
Finishes the refresh initiation started with e_cal_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_cal_meta_backend_schedule_refresh().
optional #GCancellable object, or %NULL
Removes a component from the remote side, with all its detached instances.
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 #ECalCache.
It is mandatory to implement this virtual method by the writable descendant.
an #EConflictResolution to use
a component UID
extra data being saved with the component in the local cache, or %NULL
corresponding iCalendar object, as stored in the local cache, or %NULL
bit-or of #ECalOperationFlags
optional #GCancellable object, or %NULL
Calls the remove_objects_sync method on the given backend.
Finishes the operation started with e_cal_backend_remove_objects().
If an error occurred, the function will set error and return %FALSE.
a #GAsyncResult
Removes one or more iCalendar objects according to component_ids and mod.
If an error occurs, the function will set error and return %FALSE.
a #GList of #ECalComponentId structs
modification type for recurrences
bit-or of #ECalOperationFlags
optional #GCancellable object, or %NULL
Removes view from the list of live views for the backend.
An #EDataCalView object, previously added with ref e_cal_backend_add_view.
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 component into the remote side. The instances contain the master
object and all the detached instances of the same component (all have the same UID).
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 descendant can use e_cal_meta_backend_merge_instances() to merge the instances into one VCALENDAR component, which will contain also used time zones.
The components in instances have already converted locally stored attachments
into inline attachments, thus it's not needed to call
e_cal_meta_backend_inline_local_attachments_sync() by the descendant.
The out_new_uid can be populated with a UID of the saved component 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 component by the remote side.
The out_new_extra can be populated with a new extra data to save with the component.
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
to 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 components, %FALSE otherwise
one of #EConflictResolution, what to do on conflicts
instances of the component to save
extra data saved with the components in an #ECalCache
bit-or of #ECalOperationFlags
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_cal_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_cal_meta_backend_refresh_sync() to refresh the meta_backend
immediately.
Searches meta_backend with given expression expr and returns
found components as a #GSList of #ECalComponent out_components.
Free the returned out_components with g_slist_free_full (components, g_object_unref);
when no longer needed.
When the expr is %NULL, all objects are returned. To get iCal
strings instead, call e_cal_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
Searches meta_backend with given expression expr and returns
found components as a #GSList of iCal strings out_icalstrings.
Free the returned out_icalstrings with g_slist_free_full (icalstrings, g_free);
when no longer needed.
When the expr is %NULL, all objects are returned. To get
#ECalComponent-s instead, call e_cal_meta_backend_search_components_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
Calls the send_objects_sync method on the given backend.
Finishes the operation started with e_cal_backend_send_objects().
The function returns a string representation of a sent, or to be send,
vCalendar and deposits the list of users the meeting information was sent
to, or to be send to, in out_users.
Free the returned pointer with g_free(), when no longer needed.
If an error occurs, the function will set error and return %NULL.
a #GAsyncResult
a #GQueue in which to deposit results
Sends meeting information in calobj. The backend may modify calobj
and send meeting information only to particular users. The function
returns the (maybe) modified calobj and deposits the list of users the
meeting information was sent (to be send) to in out_users.
The returned pointer should be freed with g_free(), when no londer needed.
If an error occurs, the function will set error and return %NULL.
an iCalendar string
bit-or of #ECalOperationFlags
a #GQueue in which to deposit results
optional #GCancellable object, or %NULL
Sets the cache as the cache to be used by the meta_backend.
By default, a cache.db in ECalBackend::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 #ECalCache to use
Sets the cache directory path for use by backend.
Note that #ECalBackend 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_cal_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 #EDataCal for backend. The #EDataCal is essentially the
glue between incoming D-Bus requests and backend's native API.
An #EDataCal should be set only once after backend is first created.
The backend adds its own reference on the data_cal.
an #EDataCal
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
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_cal_meta_backend_info_free); when no longer needed.
The caller is still responsible to free objects as well.
a #GSList of #ECalMetaBackendInfo object infos to split
optional #GCancellable object, or %NULL
Starts a new live view on the given backend.
The view to be started.
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 a previously started live view on the given backend.
The view to be stopped.
Changes all inline attachments to URL attachments in component, which
will point to a local file instead. The function expects FILENAME parameter
to be set on the attachment as the file name of it.
This is called automatically after e_cal_meta_backend_load_component_sync().
The reverse operation is e_cal_meta_backend_inline_local_attachments_sync().
an #ICalComponent 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_cal_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 ECalMetaBackendInfo::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_cal_meta_backend_load_component_sync().
It is optional to implement this virtual method by the descendant. The default implementation calls e_cal_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_cal_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 ECalMetaBackendInfo::object of
the out_existing_objects, if known, in which case this will be used instead
of loading it with e_cal_meta_backend_load_component_sync().
It is mandatory to implement this virtual method by the descendant, unless it implements its own #ECalMetaBackendClass.get_changes_sync().
The out_existing_objects #GSList should be freed with
g_slist_free_full (objects, e_cal_meta_backend_info_free);
when no longer needed.
optional #GCancellable object, or %NULL
Loads a component from the remote side. Any detached instances should be
returned together with the master object. The out_component can be either
a VCALENDAR component, which would contain the master object and all of
its detached instances, eventually also used time zones, or the requested
component of type VEVENT, VJOURNAL or VTODO.
It is mandatory to implement this virtual method by the descendant.
The returned out_component 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 component UID
optional extra data stored with the component, 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 component from the remote side, with all its detached instances.
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 #ECalCache.
It is mandatory to implement this virtual method by the writable descendant.
an #EConflictResolution to use
a component UID
extra data being saved with the component in the local cache, or %NULL
corresponding iCalendar object, as stored in the local cache, or %NULL
bit-or of #ECalOperationFlags
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 component into the remote side. The instances contain the master
object and all the detached instances of the same component (all have the same UID).
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 descendant can use e_cal_meta_backend_merge_instances() to merge the instances into one VCALENDAR component, which will contain also used time zones.
The components in instances have already converted locally stored attachments
into inline attachments, thus it's not needed to call
e_cal_meta_backend_inline_local_attachments_sync() by the descendant.
The out_new_uid can be populated with a UID of the saved component 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 component by the remote side.
The out_new_extra can be populated with a new extra data to save with the component.
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
to 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 components, %FALSE otherwise
one of #EConflictResolution, what to do on conflicts
instances of the component to save
extra data saved with the components in an #ECalCache
bit-or of #ECalOperationFlags
optional #GCancellable object, or %NULL
Searches meta_backend with given expression expr and returns
found components as a #GSList of #ECalComponent out_components.
Free the returned out_components with g_slist_free_full (components, g_object_unref);
when no longer needed.
When the expr is %NULL, all objects are returned. To get iCal
strings instead, call e_cal_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
Searches meta_backend with given expression expr and returns
found components as a #GSList of iCal strings out_icalstrings.
Free the returned out_icalstrings with g_slist_free_full (icalstrings, g_free);
when no longer needed.
When the expr is %NULL, all objects are returned. To get
#ECalComponent-s instead, call e_cal_meta_backend_search_components_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
Retrieve the default mail account as stored in Evolution configuration.
an #ESourceRegistry
placeholder for default address
placeholder for name
Checks that a mail account is valid, and returns its name.
an #ESourceRegistry
user name for the account to check
placeholder for the account name
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.