family.pardy.familytime.event Documentation (EN)

main record

Something on the schedule, in the family space. Shows only once a parent approves this exact version in the approvals space (the app approves a parent's own events as they add them). Board configuration: board space (parents only); each parent saves their own copy with rkey = id, and the newest updatedAt wins (a deleted copy removes it).

Record Key any Any valid record key

Properties

anchor string Optional

Marks the start or end of the day for the people it's for; free time is planned between these.

Known values: wake, bedtime

countdown ref #countdown Optional

No description available.

createdAt string datetime Required

An RFC 3339 formatted timestamp.

date string Required

YYYY-MM-DD in the household time zone.

maxLength: 10 bytes

deleted boolean Optional

Removed, when this is the newest copy.

emoji string Required

No description available.

maxLength: 32 bytesmaxGraphemes: 2 graphemes

endDate string Optional

YYYY-MM-DD: the last day of something that spans days (a trip). Shown all day on each day.

maxLength: 10 bytes

endTime string Optional

HH:MM, 24-hour, household wall-clock.

maxLength: 5 bytes

id string Required

Stable across edits and parents; the record key.

maxLength: 64 bytes

image blob Optional

A photo shown instead of the emoji, e.g. the people you're visiting. Referenced from the private space.

maxSize: 1.0 MB

note string Optional

No description available.

maxLength: 1000 bytes

repeat ref #repeat Optional

No description available.

startTime string Optional

HH:MM, 24-hour, household wall-clock.

maxLength: 5 bytes

title string Required

No description available.

maxLength: 200 bytes

updatedAt string datetime Required

Last write wins across parents.

who array of string did Optional

Members it's for; empty means everyone.

View raw schema

{
  "description": "Something on the schedule, in the family space. Shows only once a parent approves this exact version in the approvals space (the app approves a parent's own events as they add them). Board configuration: board space (parents only); each parent saves their own copy with rkey = id, and the newest updatedAt wins (a deleted copy removes it).",
  "key": "any",
  "record": {
    "properties": {
      "anchor": {
        "description": "Marks the start or end of the day for the people it's for; free time is planned between these.",
        "knownValues": [
          "wake",
          "bedtime"
        ],
        "type": "string"
      },
      "countdown": {
        "ref": "#countdown",
        "type": "ref"
      },
      "createdAt": {
        "format": "datetime",
        "type": "string"
      },
      "date": {
        "description": "YYYY-MM-DD in the household time zone.",
        "maxLength": 10,
        "type": "string"
      },
      "deleted": {
        "description": "Removed, when this is the newest copy.",
        "type": "boolean"
      },
      "emoji": {
        "maxGraphemes": 2,
        "maxLength": 32,
        "type": "string"
      },
      "endDate": {
        "description": "YYYY-MM-DD: the last day of something that spans days (a trip). Shown all day on each day.",
        "maxLength": 10,
        "type": "string"
      },
      "endTime": {
        "description": "HH:MM, 24-hour, household wall-clock.",
        "maxLength": 5,
        "type": "string"
      },
      "id": {
        "description": "Stable across edits and parents; the record key.",
        "maxLength": 64,
        "type": "string"
      },
      "image": {
        "accept": [
          "image/png",
          "image/jpeg",
          "image/webp"
        ],
        "description": "A photo shown instead of the emoji, e.g. the people you're visiting. Referenced from the private space.",
        "maxSize": 1000000,
        "type": "blob"
      },
      "note": {
        "maxLength": 1000,
        "type": "string"
      },
      "repeat": {
        "ref": "#repeat",
        "type": "ref"
      },
      "startTime": {
        "description": "HH:MM, 24-hour, household wall-clock.",
        "maxLength": 5,
        "type": "string"
      },
      "title": {
        "maxLength": 200,
        "type": "string"
      },
      "updatedAt": {
        "description": "Last write wins across parents.",
        "format": "datetime",
        "type": "string"
      },
      "who": {
        "description": "Members it's for; empty means everyone.",
        "items": {
          "format": "did",
          "type": "string"
        },
        "type": "array"
      }
    },
    "required": [
      "createdAt",
      "date",
      "emoji",
      "id",
      "title",
      "updatedAt"
    ],
    "type": "object"
  },
  "type": "record"
}

countdown object

A big day: the wall counts down to it, starting this many days before.

Properties

days integer Required

No description available.

minimum: 1maximum: 90

View raw schema

{
  "description": "A big day: the wall counts down to it, starting this many days before.",
  "properties": {
    "days": {
      "maximum": 90,
      "minimum": 1,
      "type": "integer"
    }
  },
  "required": [
    "days"
  ],
  "type": "object"
}

repeat object

No description available.

Properties

until string Optional

YYYY-MM-DD in the household time zone.

maxLength: 10 bytes

weekdays array of integer Required

0 = Sunday.

View raw schema

{
  "properties": {
    "until": {
      "description": "YYYY-MM-DD in the household time zone.",
      "maxLength": 10,
      "type": "string"
    },
    "weekdays": {
      "description": "0 = Sunday.",
      "items": {
        "maximum": 6,
        "minimum": 0,
        "type": "integer"
      },
      "type": "array"
    }
  },
  "required": [
    "weekdays"
  ],
  "type": "object"
}