EBookContacts.SourceBackendSummarySetup¶

Subclasses:	None

Methods¶

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

	`get_indexed_fields` ()
	`get_summary_fields` ()
	`set_indexed_fieldsv` (fields, types, n_fields)
	`set_summary_fieldsv` (fields, n_fields)

Virtual Methods¶

Inherited:	GObject.Object (7)

Properties¶

Inherited:	EDataServer.SourceExtension (1)

Name	Type	Flags	Short Description
`indexed-fields`	`str`	r/w/c/en	The list of summary fields which are to be given indexes in the underlying database
`summary-fields`	`str`	r/w/c/en	The list of quick reference summary fields

Signals¶

Inherited:	GObject.Object (1)

Fields¶

Inherited:	GObject.Object (1)

Name	Type	Access	Description
parent	`EDataServer.SourceBackend`	r

Class Details¶

class EBookContacts.SourceBackendSummarySetup(**kwargs)¶

Bases:	`EDataServer.SourceExtension`
Abstract:	No
Structure:	`EBookContacts.SourceBackendSummarySetupClass`

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

New in version 3.8.

get_indexed_fields()¶

Returns:

The array of indexed EBookContacts.ContactFields.

types:	A return location for the set of `EBookContacts.BookIndexTypes` corresponding to each returned field, should be freed with `GLib.free`() when no longer needed.
n_fields:	The number of elements in the returned arrays.

Return type: (EBookContacts.ContactField, types: EBookContacts.BookIndexType, n_fields: int)

Fetches the EBookContacts.ContactFields configured to be indexed, with thier respective EBookContacts.BookIndexTypes.

New in version 3.8.

get_summary_fields()¶

Returns:

An array of EBookContacts.ContactFields n_fields long, should be freed with GLib.free() when done.

n_fields:	A return location for the number of `EBookContacts.ContactFields` in the returned array.

Return type: (EBookContacts.ContactField, n_fields: int)

Fetches the EBookContacts.ContactFields which are configured to be a Camel.part of the summary.

If there are no configured summary fields, the default configuration is assumed

New in version 3.8.

set_indexed_fieldsv(fields, types, n_fields)¶

Parameters:	fields (`EBookContacts.ContactField`) – The array of `EBookContacts.ContactFields` to set indexes for types (`EBookContacts.BookIndexType`) – The array of `EBookContacts.BookIndexTypes` defining what types of indexes to create n_fields (`int`) – The number elements in the passed fields, rule_types and rules arrays.

Defines indexes for quick reference for the given given EBookContacts.ContactFields in the addressbook.

The same EBookContacts.ContactField may be specified multiple times to create multiple indexes with different characteristics. If an EBookContacts.BookIndexType.PREFIX index is created it will be used for EBookContacts.BookQueryTest.BEGINS_WITH queries. A EBookContacts.BookIndexType.SUFFIX index will be constructed efficiently for suffix matching and will be used for EBookContacts.BookQueryTest.ENDS_WITH queries. Similar a EBookContacts.BookIndexType.PHONE index will optimize EBookContacts.BookQueryTest.EQUALS_PHONE_NUMBER searches.

The specified indexed fields must also be a Camel.part of the summary, any indexed fields specified that are not already a Camel.part of the summary will be ignored.

New in version 3.8.

set_summary_fieldsv(fields, n_fields)¶

Parameters:	fields (`EBookContacts.ContactField`) – The array of `EBookContacts.ContactFields` to set as summary fields n_fields (`int`) – The number of `EBookContacts.ContactFields` in fields

Sets the summary fields configured for the given addressbook.

The fields EBookContacts.ContactField.UID and EBookContacts.ContactField.REV are not optional, they will be stored in the summary regardless of the configured summary.

An empty summary configuration is assumed to be the default summary configuration.

Only EBookContacts.ContactFields with the type GObject.TYPE_STRING or GObject.TYPE_BOOLEAN are currently supported as summary fields.

New in version 3.8.

Property Details¶

EBookContacts.SourceBackendSummarySetup.props.indexed_fields¶

Name:	`indexed-fields`
Type:	`str`
Default Value:	`None`
Flags:	`READABLE`, `WRITABLE`, `CONSTRUCT`, `EXPLICIT_NOTIFY`

The list of summary fields which are to be given indexes in the underlying database

EBookContacts.SourceBackendSummarySetup.props.summary_fields¶

Name:	`summary-fields`
Type:	`str`
Default Value:	`None`
Flags:	`READABLE`, `WRITABLE`, `CONSTRUCT`, `EXPLICIT_NOTIFY`

The list of quick reference summary fields