GDataTasksTask

GDataTasksTask — GData Tasks task object

Stability Level

Unstable, unless otherwise indicated

Synopsis

#include <gdata/services/tasks/gdata-tasks-task.h>

                    GDataTasksTask;
                    GDataTasksTaskClass;
GDataTasksTask *    gdata_tasks_task_new                (const gchar *id);
const gchar *       gdata_tasks_task_get_parent         (GDataTasksTask *self);
const gchar *       gdata_tasks_task_get_position       (GDataTasksTask *self);
const gchar *       gdata_tasks_task_get_notes          (GDataTasksTask *self);
void                gdata_tasks_task_set_notes          (GDataTasksTask *self,
                                                         const gchar *notes);
const gchar *       gdata_tasks_task_get_status         (GDataTasksTask *self);
void                gdata_tasks_task_set_status         (GDataTasksTask *self,
                                                         const gchar *status);
gint64              gdata_tasks_task_get_due            (GDataTasksTask *self);
void                gdata_tasks_task_set_due            (GDataTasksTask *self,
                                                         gint64 due);
gint64              gdata_tasks_task_get_completed      (GDataTasksTask *self);
void                gdata_tasks_task_set_completed      (GDataTasksTask *self,
                                                         gint64 completed);
gboolean            gdata_tasks_task_is_deleted         (GDataTasksTask *self);
void                gdata_tasks_task_set_is_deleted     (GDataTasksTask *self,
                                                         gboolean deleted);
gboolean            gdata_tasks_task_is_hidden          (GDataTasksTask *self);

Object Hierarchy

  GObject
   +----GDataParsable
         +----GDataEntry
               +----GDataTasksTask

Properties

  "completed"                gint64                : Read / Write
  "due"                      gint64                : Read / Write
  "is-deleted"               gboolean              : Read / Write
  "is-hidden"                gboolean              : Read
  "notes"                    gchar*                : Read / Write
  "parent"                   gchar*                : Read
  "position"                 gchar*                : Read
  "status"                   gchar*                : Read / Write

Description

GDataTasksTask is a subclass of GDataEntry to represent a task in a tasklist from Google Tasks.

For more details of Google Tasks API, see the online documentation.

Details

GDataTasksTask

typedef struct _GDataTasksTask GDataTasksTask;

All the fields in the GDataTasksTask structure are private and should never be accessed directly.

Since UNRELEASED


GDataTasksTaskClass

typedef struct {
} GDataTasksTaskClass;

All the fields in the GDataTasksTaskClass structure are private and should never be accessed directly.

Since UNRELEASED


gdata_tasks_task_new ()

GDataTasksTask *    gdata_tasks_task_new                (const gchar *id);

Creates a new GDataTasksTask with the given ID and default properties.

id :

the task's ID, or NULL. [allow-none]

Returns :

a new GDataTasksTask; unref with g_object_unref()

Since UNRELEASED


gdata_tasks_task_get_parent ()

const gchar *       gdata_tasks_task_get_parent         (GDataTasksTask *self);

Gets the "parent" property.

self :

a GDataTasksTask

Returns :

the parent of the task, or NULL. [allow-none]

Since UNRELEASED


gdata_tasks_task_get_position ()

const gchar *       gdata_tasks_task_get_position       (GDataTasksTask *self);

Gets the "position" property.

self :

a GDataTasksTask

Returns :

the position of the task, or NULL. [allow-none]

Since UNRELEASED


gdata_tasks_task_get_notes ()

const gchar *       gdata_tasks_task_get_notes          (GDataTasksTask *self);

Gets the "notes" property.

self :

a GDataTasksTask

Returns :

notes of the task, or NULL. [allow-none]

Since UNRELEASED


gdata_tasks_task_set_notes ()

void                gdata_tasks_task_set_notes          (GDataTasksTask *self,
                                                         const gchar *notes);

Sets the "notes" property to the new notes, notes.

Set notes to NULL to unset the property in the task.

self :

a GDataTasksTask

notes :

a new notes of the task, or NULL. [allow-none]

Since UNRELEASED


gdata_tasks_task_get_status ()

const gchar *       gdata_tasks_task_get_status         (GDataTasksTask *self);

Gets the "status" property.

self :

a GDataTasksTask

Returns :

the status of the task, or NULL. [allow-none]

Since UNRELEASED


gdata_tasks_task_set_status ()

void                gdata_tasks_task_set_status         (GDataTasksTask *self,
                                                         const gchar *status);

Sets the "status" property to the new status, status.

Set status to NULL to unset the property in the task.

self :

a GDataTasksTask

status :

a new status of the task, or NULL. [allow-none]

Since UNRELEASED


gdata_tasks_task_get_due ()

gint64              gdata_tasks_task_get_due            (GDataTasksTask *self);

Gets the "due" property. If the property is unset, -1 will be returned.

self :

a GDataTasksTask

Returns :

the due property, or -1

Since UNRELEASED


gdata_tasks_task_set_due ()

void                gdata_tasks_task_set_due            (GDataTasksTask *self,
                                                         gint64 due);

Sets the "due" property of the GDataTasksTask to the new due time of the task, due.

Set due to -1 to unset the property in the due time of the task

self :

a GDataTasksTask

due :

due time of the task, or -1

Since UNRELEASED


gdata_tasks_task_get_completed ()

gint64              gdata_tasks_task_get_completed      (GDataTasksTask *self);

Gets the "completed" property. If the property is unset, -1 will be returned.

self :

a GDataTasksTask

Returns :

the completed property, or -1

Since UNRELEASED


gdata_tasks_task_set_completed ()

void                gdata_tasks_task_set_completed      (GDataTasksTask *self,
                                                         gint64 completed);

Sets the "completed" property of the GDataTasksTask to the new completion time of the task, completed.

Set completed to -1 to unset the property in the completion time of the task

self :

a GDataTasksTask

completed :

completion time of the task, or -1

Since UNRELEASED


gdata_tasks_task_is_deleted ()

gboolean            gdata_tasks_task_is_deleted         (GDataTasksTask *self);

Gets the "is-deleted" property.

self :

a GDataTasksTask

Returns :

TRUE if task is deleted, FALSE otherwise

Since UNRELEASED


gdata_tasks_task_set_is_deleted ()

void                gdata_tasks_task_set_is_deleted     (GDataTasksTask *self,
                                                         gboolean deleted);

Sets the "is-deleted" property to deleted.

self :

a GDataTasksTask

deleted :

TRUE if task is deleted, FALSE otherwise

Since UNRELEASED


gdata_tasks_task_is_hidden ()

gboolean            gdata_tasks_task_is_hidden          (GDataTasksTask *self);

Gets the "is-hidden" property.

self :

a GDataTasksTask

Returns :

TRUE if task is hidden, FALSE otherwise

Since UNRELEASED

Property Details

The "completed" property

  "completed"                gint64                : Read / Write

Completion date of the task (as a RFC 3339 timestamp). This field is -1 if the task has not been completed.

Allowed values: >= -1

Default value: -1

Since UNRELEASED


The "due" property

  "due"                      gint64                : Read / Write

Due date of the task (as a RFC 3339 timestamp). This field is -1 if task has not due date asigned.

Allowed values: >= -1

Default value: -1

Since UNRELEASED


The "is-deleted" property

  "is-deleted"               gboolean              : Read / Write

Flag indicating whether the task has been deleted. The default is FALSE.

Default value: FALSE

Since UNRELEASED


The "is-hidden" property

  "is-hidden"                gboolean              : Read

Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is FALSE. This field is read-only.

Default value: FALSE

Since UNRELEASED


The "notes" property

  "notes"                    gchar*                : Read / Write

This is where the description of what needs to be done in the task is stored.

Default value: NULL

Since UNRELEASED


The "parent" property

  "parent"                   gchar*                : Read

Parent task identifier. This field is omitted if it is a top-level task. This field is read-only.

Default value: NULL

Since UNRELEASED


The "position" property

  "position"                 gchar*                : Read

String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). This field is read-only.

Default value: NULL

Since UNRELEASED


The "status" property

  "status"                   gchar*                : Read / Write

Status of the task. This is either "needsAction" or "completed".

Default value: NULL

Since UNRELEASED