freesmartphone.org PIM.ContactQuery Interface
Description
This interface gives access to a contact query.
Namespace
org.freesmartphone.PIM.ContactQuery
Methods
Signals
Properties
None
Errors
None
Methods
GetResultCount ( ) → i
Description: Return the number of items in the query result
Returns:
i: count Amount of contacts in the query result.
Rewind ( )
Description: Rewind the result cursor to the first contact (for this dbus client only).
Skip ( i )
Description: Skip n contacts in the result cursor (for this dbus client only).
Parameters:*
i: count Amount of contacts to skip.
GetContactPath ( ) → s
Description: Path for the contact the result cursor points to.
Returns:
s: contact_path The path to the contact.
GetResult ( ) → a{sv}
Description: Return the next contact in the query result, and move the query to the next contact.
Returns:
a{sv}: item fields of the result.
GetMultipleResults ( i ) → aa{sv}
Description: Get multiple contacts from the result set at once.
Parameters:*
i: count The number of contacts to get from the result set. A negative value means all.
Returns:
aa{sv}: resultset The list of the returned contacts data.
Dispose ( )
Description: Delete the query result object.
Signals
ContactAdded ( s )
Description: Sent when a new contact which matches this query is loaded.
Parameters:
s: contact_path The path of the newly loaded contact.