EDataServer.SourceCollection¶

Subclasses:	None

Methods¶

Inherited:	EDataServer.SourceBackend (3), EDataServer.SourceExtension (4), GObject.Object (37)
Structs:	GObject.ObjectClass (5)

	`dup_calendar_url` ()
	`dup_contacts_url` ()
	`dup_identity` ()
	`get_allow_sources_rename` ()
	`get_calendar_enabled` ()
	`get_calendar_url` ()
	`get_contacts_enabled` ()
	`get_contacts_url` ()
	`get_identity` ()
	`get_mail_enabled` ()
	`set_allow_sources_rename` (allow_sources_rename)
	`set_calendar_enabled` (calendar_enabled)
	`set_calendar_url` (calendar_url)
	`set_contacts_enabled` (contacts_enabled)
	`set_contacts_url` (contacts_url)
	`set_identity` (identity)
	`set_mail_enabled` (mail_enabled)

Virtual Methods¶

Inherited:	GObject.Object (7)

Properties¶

Inherited:	EDataServer.SourceBackend (1), EDataServer.SourceExtension (1)

Name	Type	Flags	Short Description
`allow-sources-rename`	`bool`	r/w/c/en	Set to `True` when the collection source allows user rename the child sources
`calendar-enabled`	`bool`	r/w/c/en	Whether calendar resources are enabled
`calendar-url`	`str`	r/w/c/en	Calendar top URL
`contacts-enabled`	`bool`	r/w/c/en	Whether contact resources are enabled
`contacts-url`	`str`	r/w/c/en	Contacts top URL
`identity`	`str`	r/w/c/en	Uniquely identifies the account at the service provider
`mail-enabled`	`bool`	r/w/c/en	Whether mail resources are enabled

Signals¶

Inherited:	GObject.Object (1)

Fields¶

Inherited:	GObject.Object (1)

Name	Type	Access	Description
parent	`EDataServer.SourceBackend`	r

Class Details¶

class EDataServer.SourceCollection(**kwargs)¶

Bases:	`EDataServer.SourceBackend`
Abstract:	No
Structure:	`EDataServer.SourceCollectionClass`

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

New in version 3.6.

dup_calendar_url()¶

Returns:	a newly-allocated copy of `EDataServer.SourceCollection` `:calendar-url`
Return type:	`str`

Thread-safe variation of EDataServer.SourceCollection.get_calendar_url(). Use this function when accessing self from multiple threads.

The returned string should be freed with GLib.free() when no longer needed.

New in version 3.26.

dup_contacts_url()¶

Returns:	a newly-allocated copy of `EDataServer.SourceCollection` `:contacts-url`
Return type:	`str`

Thread-safe variation of EDataServer.SourceCollection.get_contacts_url(). Use this function when accessing self from multiple threads.

The returned string should be freed with GLib.free() when no longer needed.

New in version 3.26.

dup_identity()¶

Returns:	a newly-allocated copy of `EDataServer.SourceCollection` `:identity`
Return type:	`str`

Thread-safe variation of EDataServer.SourceCollection.get_identity(). Use this function when accessing self from multiple threads.

The returned string should be freed with GLib.free() when no longer needed.

New in version 3.6.

get_allow_sources_rename()¶

Returns:	whether the collection backend allows a user to rename child sources
Return type:	`bool`

Returns whether the collection backend allows a user to rename child sources. It is meant mainly for GUI. The default is False.

New in version 3.36.

get_calendar_enabled()¶

Returns:	whether calendar sources should be enabled
Return type:	`bool`

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 EDataServer.SourceCollection :calendar-enabled property.

New in version 3.6.

get_calendar_url()¶

Returns:	the calendar top URL, or `None`
Return type:	`str` or `None`

Returns the calendar top URL string, that is, where to search for calendar sources.

New in version 3.26.

get_contacts_enabled()¶

Returns:	whether address book sources should be enabled
Return type:	`bool`

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 EDataServer.SourceCollection :contacts-enabled property.

New in version 3.6.

get_contacts_url()¶

Returns:	the contacts top URL, or `None`
Return type:	`str` or `None`

Returns the contacts top URL string, that is, where to search for contact sources.

New in version 3.26.

get_identity()¶

Returns:	the collection identity
Return type:	`str`

Returns the string used to uniquely identify the user account at the service provider. Often this is an email address or user name.

New in version 3.6.

get_mail_enabled()¶

Returns:	whether mail sources should be enabled
Return type:	`bool`

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 EDataServer.SourceCollection :mail-enabled property.

New in version 3.6.

set_allow_sources_rename(allow_sources_rename)¶

Parameters:	allow_sources_rename (`bool`) – whether mail sources should be enabled

Sets whether the collection backend allows a user to rename child sources. It is meant mainly for GUI. The default is False.

New in version 3.36.

set_calendar_enabled(calendar_enabled)¶

Parameters:	calendar_enabled (`bool`) – whether calendar sources should be 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 EDataServer.SourceCollection :calendar-enabled property.

Calling this function from a registry service client has no effect until the change is submitted to the registry service through EDataServer.Source.write(), but there should rarely be any need for clients to call this.

New in version 3.6.

set_calendar_url(calendar_url)¶

Parameters:	calendar_url (`str` or `None`) – calendar top URL, or `None`

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, None is set instead.

New in version 3.26.

set_contacts_enabled(contacts_enabled)¶

Parameters:	contacts_enabled (`bool`) – whether address book sources should be 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 EDataServer.SourceCollection :contacts-enabled property.

Calling this function from a registry service client has no effect until the change is submitted to the registry service through EDataServer.Source.write(), but there should rarely be any need for clients to call this.

New in version 3.6.

set_contacts_url(contacts_url)¶

Parameters:	contacts_url (`str` or `None`) – contacts top URL, or `None`

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, None is set instead.

New in version 3.26.

set_identity(identity)¶

Parameters:	identity (`str` or `None`) – the collection identity, or `None`

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, None is set instead.

New in version 3.6.

set_mail_enabled(mail_enabled)¶

Parameters:	mail_enabled (`bool`) – whether mail sources should be 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 EDataServer.SourceCollection :mail-enabled property.

Calling this function from a registry service client has no effect until the changes is submitted to the registry service through EDataServer.Source.write(), but there should rarely be any need for clients to call this.

New in version 3.6.

Property Details¶

EDataServer.SourceCollection.props.allow_sources_rename¶

Name:	`allow-sources-rename`
Type:	`bool`
Default Value:	`False`
Flags:	`READABLE`, `WRITABLE`, `CONSTRUCT`, `EXPLICIT_NOTIFY`

Set to True when the collection source allows user rename the child sources

EDataServer.SourceCollection.props.calendar_enabled¶

Name:	`calendar-enabled`
Type:	`bool`
Default Value:	`True`
Flags:	`READABLE`, `WRITABLE`, `CONSTRUCT`, `EXPLICIT_NOTIFY`

Whether calendar resources are enabled

EDataServer.SourceCollection.props.calendar_url¶

Name:	`calendar-url`
Type:	`str`
Default Value:	`None`
Flags:	`READABLE`, `WRITABLE`, `CONSTRUCT`, `EXPLICIT_NOTIFY`

Calendar top URL

EDataServer.SourceCollection.props.contacts_enabled¶

Name:	`contacts-enabled`
Type:	`bool`
Default Value:	`True`
Flags:	`READABLE`, `WRITABLE`, `CONSTRUCT`, `EXPLICIT_NOTIFY`

Whether contact resources are enabled

EDataServer.SourceCollection.props.contacts_url¶

Name:	`contacts-url`
Type:	`str`
Default Value:	`None`
Flags:	`READABLE`, `WRITABLE`, `CONSTRUCT`, `EXPLICIT_NOTIFY`

Contacts top URL

EDataServer.SourceCollection.props.identity¶

Name:	`identity`
Type:	`str`
Default Value:	`None`
Flags:	`READABLE`, `WRITABLE`, `CONSTRUCT`, `EXPLICIT_NOTIFY`

Uniquely identifies the account at the service provider

EDataServer.SourceCollection.props.mail_enabled¶

Name:	`mail-enabled`
Type:	`bool`
Default Value:	`True`
Flags:	`READABLE`, `WRITABLE`, `CONSTRUCT`, `EXPLICIT_NOTIFY`

Whether mail resources are enabled