Skip to content

NoteRecordedEvent

A referee annotation was recorded (referee — and it changes no state).

Full documentation: NoteRecordedEvent. Wire type: note_recorded.

Default visibility: referee

Message codes: session.note.recorded

JSON Schema

{
  "$defs": {
    "Visibility": {
      "description": "Who may see an event.\n\nThe wire values are `\"player\"` and `\"referee\"` \u2014 lowercase, serialized into every\nevent; changing them is a `schema_version` bump.",
      "enum": [
        "player",
        "referee"
      ],
      "title": "Visibility",
      "type": "string"
    }
  },
  "description": "A referee annotation was recorded (referee \u2014 and it changes no state).\n\nThe report of a machine-issued record \u2014 a dropped consequence, a cascade cut\nshort \u2014 or of a referee's own margin note.",
  "properties": {
    "code": {
      "default": "session.note.recorded",
      "title": "Code",
      "type": "string"
    },
    "visibility": {
      "$ref": "#/$defs/Visibility",
      "default": "referee"
    },
    "event_type": {
      "const": "note_recorded",
      "default": "note_recorded",
      "title": "Event Type",
      "type": "string"
    },
    "text": {
      "title": "Text",
      "type": "string"
    }
  },
  "required": [
    "text"
  ],
  "title": "NoteRecordedEvent",
  "type": "object"
}