EDataBook.DataBookCursorCache¶

Methods¶

class

new (book_backend, book_cache, sort_fields, sort_types)

Name	Type	Flags	Short Description
`book-cache`	`EDataBook.BookCache`	w/co	The `EDataBook.BookCache` to use for queries
`cursor`	`int`	w/co	The `EDataBook.BookCacheCursor` pointer

Name	Type	Access	Description
parent	`EDataBook.DataBookCursor`	r

class EDataBook.DataBookCursorCache(**kwargs)¶

An opaque handle for the EDataBook.BookCache cursor instance.

New in version 3.26.

classmethod new(book_backend, book_cache, sort_fields, sort_types)¶

Parameters:

book_backend (EDataBook.BookBackend) – the EDataBook.BookBackend creating this cursor
book_cache (EDataBook.BookCache) – the EDataBook.BookCache object to base this cursor on
sort_fields ([EBookContacts.ContactField]) – an array of EBookContacts.ContactFields as sort keys in order of priority
sort_types ([EBookContacts.BookCursorSortType]) – an array of EBookContacts.BookCursorSortTypes, one for each field in sort_fields

Raises:

GLib.Error

Returns:

A newly created EDataBook.DataBookCursor, or None if cursor creation failed.

Return type:

EDataBook.DataBookCursor

Creates an EDataBook.DataBookCursor and implements all of the cursor methods using the delegate book_cache object.

This is suitable cursor type for any backend which stores its contacts using the EDataBook.BookCache object. The EDataBook.BookMetaBackend does that transparently.

New in version 3.26.

EDataBook.DataBookCursorCache.props.book_cache¶

The EDataBook.BookCache to use for queries

EDataBook.DataBookCursorCache.props.cursor¶