EDataServer.SourceRegistry¶

Subclasses:	None

Methods¶

Inherited:	GObject.Object (37), Gio.AsyncInitable (4), Gio.Initable (2)
Structs:	GObject.ObjectClass (5)

class	`debug_enabled` ()
class	`free_display_tree` (display_tree)
class	`new` (cancellable, callback, *user_data)
class	`new_finish` (result)
class	`new_sync` (cancellable)
	`check_enabled` (source)
	`commit_source` (source, cancellable, callback, *user_data)
	`commit_source_finish` (result)
	`commit_source_sync` (source, cancellable)
	`create_sources` (list_of_sources, cancellable, callback, *user_data)
	`create_sources_finish` (result)
	`create_sources_sync` (list_of_sources, cancellable)
	`debug_dump` (extension_name)
	`dup_unique_display_name` (source, extension_name)
	`find_extension` (source, extension_name)
	`get_oauth2_services` ()
	`list_enabled` (extension_name)
	`list_sources` (extension_name)
	`ref_builtin_address_book` ()
	`ref_builtin_calendar` ()
	`ref_builtin_mail_account` ()
	`ref_builtin_memo_list` ()
	`ref_builtin_proxy` ()
	`ref_builtin_task_list` ()
	`ref_default_address_book` ()
	`ref_default_calendar` ()
	`ref_default_for_extension_name` (extension_name)
	`ref_default_mail_account` ()
	`ref_default_mail_identity` ()
	`ref_default_memo_list` ()
	`ref_default_task_list` ()
	`ref_source` (uid)
	`refresh_backend` (source_uid, cancellable, callback, *user_data)
	`refresh_backend_finish` (result)
	`refresh_backend_sync` (source_uid, cancellable)
	`set_default_address_book` (default_source)
	`set_default_calendar` (default_source)
	`set_default_for_extension_name` (extension_name, default_source)
	`set_default_mail_account` (default_source)
	`set_default_mail_identity` (default_source)
	`set_default_memo_list` (default_source)
	`set_default_task_list` (default_source)

Virtual Methods¶

Inherited:	GObject.Object (7), Gio.AsyncInitable (2), Gio.Initable (1)

	`do_credentials_required` (source, reason, certificate_pem, certificate_errors, op_error)
	`do_source_added` (source)
	`do_source_changed` (source)
	`do_source_disabled` (source)
	`do_source_enabled` (source)
	`do_source_removed` (source)

Properties¶

Name	Type	Flags	Short Description
`default-address-book`	`EDataServer.Source`	r/w/en	The default address book `EDataServer.Source`
`default-calendar`	`EDataServer.Source`	r/w/en	The default calendar `EDataServer.Source`
`default-mail-account`	`EDataServer.Source`	r/w/en	The default mail account `EDataServer.Source`
`default-mail-identity`	`EDataServer.Source`	r/w/en	The default mail identity `EDataServer.Source`
`default-memo-list`	`EDataServer.Source`	r/w/en	The default memo list `EDataServer.Source`
`default-task-list`	`EDataServer.Source`	r/w/en	The default task list `EDataServer.Source`

Signals¶

Inherited:	GObject.Object (1)

Name	Short Description
`credentials-required`	The `::credentials-required` signal is emitted when the source requires credentials to connect to (possibly remote) data store.
`source-added`	Emitted when an `EDataServer.Source` is added to registry.
`source-changed`	Emitted when an `EDataServer.Source` registered with registry emits its `EDataServer.Source` `::changed` signal.
`source-disabled`	Emitted when an `EDataServer.Source` `EDataServer.Source` `:enabled` property becomes `False`.
`source-enabled`	Emitted when an `EDataServer.Source` `EDataServer.Source` `:enabled` property becomes `True`.
`source-removed`	Emitted when an `EDataServer.Source` is removed from registry.

Fields¶

Inherited:	GObject.Object (1)

Name	Type	Access	Description
parent	`GObject.Object`	r

Class Details¶

class EDataServer.SourceRegistry(**kwargs)¶

Bases:	`GObject.Object`, `Gio.AsyncInitable`, `Gio.Initable`
Abstract:	No
Structure:	`EDataServer.SourceRegistryClass`

Contains only private data that should be read and manipulated using the functions below.

New in version 3.6.

classmethod debug_enabled()¶

Returns:	Whether debugging is enabled, that is, whether e_source_registry_debug_print() will produce any output.
Return type:	`bool`

New in version 3.16.

classmethod free_display_tree(display_tree)¶

Parameters:	display_tree (`GLib.Node`) – a tree of sources, arranged for display

Convenience function to free a GLib.Node tree of registered sources created by e_source_registry_build_display_tree().

New in version 3.6.

classmethod new(cancellable, callback, *user_data)¶

Parameters:	cancellable (`Gio.Cancellable` or `None`) – optional `Gio.Cancellable` object, or `None` callback (`Gio.AsyncReadyCallback` or `None`) – a `Gio.AsyncReadyCallback` to call when the request is satisfied user_data (`object` or `None`) – data to pass to the callback function

Asynchronously creates a new EDataServer.SourceRegistry front-end for the registry D-Bus service.

When the operation is finished, callback will be called. You can then call EDataServer.SourceRegistry.new_finish() to get the result of the operation.

Since 3.12 a singleton will be returned. No strong reference is kept internally, so it is the caller’s responsibility to keep one.

New in version 3.6.

classmethod new_finish(result)¶

Parameters:	result (`Gio.AsyncResult`) – a `Gio.AsyncResult`
Raises:	`GLib.Error`
Returns:	a new `EDataServer.SourceRegistry`, or `None`
Return type:	`EDataServer.SourceRegistry`

Finishes the operation started with EDataServer.SourceRegistry.new_finish(). If an error occurs in connecting to the D-Bus service, the function sets error and returns None.

New in version 3.6.

classmethod new_sync(cancellable)¶

Parameters:	cancellable (`Gio.Cancellable` or `None`) – optional `Gio.Cancellable` object, or `None`
Raises:	`GLib.Error`
Returns:	a new `EDataServer.SourceRegistry`, or `None`
Return type:	`EDataServer.SourceRegistry`

Creates a new EDataServer.SourceRegistry front-end for the registry D-Bus service. If an error occurs in connecting to the D-Bus service, the function sets error and returns None.

Since 3.12 a singleton will be returned. No strong reference is kept internally, so it is the caller’s responsibility to keep one.

New in version 3.6.

check_enabled(source)¶

Parameters:	source (`EDataServer.Source`) – an `EDataServer.Source`
Returns:	whether source is “effectively” enabled
Return type:	`bool`

Determines whether source is “effectively” enabled by examining its own EDataServer.Source :enabled property as well as those of its ancestors in the EDataServer.Source hierarchy. If all examined EDataServer.Source :enabled properties are True, then the function returns True. If any are False, then the function returns False.

Use this function instead of EDataServer.Source.get_enabled() to determine things like whether to display an EDataServer.Source in a user interface or whether to act on the data set described by the EDataServer.Source.

New in version 3.8.

commit_source(source, cancellable, callback, *user_data)¶

Parameters:	source (`EDataServer.Source`) – an `EDataServer.Source` with changes to commit cancellable (`Gio.Cancellable` or `None`) – optional `Gio.Cancellable` object, or `None` callback (`Gio.AsyncReadyCallback` or `None`) – a `Gio.AsyncReadyCallback` to call when the request is satisfied user_data (`object` or `None`) – data to pass to the callback function

See EDataServer.SourceRegistry.commit_source_sync() for details.

When the operation is finished, callback will be called. You can then call EDataServer.SourceRegistry.commit_source_finish() to get the result of the operation.

New in version 3.6.

commit_source_finish(result)¶

Parameters:	result (`Gio.AsyncResult`) – a `Gio.AsyncResult`
Raises:	`GLib.Error`
Returns:	`True` on success, `False` on failure
Return type:	`bool`

Finishes the operation started with EDataServer.SourceRegistry.commit_source().

If an error occurred, the function will set error and return False.

New in version 3.6.

commit_source_sync(source, cancellable)¶

Parameters:	source (`EDataServer.Source`) – an `EDataServer.Source` with changes to commit cancellable (`Gio.Cancellable` or `None`) – optional `Gio.Cancellable` object, or `None`
Raises:	`GLib.Error`
Returns:	`True` on success, `False` on failure
Return type:	`bool`

This is a convenience function intended for use with graphical EDataServer.Source editors. Call this function when the user is finished making changes to source.

If source has a Gio.DBusObject, its contents are submitted to the D-Bus service through EDataServer.Source.write_sync().

If source does NOT have a Gio.DBusObject (implying it’s a scratch EDataServer.Source), its contents are submitted to the D-Bus service through either EDataServer.Source.remote_create_sync() if source is to be a collection member, or EDataServer.SourceRegistry.create_sources_sync() if source to be an independent data source.

If an error occurs, the function will set error and return False.

New in version 3.6.

create_sources(list_of_sources, cancellable, callback, *user_data)¶

Parameters:

list_of_sources ([EDataServer.Source]) – a list of EDataServer.Source instances with no Gio.DBusObject
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None
callback (Gio.AsyncReadyCallback or None) – a Gio.AsyncReadyCallback to call when the request is satisfied
user_data (object or None) – data to pass to the callback function

Asynchronously requests the D-Bus service create new key files for each EDataServer.Source in list_of_sources. Each list element must be a scratch EDataServer.Source with no Gio.DBusObject.

When the operation is finished, callback will be called. You can then call EDataServer.SourceRegistry.create_sources_finish() to get the result of the operation.

New in version 3.6.

create_sources_finish(result)¶

Parameters:	result (`Gio.AsyncResult`) – a `Gio.AsyncResult`
Raises:	`GLib.Error`
Returns:	`True` on success, `False` on failure
Return type:	`bool`

Finishes the operation started with EDataServer.SourceRegistry.create_sources().

If an error occurred, the function will set error and return False.

New in version 3.6.

create_sources_sync(list_of_sources, cancellable)¶

Parameters:	list_of_sources ([`EDataServer.Source`]) – a list of `EDataServer.Source` instances with no `Gio.DBusObject` cancellable (`Gio.Cancellable` or `None`) – optional `Gio.Cancellable` object, or `None`
Raises:	`GLib.Error`
Returns:	`True` on success, `False` on failure
Return type:	`bool`

Requests the D-Bus service create new key files for each EDataServer.Source in list_of_sources. Each list element must be a scratch EDataServer.Source with no Gio.DBusObject.

If an error occurs, the function will set error and return False.

New in version 3.6.

debug_dump(extension_name)¶

Parameters:	extension_name (`str` or `None`) – an extension name, or `None`

Handy debugging function that uses e_source_registry_build_display_tree() to print a tree of registered sources to standard output.

New in version 3.6.

dup_unique_display_name(source, extension_name)¶

Parameters:	source (`EDataServer.Source`) – an `EDataServer.Source` extension_name (`str` or `None`) – an extension name, or `None`
Returns:	a unique display name for source
Return type:	`str`

Compares source’s EDataServer.Source :display-name against other sources having an EDataServer.SourceExtension named extension_name, if given, or else against all other sources in the self.

If sources’s EDataServer.Source :display-name is unique among these other sources, the function will return the EDataServer.Source :display-name verbatim. Otherwise the function will construct a string that includes the sources’s own EDataServer.Source :display-name as well as those of its ancestors.

The function’s return value is intended to be used in messages shown to the user to help clarify which source is being referred to. It assumes source’s EDataServer.Source :display-name is at least unique among its siblings.

Free the returned string with GLib.free() when finished with it.

New in version 3.8.

find_extension(source, extension_name)¶

Parameters:	source (`EDataServer.Source`) – an `EDataServer.Source` extension_name (`str`) – the extension name to find
Returns:	an `EDataServer.Source`, or `None` if no match was found
Return type:	`EDataServer.Source`

Examines source and its ancestors and returns the “deepest” EDataServer.Source having an EDataServer.SourceExtension with the given extension_name. If neither source nor any of its ancestors have such an extension, the function returns None.

This function is useful in cases when an EDataServer.SourceExtension is meant to apply to both the EDataServer.Source it belongs to and the EDataServer.Source’s descendants.

A common example is the EDataServer.SourceCollection extension, where descendants of an EDataServer.Source having an EDataServer.SourceCollection extension are implied to be members of that collection. In that example, this function can be used to test whether source is a member of a collection.

The returned EDataServer.Source is referenced for thread-safety and must be unreferenced with GObject.Object.unref() when finished with it.

Note the function returns the EDataServer.Source containing the EDataServer.SourceExtension instead of the EDataServer.SourceExtension itself because extension instances are not to be referenced directly (see EDataServer.Source.get_extension()).

New in version 3.6.

get_oauth2_services()¶

Returns:	an instance of `EDataServer.OAuth2Services`, owned by self
Return type:	`EDataServer.OAuth2Services`

New in version 3.28.

list_enabled(extension_name)¶

Parameters:	extension_name (`str` or `None`) – an extension name, or `None`
Returns:	a sorted list of sources
Return type:	[`EDataServer.Source`]

Similar to EDataServer.SourceRegistry.list_sources(), but returns only enabled sources according to EDataServer.SourceRegistry.check_enabled().

The sources returned in the list are referenced for thread-safety. They must each be unreferenced with GObject.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);

New in version 3.10.

list_sources(extension_name)¶

Parameters:	extension_name (`str` or `None`) – an extension name, or `None`
Returns:	a sorted list of sources
Return type:	[`EDataServer.Source`]

Returns a list of registered sources, sorted by display name. If extension_name is given, restrict the list to sources having that extension name.

The sources returned in the list are referenced for thread-safety. They must each be unreferenced with GObject.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);

New in version 3.6.

ref_builtin_address_book()¶

Returns:	the built-in address book `EDataServer.Source`
Return type:	`EDataServer.Source`

Returns the built-in address book EDataServer.Source.

This EDataServer.Source is always present and makes for a safe fallback.

The returned EDataServer.Source is referenced for thread-safety and must be unreferenced with GObject.Object.unref() when finished with it.

New in version 3.6.

ref_builtin_calendar()¶

Returns:	the built-in calendar `EDataServer.Source`
Return type:	`EDataServer.Source`

Returns the built-in calendar EDataServer.Source.

This EDataServer.Source is always present and makes for a safe fallback.

The returned EDataServer.Source is referenced for thread-safety and must be unreferenced with GObject.Object.unref() when finished with it.

New in version 3.6.

ref_builtin_mail_account()¶

Returns:	the built-in mail account `EDataServer.Source`
Return type:	`EDataServer.Source`

Returns the built-in mail account EDataServer.Source.

This EDataServer.Source is always present and makes for a safe fallback.

The returned EDataServer.Source is referenced for thread-safety and must be unreferenced with GObject.Object.unref() when finished with it.

New in version 3.6.

ref_builtin_memo_list()¶

Returns:	the built-in memo list `EDataServer.Source`
Return type:	`EDataServer.Source`

Returns the built-in memo list EDataServer.Source.

This EDataServer.Source is always present and makes for a safe fallback.

The returned EDataServer.Source is referenced for thread-safety and must be unreferenced with GObject.Object.unref() when finished with it.

New in version 3.6.

ref_builtin_proxy()¶

Returns:	the built-in proxy profile `EDataServer.Source`
Return type:	`EDataServer.Source`

Returns the built-in proxy profile EDataServer.Source.

This EDataServer.Source is always present and makes for a safe fallback.

The returned EDataServer.Source is referenced for thread-safety and must be unreferenced with GObject.Object.unref() when finished with it.

New in version 3.12.

ref_builtin_task_list()¶

Returns:	the built-in task list `EDataServer.Source`
Return type:	`EDataServer.Source`

Returns the built-in task list EDataServer.Source.

This EDataServer.Source is always present and makes for a safe fallback.

The returned EDataServer.Source is referenced for thread-safety and must be unreferenced with GObject.Object.unref() when finished with it.

New in version 3.6.

ref_default_address_book()¶

Returns:	the default address book `EDataServer.Source`
Return type:	`EDataServer.Source`

Returns the EDataServer.Source most recently passed to EDataServer.SourceRegistry.set_default_address_book() either in this session or a previous session, or else falls back to the built-in address book.

The returned EDataServer.Source is referenced for thread-safety and must be unreferenced with GObject.Object.unref() when finished with it.

New in version 3.6.

ref_default_calendar()¶

Returns:	the default calendar `EDataServer.Source`
Return type:	`EDataServer.Source`

Returns the EDataServer.Source most recently passed to EDataServer.SourceRegistry.set_default_calendar() either in this session or a previous session, or else falls back to the built-in calendar.

The returned EDataServer.Source is referenced for thread-safety and must be unreferenced with GObject.Object.unref() when finished with it.

New in version 3.6.

ref_default_for_extension_name(extension_name)¶

Parameters:	extension_name (`str`) – an extension_name
Returns:	the default `EDataServer.Source` based on extension_name
Return type:	`EDataServer.Source`

This is a convenience function to return a default EDataServer.Source based on extension_name. This only works with a subset of extension names.

If extension_name is EDataServer.SOURCE_EXTENSION_ADDRESS_BOOK, the function returns the current default address book, or else falls back to the built-in address book.

If extension_name is EDataServer.SOURCE_EXTENSION_CALENDAR, the function returns the current default calendar, or else falls back to the built-in calendar.

If extension_name is EDataServer.SOURCE_EXTENSION_MAIL_ACCOUNT, the function returns the current default mail account, or else falls back to the built-in mail account.

If extension_name is EDataServer.SOURCE_EXTENSION_MAIL_IDENTITY, the function returns the current default mail identity, or else falls back to the mail identity named by the current default mail account.

If extension_name is EDataServer.SOURCE_EXTENSION_MEMO_LIST, the function returns the current default memo list, or else falls back to the built-in memo list.

If extension_name is EDataServer.SOURCE_EXTENSION_TASK_LIST, the function returns the current default task list, or else falls back to the built-in task list.

For all other values of extension_name, the function returns None.

The returned EDataServer.Source is referenced for thread-safety and must be unreferenced with GObject.Object.unref() when finished with it.

New in version 3.6.

ref_default_mail_account()¶

Returns:	the default mail account `EDataServer.Source`
Return type:	`EDataServer.Source`

Returns the EDataServer.Source most recently passed to EDataServer.SourceRegistry.set_default_mail_account() either in this session or a previous session, or else falls back to the built-in mail account.

The returned EDataServer.Source is referenced for thread-safety and must be unreferenced with GObject.Object.unref() when finished with it.

New in version 3.6.

ref_default_mail_identity()¶

Returns:	the default mail identity `EDataServer.Source`, or `None`
Return type:	`EDataServer.Source`

Returns the EDataServer.Source most recently passed to EDataServer.SourceRegistry.set_default_mail_identity() either in this session or a previous session, or else falls back to the mail identity named by the default mail account. If even that fails it returns any mail identity from self, or None if there are none.

The returned EDataServer.Source is referenced for thread-safety and must be unreferenced with GObject.Object.unref() when finished with it.

New in version 3.6.

ref_default_memo_list()¶

Returns:	the default memo list `EDataServer.Source`
Return type:	`EDataServer.Source`

Returns the EDataServer.Source most recently passed to EDataServer.SourceRegistry.set_default_memo_list() either in this session or a previous session, or else falls back to the built-in memo list.

The returned EDataServer.Source is referenced for thread-safety and must be unreferenced with GObject.Object.unref() when finished with it.

New in version 3.6.

ref_default_task_list()¶

Returns:	the default task list `EDataServer.Source`
Return type:	`EDataServer.Source`

Returns the EDataServer.Source most recently passed to EDataServer.SourceRegistry.set_default_task_list() either in this session or a previous session, or else falls back to the built-in task list.

The returned EDataServer.Source is referenced for thread-safety and must be unreferenced with GObject.Object.unref() when finished with it.

New in version 3.6.

ref_source(uid)¶

Parameters:	uid (`str`) – a unique identifier string
Returns:	an `EDataServer.Source`, or `None` if no match was found
Return type:	`EDataServer.Source`

Looks up an EDataServer.Source in self by its unique identifier string.

The returned EDataServer.Source is referenced for thread-safety and must be unreferenced with GObject.Object.unref() when finished with it.

New in version 3.6.

refresh_backend(source_uid, cancellable, callback, *user_data)¶

Parameters:	source_uid (`str`) – UID of a collection `EDataServer.Source` whose backend to refresh cancellable (`Gio.Cancellable` or `None`) – optional `Gio.Cancellable` object, or `None` callback (`Gio.AsyncReadyCallback` or `None`) – a `Gio.AsyncReadyCallback` to call when the request is satisfied user_data (`object` or `None`) – data to pass to the callback function

Asynchronously requests the D-Bus service to refresh collection backend for an EDataServer.Source with UID source_uid. The result means that the refresh had been scheduled not whether the refresh itself succeeded. The refresh is not initiated when the collection backend is offline.

When the operation is finished, callback will be called. You can then call EDataServer.SourceRegistry.refresh_backend_finish() to get the result of the operation.

New in version 3.30.

refresh_backend_finish(result)¶

Parameters:	result (`Gio.AsyncResult`) – a `Gio.AsyncResult`
Raises:	`GLib.Error`
Returns:	Whether succeeded
Return type:	`bool`

Finishes the operation started with EDataServer.SourceRegistry.refresh_backend().

If an error occurred, the function will set error and return False.

New in version 3.30.

refresh_backend_sync(source_uid, cancellable)¶

Parameters:	source_uid (`str`) – UID of a collection `EDataServer.Source` whose backend to refresh cancellable (`Gio.Cancellable` or `None`) – optional `Gio.Cancellable` object, or `None`
Raises:	`GLib.Error`
Returns:	Whether succeeded
Return type:	`bool`

Requests the D-Bus service to refresh collection backend for an EDataServer.Source with UID source_uid. The result means that the refresh had been scheduled not whether the refresh itself succeeded. The refresh is not initiated when the collection backend is offline.

If an error occurs, the function will set error and return False.

New in version 3.30.

set_default_address_book(default_source)¶

Parameters:	default_source (`EDataServer.Source` or `None`) – an address book `EDataServer.Source`, or `None`

Sets default_source as the default address book. If default_source is None, the default address book is reset to the built-in address book. This setting will persist across sessions until changed.

New in version 3.6.

set_default_calendar(default_source)¶

Parameters:	default_source (`EDataServer.Source` or `None`) – a calendar `EDataServer.Source`, or `None`

Sets default_source as the default calendar. If default_source is None, the default calendar is reset to the built-in calendar. This setting will persist across sessions until changed.

New in version 3.6.

set_default_for_extension_name(extension_name, default_source)¶

Parameters:	extension_name (`str`) – an extension name default_source (`EDataServer.Source` or `None`) – an `EDataServer.Source`, or `None`

This is a convenience function to set a default EDataServer.Source based on extension_name. This only works with a subset of extension names.

If extension_name is EDataServer.SOURCE_EXTENSION_ADDRESS_BOOK, the function sets default_source as the default address book. If default_source is None, the default address book is reset to the built-in address book.

If extension_name is EDataServer.SOURCE_EXTENSION_CALENDAR, the function sets default_source as the default calendar. If default_source is None, the default calendar is reset to the built-in calendar.

If extension_name is EDataServer.SOURCE_EXTENSION_MAIL_ACCOUNT, the function sets default_source as the default mail account. If default_source is None, the default mail account is reset to the built-in mail account.

If extension_name is EDataServer.SOURCE_EXTENSION_MAIL_IDENTITY, the function sets default_source as the default mail identity. If default_source is None, the next request for the default mail identity will return the mail identity named by the default mail account.

If extension_name is EDataServer.SOURCE_EXTENSION_MEMO_LIST, the function sets default_source as the default memo list. If default_source is None, the default memo list is reset to the built-in memo list.

If extension_name is EDataServer.SOURCE_EXTENSION_TASK_LIST, the function sets default_source as the default task list. If default_source is None, the default task list is reset to the built-in task list.

For all other values of extension_name, the function does nothing.

New in version 3.6.

set_default_mail_account(default_source)¶

Parameters:	default_source (`EDataServer.Source` or `None`) – a mail account `EDataServer.Source`, or `None`

Sets default_source as the default mail account. If default_source is None, the default mail account is reset to the built-in mail account. This setting will persist across sessions until changed.

New in version 3.6.

set_default_mail_identity(default_source)¶

Parameters:	default_source (`EDataServer.Source` or `None`) – a mail identity `EDataServer.Source`, or `None`

Sets default_source as the default mail identity. If default_source is None, the next request for the default mail identity will use the fallbacks described in EDataServer.SourceRegistry.ref_default_mail_identity().

New in version 3.6.

set_default_memo_list(default_source)¶

Parameters:	default_source (`EDataServer.Source` or `None`) – a memo list `EDataServer.Source`, or `None`

Sets default_source as the default memo list. If default_source is None, the default memo list is reset to the built-in memo list. This setting will persist across sessions until changed.

New in version 3.6.

set_default_task_list(default_source)¶

Parameters:	default_source (`EDataServer.Source` or `None`) – a task list `EDataServer.Source`, or `None`

Sets default_source as the default task list. If default_source is None, the default task list is reset to the built-in task list. This setting will persist across sessions until changed.

New in version 3.6.

do_credentials_required(source, reason, certificate_pem, certificate_errors, op_error) virtual¶

Parameters:	source (`EDataServer.Source`) – reason (`EDataServer.SourceCredentialsReason`) – certificate_pem (`str`) – certificate_errors (`Gio.TlsCertificateFlags`) – op_error (`GLib.Error`) –

do_source_added(source) virtual¶

Parameters:	source (`EDataServer.Source`) –

do_source_changed(source) virtual¶

Parameters:	source (`EDataServer.Source`) –

do_source_disabled(source) virtual¶

Parameters:	source (`EDataServer.Source`) –

do_source_enabled(source) virtual¶

Parameters:	source (`EDataServer.Source`) –

do_source_removed(source) virtual¶

Parameters:	source (`EDataServer.Source`) –

Signal Details¶

EDataServer.SourceRegistry.signals.credentials_required(source_registry, source, reason, certificate_pem, certificate_errors, op_error)¶

Signal Name:	`credentials-required`
Flags:	`RUN_LAST`, `NO_RECURSE`
Parameters:	source_registry (`EDataServer.SourceRegistry`) – The object which received the signal source (`EDataServer.Source`) – the `EDataServer.Source` that requires credentials reason (`EDataServer.SourceCredentialsReason`) – an `EDataServer.SourceCredentialsReason` indicating why the credentials are requested certificate_pem (`str`) – PEM-encoded secure connection certificate for failed SSL checks certificate_errors (`Gio.TlsCertificateFlags`) – what failed with the SSL certificate op_error (`GLib.Error`) – a `GLib.Error` with a description of the error, or `None`

The ::credentials-required signal is emitted when the source requires credentials to connect to (possibly remote) data store. The credentials can be passed to the source using EDataServer.Source.invoke_authenticate() function. The signal is emitted in the thread-default main context from the time the registry was created.

Note: This is just a proxy signal for the EDataServer.Source ::credentials-required signal.

EDataServer.SourceRegistry.signals.source_added(source_registry, source)¶

Signal Name:	`source-added`
Flags:	`RUN_LAST`
Parameters:	source_registry (`EDataServer.SourceRegistry`) – The object which received the signal source (`EDataServer.Source`) – the newly-added `EDataServer.Source`

Emitted when an EDataServer.Source is added to registry.

EDataServer.SourceRegistry.signals.source_changed(source_registry, source)¶

Signal Name:	`source-changed`
Flags:	`RUN_LAST`
Parameters:	source_registry (`EDataServer.SourceRegistry`) – The object which received the signal source (`EDataServer.Source`) – the `EDataServer.Source` that changed

Emitted when an EDataServer.Source registered with registry emits its EDataServer.Source ::changed signal.

EDataServer.SourceRegistry.signals.source_disabled(source_registry, source)¶

Signal Name:	`source-disabled`
Flags:	`RUN_LAST`
Parameters:	source_registry (`EDataServer.SourceRegistry`) – The object which received the signal source (`EDataServer.Source`) – the `EDataServer.Source` that got disabled

Emitted when an EDataServer.Source EDataServer.Source :enabled property becomes False.

EDataServer.SourceRegistry.signals.source_enabled(source_registry, source)¶

Signal Name:	`source-enabled`
Flags:	`RUN_LAST`
Parameters:	source_registry (`EDataServer.SourceRegistry`) – The object which received the signal source (`EDataServer.Source`) – the `EDataServer.Source` that got enabled

Emitted when an EDataServer.Source EDataServer.Source :enabled property becomes True.

EDataServer.SourceRegistry.signals.source_removed(source_registry, source)¶

Signal Name:	`source-removed`
Flags:	`RUN_LAST`
Parameters:	source_registry (`EDataServer.SourceRegistry`) – The object which received the signal source (`EDataServer.Source`) – the `EDataServer.Source` that got removed

Emitted when an EDataServer.Source is removed from registry.

Property Details¶

EDataServer.SourceRegistry.props.default_address_book¶

Name:	`default-address-book`
Type:	`EDataServer.Source`
Default Value:	`None`
Flags:	`READABLE`, `WRITABLE`, `EXPLICIT_NOTIFY`

The default address book EDataServer.Source.

EDataServer.SourceRegistry.props.default_calendar¶

Name:	`default-calendar`
Type:	`EDataServer.Source`
Default Value:	`None`
Flags:	`READABLE`, `WRITABLE`, `EXPLICIT_NOTIFY`

The default calendar EDataServer.Source.

EDataServer.SourceRegistry.props.default_mail_account¶

Name:	`default-mail-account`
Type:	`EDataServer.Source`
Default Value:	`None`
Flags:	`READABLE`, `WRITABLE`, `EXPLICIT_NOTIFY`

The default mail account EDataServer.Source.

EDataServer.SourceRegistry.props.default_mail_identity¶

Name:	`default-mail-identity`
Type:	`EDataServer.Source`
Default Value:	`None`
Flags:	`READABLE`, `WRITABLE`, `EXPLICIT_NOTIFY`

The default mail identity EDataServer.Source.

EDataServer.SourceRegistry.props.default_memo_list¶

Name:	`default-memo-list`
Type:	`EDataServer.Source`
Default Value:	`None`
Flags:	`READABLE`, `WRITABLE`, `EXPLICIT_NOTIFY`

The default memo list EDataServer.Source.

EDataServer.SourceRegistry.props.default_task_list¶

Name:	`default-task-list`
Type:	`EDataServer.Source`
Default Value:	`None`
Flags:	`READABLE`, `WRITABLE`, `EXPLICIT_NOTIFY`

The default task list EDataServer.Source.