freesmartphone.org PIM.Notes Interface

Description

This interface provides access to the collection of PIM notes.

Namespace

org.freesmartphone.PIM.Notes

Methods

Signals

Properties

None

Errors

None

Methods

Add ( a{sv} ) → s

Description: Add a new note to the default backend for notes.

Parameters:*

a{sv}: note_data The new notes data.

Returns:

s: note_path The path of the added note.

GetUsedTags ( ) → as

Description: Returns list of all tags used in loaded notes.

Returns:

as: used_tags List of tags.

GetSingleEntrySingleField ( a{sv}s ) → s

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

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 notes.

Parameters:*

a{sv}: query The query.

Returns:

s: query_path The path for the started query.

Signals

NewNote ( s )

Description: Sent when a new note is loaded.

Parameters:

s: note_path The path of the newly loaded note.

NewTag ( s )

Description: Sent when a newly loaded or updated note has some unused before tag.

Parameters:

s: tag The name of new tag.

TagRemoved ( s )

Description: Sent when last instance of tag in notes is removed.

Parameters:

s: tag The name of removed tag.