Functions¶
|
|
|
|
|
|
|
Details¶
- EDataBook.book_cache_search_data_free(data)¶
- Parameters:
data (
object
orNone
) – anEDataBook.BookCacheSearchData
Frees the data structure, previously allocated with
EDataBook.BookCacheSearchData.new
() orEDataBook.BookCacheSearchData.copy
().New in version 3.26.
- EDataBook.book_meta_backend_info_free(ptr)¶
- Parameters:
ptr (
object
orNone
) – anEDataBook.BookMetaBackendInfo
Frees the ptr structure, previously allocated with
EDataBook.BookMetaBackendInfo.new
() orEDataBook.BookMetaBackendInfo.copy
().New in version 3.26.
- EDataBook.ebsql_get_contact_extra_unlocked(ebsql, uid)¶
- Parameters:
ebsql (
EDataBook.BookSqlite
) – AnEDataBook.BookSqlite
uid (
str
) – The uid of the contact to fetch the extra data for
- Raises:
- Returns:
True
on success, otherwiseFalse
is returned and error is set appropriately.- ret_extra:
Return location to store the extra data
- Return type:
Fetches the extra data previously set for uid, either with
EDataBook.BookSqlite.set_contact_extra
() or when adding contacts, without locking internal mutex.New in version 3.16.
- EDataBook.ebsql_get_contact_unlocked(ebsql, uid, meta_contact)¶
- Parameters:
ebsql (
EDataBook.BookSqlite
) – AnEDataBook.BookSqlite
uid (
str
) – The uid of the contact to fetchmeta_contact (
bool
) – Whether an entire contact is desired, or only the metadata
- Raises:
- Returns:
True
on success, otherwiseFalse
is returned and error is set appropriately.- contact:
Return location to store the fetched contact
- Return type:
(
bool
, contact:EBookContacts.Contact
)
Fetch the
EBookContacts.Contact
specified by uid in ebsql without locking internal mutex.If meta_contact is specified, then a shallow
EBookContacts.Contact
will be created holding only theEBookContacts.ContactField.UID
andEBookContacts.ContactField.REV
fields.New in version 3.16.
- EDataBook.ebsql_get_vcard_unlocked(ebsql, uid, meta_contact)¶
- Parameters:
ebsql (
EDataBook.BookSqlite
) – AnEDataBook.BookSqlite
uid (
str
) – The uid of the contact to fetchmeta_contact (
bool
) – Whether an entire contact is desired, or only the metadata
- Raises:
- Returns:
True
on success, otherwiseFalse
is returned and error is set appropriately.- ret_vcard:
Return location to store the fetched vcard string
- Return type:
Fetch a vcard string for uid in ebsql without locking internal mutex.
If meta_contact is specified, then a shallow vcard representation will be created holding only the
EBookContacts.ContactField.UID
andEBookContacts.ContactField.REV
fields.New in version 3.16.