Module task

Source

Structs§

TCTask
***** TCTask *****
TCTaskList
***** TCTaskList *****

Functions§

tc_task_add_annotation
Add an annotation to a mutable task. This call takes ownership of the passed annotation, which must not be used after the call returns.
tc_task_add_dependency
Add a dependency.
tc_task_add_tag
Add a tag to a mutable task.
tc_task_delete
Mark a task as deleted.
tc_task_done
Mark a task as done.
tc_task_error
Get the latest error for a task, or a string NULL ptr field if the last operation succeeded. Subsequent calls to this function will return NULL. The task pointer must not be NULL. The caller must free the returned string.
tc_task_free
Free a task. The given task must not be NULL. The task must not be used after this function returns, and must not be freed more than once.
tc_task_get_annotations
Get the annotations for the task.
tc_task_get_dependencies
Get all dependencies for a task.
tc_task_get_description
Get a task’s description.
tc_task_get_entry
Get the entry timestamp for a task (when it was created), or 0 if not set.
tc_task_get_legacy_uda
Get the named legacy UDA from the task.
tc_task_get_legacy_udas
Get all UDAs for this task.
tc_task_get_modified
Get the modified timestamp for a task, or 0 if not set.
tc_task_get_status
Get a task’s status.
tc_task_get_tags
Get the tags for the task.
tc_task_get_taskmap
Get the underlying key/value pairs for this task. The returned TCKVList is a “snapshot” of the task and will not be updated if the task is subsequently modified. It is the caller’s responsibility to free the TCKVList.
tc_task_get_uda
Get the named UDA from the task.
tc_task_get_udas
Get all UDAs for this task.
tc_task_get_uuid
Get a task’s UUID.
tc_task_get_value
Get a task property’s value, or NULL if the task has no such property, (including if the property name is not valid utf-8).
tc_task_get_wait
Get the wait timestamp for a task, or 0 if not set.
tc_task_has_tag
Check if a task has the given tag. If the tag is invalid, this function will return false, as that (invalid) tag is not present. No error will be reported via tc_task_error.
tc_task_is_active
Check if a task is active (started and not stopped).
tc_task_is_blocked
Check if a task is blocked (depends on at least one other task).
tc_task_is_blocking
Check if a task is blocking (at least one other task depends on it).
tc_task_is_waiting
Check if a task is waiting.
tc_task_list_free
Free a TCTaskList instance. The instance, and all TCTaskList it contains, must not be used after this call.
tc_task_list_take
Take an item from a TCTaskList. After this call, the indexed item is no longer associated with the list and becomes the caller’s responsibility, just as if it had been returned from tc_replica_get_task.
tc_task_remove_annotation
Remove an annotation from a mutable task.
tc_task_remove_dependency
Remove a dependency.
tc_task_remove_legacy_uda
Remove a UDA fraom a mutable task.
tc_task_remove_tag
Remove a tag from a mutable task.
tc_task_remove_uda
Remove a UDA fraom a mutable task.
tc_task_set_description
Set a mutable task’s description.
tc_task_set_entry
Set a mutable task’s entry (creation time). Pass entry=0 to unset the entry field.
tc_task_set_legacy_uda
Set a legacy UDA on a mutable task.
tc_task_set_modified
Set a mutable task’s modified timestamp. The value cannot be zero.
tc_task_set_status
Set a mutable task’s status.
tc_task_set_uda
Set a UDA on a mutable task.
tc_task_set_value
Set a mutable task’s property value by name. If value.ptr is NULL, the property is removed.
tc_task_set_wait
Set a mutable task’s wait timestamp. Pass wait=0 to unset the wait field.
tc_task_start
Start a task.
tc_task_stop
Stop a task.
tc_task_to_immut
Convert a mutable task into an immutable task.
tc_task_to_mut
Convert an immutable task into a mutable task.