com.chadtmiller.calendar.event

chadtmiller.com

Documentation

An entry on a personal schedule. The record is written into a permissioned space, so only that space's members read it.

main record

An entry on a personal schedule. The record is written into a permissioned space, so only that space's members read it.

Record Key tid Timestamp-based ID

Properties

allDay boolean Optional

The entry fills whole days and has no time of day.

category string Optional

The kind of entry. A reader that shows colours picks one from this.

Known values: work, personal, travel, health, social
createdAt string datetime Required

When the entry was written.

endsAt string datetime Optional

When the entry ends. An all-day entry ends at midnight UTC on its last day, and that day is part of the entry.

location string Optional

Where the entry takes place, as text.

maxLength: 2000 bytes
notes string Optional

Free text about the entry.

maxLength: 30000 bytesmaxGraphemes: 3000 graphemes
recurrence string Optional

An RFC 5545 recurrence rule with no RRULE: prefix, such as FREQ=WEEKLY;BYDAY=TU. The entry repeats on the days the rule names.

maxLength: 1000 bytes
startsAt string datetime Required

When the entry starts. An all-day entry starts at midnight UTC on its first day.

status string Optional

How firm the entry is.

Known values: confirmed, tentative, cancelled
Default: confirmed
timeZone string Optional

The IANA time zone the entry was written in, such as America/New_York.

title string Required

What the entry is called.

maxLength: 3000 bytesmaxGraphemes: 300 graphemes
url string uri Optional

A link for the entry, such as a meeting room or a ticket.

View raw schema 
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "title",
      "startsAt",
      "createdAt"
    ],
    "properties": {
      "url": {
        "type": "string",
        "format": "uri",
        "description": "A link for the entry, such as a meeting room or a ticket."
      },
      "notes": {
        "type": "string",
        "maxLength": 30000,
        "description": "Free text about the entry.",
        "maxGraphemes": 3000
      },
      "title": {
        "type": "string",
        "maxLength": 3000,
        "description": "What the entry is called.",
        "maxGraphemes": 300
      },
      "allDay": {
        "type": "boolean",
        "description": "The entry fills whole days and has no time of day."
      },
      "endsAt": {
        "type": "string",
        "format": "datetime",
        "description": "When the entry ends. An all-day entry ends at midnight UTC on its last day, and that day is part of the entry."
      },
      "status": {
        "type": "string",
        "default": "confirmed",
        "description": "How firm the entry is.",
        "knownValues": [
          "confirmed",
          "tentative",
          "cancelled"
        ]
      },
      "category": {
        "type": "string",
        "description": "The kind of entry. A reader that shows colours picks one from this.",
        "knownValues": [
          "work",
          "personal",
          "travel",
          "health",
          "social"
        ]
      },
      "location": {
        "type": "string",
        "maxLength": 2000,
        "description": "Where the entry takes place, as text."
      },
      "startsAt": {
        "type": "string",
        "format": "datetime",
        "description": "When the entry starts. An all-day entry starts at midnight UTC on its first day."
      },
      "timeZone": {
        "type": "string",
        "description": "The IANA time zone the entry was written in, such as America/New_York."
      },
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "When the entry was written."
      },
      "recurrence": {
        "type": "string",
        "maxLength": 1000,
        "description": "An RFC 5545 recurrence rule with no RRULE: prefix, such as FREQ=WEEKLY;BYDAY=TU. The entry repeats on the days the rule names."
      }
    }
  },
  "description": "An entry on a personal schedule. The record is written into a permissioned space, so only that space's members read it."
}

Lexicon Garden

@