Method

PurpleScheduleradd_task

unstable since: 3.0

Declaration [src]

gboolean
purple_scheduler_add_task (
  PurpleScheduler* scheduler,
  PurpleScheduledTask* task,
  GDateTime* execute_at,
  GError** error
)

Description [src]

Adds a new task to the scheduler.

If the task has already been added, false will be returned and error will be set.

If task is already scheduled, it will be rescheduled to run at execute_at.

Available since: 3.0

Parameters

task

Type: PurpleScheduledTask

The task to add.

The data is owned by the caller of the method.

execute_at

Type: GDateTime

The date time for when the task should be executed.

The data is owned by the caller of the method.

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 added successfully.