alarm_dbus

alarm_dbus — The DBus API.

Synopsis




#define     ALARMD_SERVICE
#define     ALARMD_PATH
#define     ALARMD_INTERFACE
#define     ALARM_EVENT_ADD
#define     ALARM_EVENT_DEL
#define     ALARM_EVENT_QUERY
#define     ALARM_EVENT_GET
#define     ALARMD_SNOOZE_SET
#define     ALARMD_SNOOZE_GET

Description

Defines DBus service and method names to communicate with alarmd.

Details

ALARMD_SERVICE

#define ALARMD_SERVICE "com.nokia.alarmd"

The name of the alarmd service.


ALARMD_PATH

#define ALARMD_PATH "/com/nokia/alarmd"

The object path for the alarmd daemon.


ALARMD_INTERFACE

#define ALARMD_INTERFACE "com.nokia.alarmd"

The interface the commands use.


ALARM_EVENT_ADD

#define ALARM_EVENT_ADD "add_event"

Adds an event into the queue.

Parameters:

OBJECT_PATH: Name of the object type.

UINT32: Count of arguments for the object.

STRING: Parameter 1 name.

TYPE: Parameter 1 value.

STRING: Parameter 2 name.

TYPE: Parameter 2 value. ...

Return:

INT32: unique id for the alarm


ALARM_EVENT_DEL

#define ALARM_EVENT_DEL "del_event"

Removes event from the queue.

Parameters:

INT32: The id of the alarm event.

Return:

BOOL: TRUE on success.


ALARM_EVENT_QUERY

#define ALARM_EVENT_QUERY "query_event"

Queries the queue for matching events.

Parameters:

UINT64: Start time of query (seconds since Jan 1 1970 00:00:00 UTC. UINT64: End time of query.

INT32: Flag mask to select events (0 to get all.

INT32: Wanted flag values.

Return:

Array of INT32s: The event id's.


ALARM_EVENT_GET

#define ALARM_EVENT_GET "get_event"

Parameters: INT32: The id of the alarm event. Return:

OBJECT_PATH: Name of the object type.

UINT32: Count of arguments for the object.

STRING: Parameter 1 name.

TYPE: Parameter 1 value.

STRING: Parameter 2 name.

TYPE: Parameter 2 value. ...


ALARMD_SNOOZE_SET

#define ALARMD_SNOOZE_SET "set_snooze"

Parameters: UINT32: The amount of minutes the default snooze should be.

Return:

BOOLEAN: Status of the request.


ALARMD_SNOOZE_GET

#define ALARMD_SNOOZE_GET "get_snooze"

Return: UINT32: The amount of minutes the default snooze is.