freesmartphone.org Framework DBus Interface Specification

org.freesmartphone.Time.Alarm

Description

The Alarm interface is used to register wakeup alarms. Alarm notifications will be submitted as dbus method calls, hence alarm receivers need to implement the interface org.freesmartphone.Notification on the root object. Alarm receivers need to be running dbus system services or dbus system-activatible. If the system features a suspend mode, the framework will ensure that the system is awake at the time the alarm triggers. Multiple alarms per bus name can be registered. If you want to register named alarm (e.g. agenda items, birthdays, etc.), consider using the PIM services instead.

Namespace

org.freesmartphone.Time.Alarm

Methods

Signals

None

Properties

None

Errors

None

Methods

ClearAlarms ( s )

Description: Clear all scheduled alarms for a given dbus service name.

Parameters

s: busname

The dbus service bus name to clear all alarms for.

ListAlarms ( ) → a(si)

Description: List all currently scheduled alarms.

Returns

a(si): alarms

All currently scheduled alarms.

RemoveAlarm ( si )

Description: Removes a scheduled alarm.

Parameters

s: busname

The dbus service bus name to clear the alarm for.

i: timestamp

When to call in seconds since 1970 (epoch).

AddAlarm ( si )

Description: Schedules an alarm for a given dbus service name. The alarm will be triggered by calling the service's Alarm method on the root (/) object.

Make sure to specify a dbus system service configuration file for the services that use this interface. This way, you can receive alarm notifications even when your service is not running at the time the alarm fires.

Parameters

s: busname

The dbus service name to call.

i: timestamp

When to call in seconds since 1970 (epoch).


| Specified 2008-2012 by the Freesmartphone.org team. | Join us and discuss further drafts smartphones-standards (at) linuxtogo (dot) org