freesmartphone.org PIM.Contacts Interface

Description

This interface provides access to the collection of PIM contacts.

Namespace

org.freesmartphone.PIM.Contacts

Methods

Signals

Properties

None

Errors

None

Methods

Add ( a{sv} ) → s

Description: Add a new contact to the default backend for contacts.

Parameters:*

a{sv}: contact_data The new contacts data.

Returns:

s: contact_path The contact path of the added contact.

GetSingleEntrySingleField ( a{sv}s ) → s

Description: Query the content of one field of one contact.

Parameters:*

a{sv}: query The query.

s: field The name of the field to query.

Returns:

s: value The content of the queried field.

Query ( a{sv} ) → s

Description: Start a query for contacts.

Parameters:*

a{sv}: query The query.

Returns:

s: query_path The path for the started query.

Signals

NewContact ( s )

Description: Sent when a new contact is loaded.

Parameters:

s: contact_path The path of the newly loaded contact.

UpdatedContact ( sa{sv} )

Description: Sent when an existing contact got updated.

Parameters:

s: contact_path The path of the updated contact.

a{sv}: contact_data The part of the contacts data that got changed.

DeletedContact ( s )

Description: Sent when a contact got deleted.

Parameters:

s: contact_path The path of that deleted contact.