Interface Task

Objo-related metadata for the tasks in a user's vault.

interface Task {
    dates: {
        cancelled: DateTime;
        created: DateTime;
        done: DateTime;
        due: DateTime;
        scheduled: DateTime;
        start: DateTime;
    };
    dependsOn: ReadonlySet<string>;
    description: string;
    id: string;
    priority: number;
    source: TaskSource;
    status: TaskStatus;
    tags: ReadonlySet<string>;
}

Properties

dates: {
    cancelled: DateTime;
    created: DateTime;
    done: DateTime;
    due: DateTime;
    scheduled: DateTime;
    start: DateTime;
}

Dates associated with the task.

Type declaration

  • cancelled: DateTime

    When the task was cancelled.

  • created: DateTime

    When the task was created.

  • done: DateTime

    When the task was completed.

  • due: DateTime

    When the task is due.

  • scheduled: DateTime

    When the task is scheduled to be started.

  • start: DateTime

    When the task is able to be started.

dependsOn: ReadonlySet<string>

The set of Task.ids that need to be completed before this task can be started.

description: string

The description of the task.

id: string

An optional user-defined string that uniquely identifies this task across the vault.

priority: number

The priority of the task. Lower numbers represent higher priorities.

source: TaskSource

Metadata describing where the task was extracted from.

status: TaskStatus

Metadata describing the actionable status of the task.

tags: ReadonlySet<string>

The tags associated with this task. The leading hashtag ("#") is omitted.