freesmartphone.org PIM.Messages Interface
Description
This interface provides access to the list of messages.
Namespace
org.freesmartphone.PIM.Messages
Methods
Signals
Properties
None
Errors
None
Methods
Add ( a{sv} ) → s
Description: Add a new message to the default message backend.
Parameters:*
a{sv}: message_data The data of the message.
Returns:
s: message_path The path of the newly added message.
AddIncoming ( a{sv} ) → s
Description: Add a new message to the default message backend and notify client about incoming message.
Parameters:*
a{sv}: message_data The data of the message.
Returns:
s: message_path The path of the newly added message.
GetSingleEntrySingleField ( a{sv}s ) → s
Description: Query the content of a single field of one message.
Parameters:*
a{sv}: query The query.
s: field The name of the field to return the value for.
Returns:
s: value The value of the queried field.
Query ( a{sv} ) → s
Description: Query a list of messages.
Parameters:*
a{sv}: query The query.
Returns:
s: query_path The path for the started query.
QueryThreads ( a{sv} ) → s
Description: Query a list of message threads.
Parameters:*
a{sv}: query The query.
Returns:
s: query_path The path for the started query.
GetUnreadMessages ( ) → i
Description: Get the amount of unread incoming messages.
Returns:
i: amount Amount of unread messages
Signals
NewMessage ( s )
Description: Sent when a new message is loaded.
Parameters:
s: message_path The path of the newly loaded message.
IncomingMessage ( s )
Description: Sent when a incoming message arrives.
Parameters:
s: message_path The path of the newly arrived incoming message.
UnreadMessages ( i )
Description: Sent when amount of unread incoming messages changes.
Parameters:
i: amount Amount of unread incoming messages.
UpdatedMessage ( sa{sv} )
Description: Sent whenever a message has been updated.
Parameters:
s: message_path The DBus path of the message that was updated.
a{sv}: message_data The data that was changed for the message.
DeletedMessage ( s )
Description: Sent whenever a message has been deleted.
Parameters:
s: message_path The DBus path of the message that has been deleted.