Method

PurpleScheduledTaskschedule_relative

unstable since: 3.0

Declaration [src]

gboolean
purple_scheduled_task_schedule_relative (
  PurpleScheduledTask* task,
  GTimeSpan when,
  GError** error
)

Description [src]

Schedules the task with a relative time.

This is a wrapper around purple_scheduled_task_schedule() that will add when to the current time for you.

If the task has already been scheduled it will be cancelled and rescheduled for the new time.

If the when is in the past an error will be returned.

Available since: 3.0

Parameters

when

Type: GTimeSpan

A relative time span when to execute.

error

Type: GError **

The return location for a recoverable error.

The argument can be NULL.

If the return location is not NULL, then you must initialize it to a NULL GError*.

The argument will be left initialized to NULL by the method if there are no errors.

In case of error, the argument will be set to a newly allocated GError; the caller will take ownership of the data, and be responsible for freeing it.

Return value

Type: gboolean

True if the task was scheduled successfully.