freesmartphone.org PIM.MessageQuery Interface

Description

Represent the result of a Query

Namespace

org.freesmartphone.PIM.MessageQuery

Methods

Signals

Properties

None

Errors

None

Methods

GetResultCount ( ) → i

Description: Return the number of items in the query result

Returns:

i: count Number of contacts in the query result.

Rewind ( )

Description: Rewind the result cursor to the first message (for this dbus client only)

Skip ( i )

Description: Skip n messages in the result cursor (for this dbus client only)

Parameters:*

i: count Amount of messages to skip

GetMessagePath ( ) → s

Description: Path for the message the result cursor points to.

Returns:

s: message_path The path to the message.

GetResult ( ) → a{sv}

Description: Return the next message in the query result, and move the query to the next message.

Returns:

a{sv}: item Fields of the message.

GetMultipleResults ( i ) → aa{sv}

Description: Get multiple message from the result set at once.

Parameters:*

i: count The amount of messages to get from the result set. A negative value means all.

Returns:

aa{sv}: resultset The list of the returned messages data.

Dispose ( )

Description: Delete the query result object.

Signals

MessageAdded ( s )

Description: Sent when a new message which matches this query is loaded.

Parameters:

s: message_path The path of the newly loaded message.