Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AsyncProject

Represents a project with timing data logged retrospectively (i.e., "asynchronously").

Hierarchy

Index

Properties

Optional active

active: boolean

Whether the project is active. When a project is active, it can show up in the user's recent projects and tracking/adding entries is possible. If not active, the project is "archived".

default

true

Optional created

created: Date

Project creation date

default

(current date)

Optional description

description: string

Project description (plain text)

default

(empty)

designModel

designModel: DesignModel

Design model used by this project

entries

entries: AsyncEntry[]

Entries in the project, which contain activity time data.

id

id: string

An identifier for this entity. In most cases, this identifier should be globally unique and not start with well-known:. The Design Awareness App generates random 24-character alphanumeric IDs for this purpose.

Well-known or standard entities (currently only DesignModels) should use the format:

"well-known:" + (reverse DNS identifier) [optionally, + "@" + version]
example

"well-known:edu.washington.hcde.engineering-design@1"

example

"kobyeor9a9y5cca9iufm8jjv"

Optional modified

modified: Date

Project's most recent modification date

default

(current date)

name

name: string

Project name

Optional notes

notes: ProjectNote[]

Project-level notes not associated with any particular entry, session, or activity.

default

[]

Optional periodAlignment

periodAlignment: Weekday

Used for projects where the reportingPeriod is week to determine which weekday is the "start" of the week.

This property is not required when reportingPeriod is day, but it may still be useful to decide how to align weekly summaries in a UI or report.

default

0 (Sunday)

reportingPeriod

reportingPeriod: "day" | "week"

Timescale of entry logging for this project.

Generated using TypeDoc