Name

triggerEvent — trigger an already scheduled alarm.

Synopsis

void triggerEvent(const QString& eventID)

Parameters

eventID

Specifies the unique ID of the event to be triggered.

Description

triggerEvent() is a D-Bus call to trigger the immediate display or execution of the specified alarm (regardless of what time it is scheduled for). KAlarm retrieves the alarm from the calendar and then displays or executes it.

If the alarm is already due, KAlarm then deletes all scheduled occurrences of the alarm up to the current time, and if no repetitions of the alarm still remain, the alarm is deleted from the calendar. If the alarm is not due yet, its scheduled occurrences are left unchanged.