Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RealtimeProject

Represents a project tracked in realtime (i.e., "synchronously").

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

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

[]

sessions

sessions: RealtimeSession[]

Sessions contained in the project, which contain the project's tracking data.

Generated using TypeDoc