alarm_dbus.h File Reference

DBus constants for alarm daemon. More...

Go to the source code of this file.

Defines
Alarm D-Bus daemon
#define	ALARMD_SERVICE   "com.nokia.alarmd"
#define	ALARMD_PATH   "/com/nokia/alarmd"
#define	ALARMD_INTERFACE   "com.nokia.alarmd"
DBus methods for all clients
#define	ALARMD_EVENT_ADD   "add_event"
#define	ALARMD_EVENT_GET   "get_event"
#define	ALARMD_EVENT_DEL   "del_event"
#define	ALARMD_EVENT_QUERY   "query_event"
#define	ALARMD_EVENT_UPDATE   "update_event"
#define	ALARMD_SNOOZE_SET   "set_snooze"
#define	ALARMD_SNOOZE_GET   "get_snooze"
DBus methods for SystemUI
#define	ALARMD_DIALOG_ACK   "ack_dialog"
#define	ALARMD_DIALOG_RSP   "rsp_dialog"
DBus signals emitted by alarmd
#define	ALARMD_QUEUE_STATUS_IND   "queue_status_ind"
#define	ALARMD_TIME_CHANGE_IND   "time_change_ind"

---

Detailed Description

DBus constants for alarm daemon.

The Constants used for communication with alarm daemon over dbus.

Copyright (C) 2008 Nokia. All rights reserved.

Author:

Simo Piiroinen <simo.piiroinen@nokia.com>

---

Define Documentation

#define ALARMD_SERVICE   "com.nokia.alarmd"

D-Bus service name

#define ALARMD_PATH   "/com/nokia/alarmd"

D-Bus object path

#define ALARMD_INTERFACE   "com.nokia.alarmd"

D-Bus interface name

#define ALARMD_EVENT_ADD   "add_event"

Adds an alarm event into the queue. Returns unique identifier for queued event.

Parameters:

	actions	: UINT32
	cookie	: INT32
	trigger	: INT32
	title	: STRING
	message	: STRING
	sound	: STRING
	icon	: STRING
	flags	: UINT32
	alarm_time	: INT32
	alarm_year	: INT32
	alarm_mon	: INT32
	alarm_mday	: INT32
	alarm_hour	: INT32
	alarm_min	: INT32
	alarm_sec	: INT32
	alarm_tz	: STRING
	recur_secs	: INT32
	recur_count	: INT32
	snooze_secs	: INT32
	snooze_total	: INT32
	action	: ARRAY of STRUCT { flags : UINT32 - repeats 'actions' times label : STRING exec_command : STRING dbus_interface : STRING dbus_service : STRING dbus_path : STRING dbus_name : STRING dbus_args : STRING }

Returns:

cookie : INT32, -1 = error

#define ALARMD_EVENT_GET   "get_event"

Fetches alarm event details

Parameters:

cookie

: INT32

Returns:

actions : UINT32
cookie : INT32
trigger : INT32
title : STRING
message : STRING
sound : STRING
icon : STRING
flags : UINT32
alarm_time : INT32
alarm_year : INT32
alarm_mon : INT32
alarm_mday : INT32
alarm_hour : INT32
alarm_min : INT32
alarm_sec : INT32
alarm_tz : STRING
recur_secs : INT32
recur_count : INT32
snooze_secs : INT32
snooze_total : INT32
action : ARRAY of STRUCT {
flags : UINT32
label : STRING
exec_command : STRING
dbus_interface : STRING
dbus_service : STRING
dbus_path : STRING
dbus_name : STRING
dbus_args : STRING
}

#define ALARMD_EVENT_DEL   "del_event"

Removes event from the queue.

Parameters:

cookie

: INT32

Returns:

deleted : BOOLEAN

#define ALARMD_EVENT_QUERY   "query_event"

Queries the queue for matching events.

Returns cookies for events that have start_time <= trigger time <= stop_time and (flags & flag_mask) == flag_want.

Special case: start_time and stop_time are both zero -> get all events.

Parameters:

	start_time	: INT32 [time_t]
	stop_time	: INT32 [time_t]
	flag_mask	: INT32
	flag_want	: INT32
	app_name	: STRING

Returns:

cookies : ARRAY of INT32

#define ALARMD_EVENT_UPDATE   "update_event"

Updates an existing event.

Performs delete and add in one DBus transaction. The cookie returned will differ from the original.

Parameters:

	actions	: UINT32
	cookie	: INT32
	trigger	: INT32
	title	: STRING
	message	: STRING
	sound	: STRING
	icon	: STRING
	flags	: UINT32
	alarm_time	: INT32
	alarm_year	: INT32
	alarm_mon	: INT32
	alarm_mday	: INT32
	alarm_hour	: INT32
	alarm_min	: INT32
	alarm_sec	: INT32
	alarm_tz	: STRING
	recur_secs	: INT32
	recur_count	: INT32
	snooze_secs	: INT32
	snooze_total	: INT32
	action	: ARRAY of STRUCT { flags : UINT32 - repeats 'actions' times label : STRING exec_command : STRING dbus_interface : STRING dbus_service : STRING dbus_path : STRING dbus_name : STRING dbus_args : STRING }

Returns:

cookie : INT32, -1 = error

#define ALARMD_SNOOZE_SET   "set_snooze"

Set default snooze time in seconds.

Parameters:

snooze

: UINT32

Returns:

success : BOOLEAN

#define ALARMD_SNOOZE_GET   "get_snooze"

Get default snooze time in seconds.

Parameters:

n/a

Returns:

snooze : UINT32

#define ALARMD_DIALOG_ACK   "ack_dialog"

Acknowledge alarm events queued for dialog service.

Parameters:

cookies

: ARRAY of INT32

Returns:

received : BOOLEAN

#define ALARMD_DIALOG_RSP   "rsp_dialog"

Acknowledge alarm event action taken by the user

Parameters:

	cookie	: INT32
	action	: INT32

Returns:

received : BOOLEAN

#define ALARMD_QUEUE_STATUS_IND   "queue_status_ind"

Alarm queue status change indication.

Number of currently triggered alarms and trigger times for alarms that power up to desktop, power up to acting dead and alarms without power up flags.

Parameters:

	alarms	: INT32
	desktop	: INT32
	actdead	: INT32
	noboot	: INT32

#define ALARMD_TIME_CHANGE_IND   "time_change_ind"

System time or timezone change handled indication.

Since:

v1.0.11

When timezone or system time changes, some alarms might need to be rescheduled.

This signal is sent after all state transitions due to system time or timezone changes are handled by alarmd and all events hold valid trigger time.

---