EDataBook.BookCacheSearchData

Fields

Name	Type	Access	Description
extra	str	r/w	Any extra data associated with the vcard
uid	str	r/w	The EBookContacts.ContactField.UID field of this contact
vcard	str	r/w	The vcard string

Methods

class	free (data)
class	new (uid, vcard, extra)
	copy ()

Details

class EDataBook.BookCacheSearchData

This structure is used to represent contacts returned by the EDataBook.BookCache from various functions such as EDataBook.BookCache.search().

The extra parameter will contain any data which was previously passed for this contact in EDataBook.BookCache.put_contact() or set with EDataBook.BookCache.set_contact_extra().

These should be freed with EDataBook.BookCacheSearchData.free().

New in version 3.26.

classmethod free(data)

Parameters:

data (object or None) – an EDataBook.BookCacheSearchData

Frees the data structure, previously allocated with EDataBook.BookCacheSearchData.new() or EDataBook.BookCacheSearchData.copy().

New in version 3.26.

classmethod new(uid, vcard, extra)

Parameters:

• uid (str) – a contact UID; cannot be None

• vcard (str) – the contact as a vCard string; cannot be None

• extra (str or None) – any extra data stored with the contact, or None

Returns:

A new EDataBook.BookCacheSearchData. Free it with EDataBook.BookCacheSearchData.free() when no longer needed.

Return type:

EDataBook.BookCacheSearchData

Creates a new EDataBook.BookCacheSearchData prefilled with the given values.

New in version 3.26.

copy()

Returns:

Copy of the given self. Free it with EDataBook.BookCacheSearchData.free() when no longer needed. If the self is None, then returns None as well.

Return type:

EDataBook.BookCacheSearchData or None

New in version 3.26.