Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents a single entry in an AsyncProject, listing the amount of time spent on each activity.

Hierarchy

Index

Properties

Optional created

created: Date

Entry creation date

default

(current date)

data

Activity data for the entry, where each element corresponds to the information for the Activity with the same index in the project's DesignModel.

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

Entry's most recent modification date

default

(current date)

Optional note

note: string

Additional written description associated with the entry

default

(empty)

period

period: Date

Which time period this entry corresponds to.

Time periods are timezone-agnostic and always represented using UTC. Implementers are strongly encouraged to normalize period values to the start of a day or week period. For example, an entry corresponding to June 20, 2021 should use the date 2021-06-20T00:00:00.000Z.

For week-based periods, use the day of the week indicated by the project's periodAlignment to normalize this value. That is, the value should be the start of a day whose getUTCDay() is the same as the periodAlignment.

For example, if periodAlignment is 1, a period for the week starting with Monday, June 21, 2021 should be represented by the date 2021-06-21T00:00:00.000Z

If necessary, non-normalized date values should be interpreted by truncation. For example, a value of 2021-06-23T01:33:40.908Z is interpreted as June 23, 2021. For week-based periods, if the weekday does not match periodAlignment, decrement the date until it does.

Generated using TypeDoc