community.lexicon.calendar.event

main record

1 example

A calendar event.

Record Key tid Timestamp-based ID

Properties

createdAt string datetime Required

Client-declared timestamp when the event was created.

description string Optional

The description of the event.

endsAt string datetime Optional

Client-declared timestamp when the event ends.

locations array of union Optional

The locations where the event takes place.

Known types:

mode ref community.lexicon.calendar.event#mode Optional

The attendance mode of the event.

name string Required

The name of the event.

startsAt string datetime Optional

Client-declared timestamp when the event starts.

status ref community.lexicon.calendar.event#status Optional

The status of the event.

uris array of ref community.lexicon.calendar.event#uri Optional

URIs associated with the event.

View raw schema

{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "createdAt",
      "name"
    ],
    "properties": {
      "mode": {
        "ref": "community.lexicon.calendar.event#mode",
        "type": "ref",
        "description": "The attendance mode of the event."
      },
      "name": {
        "type": "string",
        "description": "The name of the event."
      },
      "uris": {
        "type": "array",
        "items": {
          "ref": "community.lexicon.calendar.event#uri",
          "type": "ref"
        },
        "description": "URIs associated with the event."
      },
      "endsAt": {
        "type": "string",
        "format": "datetime",
        "description": "Client-declared timestamp when the event ends."
      },
      "status": {
        "ref": "community.lexicon.calendar.event#status",
        "type": "ref",
        "description": "The status of the event."
      },
      "startsAt": {
        "type": "string",
        "format": "datetime",
        "description": "Client-declared timestamp when the event starts."
      },
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "Client-declared timestamp when the event was created."
      },
      "locations": {
        "type": "array",
        "items": {
          "refs": [
            "community.lexicon.calendar.event#uri",
            "community.lexicon.location.address",
            "community.lexicon.location.fsq",
            "community.lexicon.location.geo",
            "community.lexicon.location.hthree"
          ],
          "type": "union"
        },
        "description": "The locations where the event takes place."
      },
      "description": {
        "type": "string",
        "description": "The description of the event."
      }
    }
  },
  "description": "A calendar event."
}

cancelled token

The event has been cancelled.

Referencecommunity.lexicon.calendar.event#cancelled

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "The event has been cancelled."
}

hybrid token

A hybrid event that takes place both online and offline.

Referencecommunity.lexicon.calendar.event#hybrid

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "A hybrid event that takes place both online and offline."
}

inperson token

An in-person event that takes place offline.

Referencecommunity.lexicon.calendar.event#inperson

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "An in-person event that takes place offline."
}

mode string

The mode of the event.

Defaultcommunity.lexicon.calendar.event#inperson

Known Values (other values may be valid)

community.lexicon.calendar.event#hybrid(token) community.lexicon.calendar.event#inperson(token) community.lexicon.calendar.event#virtual(token)

View raw schema

{
  "type": "string",
  "default": "community.lexicon.calendar.event#inperson",
  "description": "The mode of the event.",
  "knownValues": [
    "community.lexicon.calendar.event#hybrid",
    "community.lexicon.calendar.event#inperson",
    "community.lexicon.calendar.event#virtual"
  ]
}

planned token

The event has been created, but not finalized.

Referencecommunity.lexicon.calendar.event#planned

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "The event has been created, but not finalized."
}

postponed token

The event has been postponed and a new start date has not been set.

Referencecommunity.lexicon.calendar.event#postponed

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "The event has been postponed and a new start date has not been set."
}

rescheduled token

The event has been rescheduled.

Referencecommunity.lexicon.calendar.event#rescheduled

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "The event has been rescheduled."
}

scheduled token

The event has been created and scheduled.

Referencecommunity.lexicon.calendar.event#scheduled

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "The event has been created and scheduled."
}

status string

The status of the event.

Defaultcommunity.lexicon.calendar.event#scheduled

Known Values (other values may be valid)

community.lexicon.calendar.event#cancelled(token) community.lexicon.calendar.event#planned(token) community.lexicon.calendar.event#postponed(token) community.lexicon.calendar.event#rescheduled(token) community.lexicon.calendar.event#scheduled(token)

View raw schema

{
  "type": "string",
  "default": "community.lexicon.calendar.event#scheduled",
  "description": "The status of the event.",
  "knownValues": [
    "community.lexicon.calendar.event#cancelled",
    "community.lexicon.calendar.event#planned",
    "community.lexicon.calendar.event#postponed",
    "community.lexicon.calendar.event#rescheduled",
    "community.lexicon.calendar.event#scheduled"
  ]
}

uri object

1 example

A URI associated with the event.

Properties

name string Optional

The display name of the URI.

uri string uri Required

A valid URI.

View raw schema

{
  "type": "object",
  "required": [
    "uri"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "uri"
    },
    "name": {
      "type": "string",
      "description": "The display name of the URI."
    }
  },
  "description": "A URI associated with the event."
}

virtual token

A virtual event that takes place online.

Referencecommunity.lexicon.calendar.event#virtual

Tokens have no data representation. Use the reference string as a value.

View raw schema

{
  "type": "token",
  "description": "A virtual event that takes place online."
}

community.lexicon.calendar.event

Documentation

Properties

Properties