Top | ![]() |
![]() |
![]() |
![]() |
ESourceCollectionESourceCollection — ESource extension for grouping related resources |
const gchar * | e_source_collection_get_identity () |
gchar * | e_source_collection_dup_identity () |
void | e_source_collection_set_identity () |
gboolean | e_source_collection_get_calendar_enabled () |
void | e_source_collection_set_calendar_enabled () |
gboolean | e_source_collection_get_contacts_enabled () |
void | e_source_collection_set_contacts_enabled () |
gboolean | e_source_collection_get_mail_enabled () |
void | e_source_collection_set_mail_enabled () |
const gchar * | e_source_collection_get_calendar_url () |
gchar * | e_source_collection_dup_calendar_url () |
void | e_source_collection_set_calendar_url () |
const gchar * | e_source_collection_get_contacts_url () |
gchar * | e_source_collection_dup_contacts_url () |
void | e_source_collection_set_contacts_url () |
The ESourceCollection extension identifies the ESource as the root of a data source collection.
Access the extension as follows:
1 2 3 4 5 |
#include <libedataserver/libedataserver.h> ESourceCollection *extension; extension = e_source_get_extension (source, E_SOURCE_EXTENSION_COLLECTION); |
const gchar *
e_source_collection_get_identity (ESourceCollection *extension
);
Returns the string used to uniquely identify the user account at the service provider. Often this is an email address or user name.
Since: 3.6
gchar *
e_source_collection_dup_identity (ESourceCollection *extension
);
Thread-safe variation of e_source_collection_get_identity()
.
Use this function when accessing extension
from multiple threads.
The returned string should be freed with g_free()
when no longer needed.
Since: 3.6
void e_source_collection_set_identity (ESourceCollection *extension
,const gchar *identity
);
Sets the string used to uniquely identify the user account at the service provider. Often this is an email address or user name.
The internal copy of identity
is automatically stripped of leading
and trailing whitespace. If the resulting string is empty, NULL
is
set instead.
Since: 3.6
gboolean
e_source_collection_get_calendar_enabled
(ESourceCollection *extension
);
Returns whether calendar sources within the collection should be enabled.
An ECollectionBackend running within the registry D-Bus service will automatically synchronize any calendar sources it maintains with the “calendar-enabled” property.
Since: 3.6
void e_source_collection_set_calendar_enabled (ESourceCollection *extension
,gboolean calendar_enabled
);
Sets whether calendar sources within the collection should be enabled.
An ECollectionBackend running within the registry D-Bus service will automatically synchronize any calendar sources it maintains with the “calendar-enabled” property.
Calling this function from a registry service client has no effect until
the change is submitted to the registry service through e_source_write()
,
but there should rarely be any need for clients to call this.
Since: 3.6
gboolean
e_source_collection_get_contacts_enabled
(ESourceCollection *extension
);
Returns whether address book sources within the collection should be enabled.
An ECollectionBackend running within the registry D-Bus service will automatically synchronize any address book sources it maintains with the “contacts-enabled” property.
Since: 3.6
void e_source_collection_set_contacts_enabled (ESourceCollection *extension
,gboolean contacts_enabled
);
Sets whether address book sources within the collection should be enabled.
An ECollectionBackend running within the registry D-Bus service will automatically synchronize any address book sources it maintains with the “contacts-enabled” property.
Calling this function from a registry service client has no effect until
the change is submitted to the registry service through e_source_write()
,
but there should rarely be any need for clients to call this.
Since: 3.6
gboolean
e_source_collection_get_mail_enabled (ESourceCollection *extension
);
Returns whether mail sources within the collection should be enabled.
An ECollectionBackend running within the registry D-Bus service will automatically synchronize any mail sources it maintains with the “mail-enabled” property.
Since: 3.6
void e_source_collection_set_mail_enabled (ESourceCollection *extension
,gboolean mail_enabled
);
Sets whether mail sources within the collection should be enabled.
An ECollectionBackend running within the registry D-Bus service will automatically synchronize any mail sources it maintains with the “mail-enabled” property.
Calling this function from a registry service client has no effect until
the changes is submitted to the registry service through e_source_write()
,
but there should rarely be any need for clients to call this.
Since: 3.6
const gchar *
e_source_collection_get_calendar_url (ESourceCollection *extension
);
Returns the calendar top URL string, that is, where to search for calendar sources.
Since: 3.26
gchar *
e_source_collection_dup_calendar_url (ESourceCollection *extension
);
Thread-safe variation of e_source_collection_get_calendar_url()
.
Use this function when accessing extension
from multiple threads.
The returned string should be freed with g_free()
when no longer needed.
Since: 3.26
void e_source_collection_set_calendar_url (ESourceCollection *extension
,const gchar *calendar_url
);
Sets the calendar top URL, that is, where to search for calendar sources.
The internal copy of calendar_url
is automatically stripped of leading
and trailing whitespace. If the resulting string is empty, NULL
is set
instead.
Since: 3.26
const gchar *
e_source_collection_get_contacts_url (ESourceCollection *extension
);
Returns the contacts top URL string, that is, where to search for contact sources.
Since: 3.26
gchar *
e_source_collection_dup_contacts_url (ESourceCollection *extension
);
Thread-safe variation of e_source_collection_get_contacts_url()
.
Use this function when accessing extension
from multiple threads.
The returned string should be freed with g_free()
when no longer needed.
Since: 3.26
void e_source_collection_set_contacts_url (ESourceCollection *extension
,const gchar *contacts_url
);
Sets the contacts top URL, that is, where to search for contact sources.
The internal copy of contacts_url
is automatically stripped of leading
and trailing whitespace. If the resulting string is empty, NULL
is set
instead.
Since: 3.26
#define E_SOURCE_EXTENSION_COLLECTION "Collection"
Pass this extension name to e_source_get_extension()
to access
ESourceCollection. This is also used as a group name in key files.
Since: 3.6
struct ESourceCollection;
Contains only private data that should be read and manipulated using the functions below.
Since: 3.6