util_generate_alarms_for_uid_sync

Description:

[ Version ( since = "3.48" ) ]
public ComponentAlarms? util_generate_alarms_for_uid_sync (void* client, string uid, time_t start, time_t end, ComponentAlarmAction omit, RecurResolveTimezoneCb resolve_tzid, Timezone default_timezone, int def_reminder_before_start_seconds, Cancellable? cancellable = null) throws Error

Generates alarm instances for a calendar component with UID uid, which is stored within the client.

In contrast to util_generate_alarms_for_comp, this function handles detached instances of recurring events properly.

The def_reminder_before_start_seconds, if not negative, causes addition of an alarm, which will trigger a "display" alarm these seconds before start of the event.

Returns the instances structure, or null if no alarm instances occurred in the specified time range. Free the returned structure with e_cal_component_alarms_free, when no longer needed.

Parameters:

client	an Client
uid	a component UID to generate alarms for
start	start time
end	end time
omit	alarm types to omit
resolve_tzid	Callback for resolving timezones
default_timezone	The timezone used to resolve DATE and floating DATE-TIME values
def_reminder_before_start_seconds	add default reminder before start in seconds, when not negative value
cancellable	optional Cancellable object, or null
user_data	Data to be passed to the resolve_tzid callback

Returns:

a list of all the alarms found for the given component in the given time range.

Namespace: ECal

Package: libecal-2.0