4abea9a6ca
* Remove duplicate words. * Add information on room version 11. * Note some event changes. * Newsfragment * Fix-up event schema. * Apply suggestions from code review Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * Fix 'new in this version'. * Clarify creator field. * Fix-up event format & examples. * Move the Redactions section to the client section. * Reference the sender instead of the creator. * More links * Even more links. * Fix order of headers. * Fix typos. Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * Clarify description of creator. Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * Clean-up intro paragraphs for redactions. * Clean-up examples and language. * Review comments. * FIx-up markup tags. --------- Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
47 lines
1.7 KiB
YAML
47 lines
1.7 KiB
YAML
---
|
|
allOf:
|
|
- $ref: core-event-schema/state_event.yaml
|
|
description: This is the first event in a room and cannot be changed. It acts as the root of all other events.
|
|
properties:
|
|
content:
|
|
properties:
|
|
creator:
|
|
description: |-
|
|
The `user_id` of the room creator. **Required** for, and only present in, room versions 1 - 10. Starting with
|
|
room version 11 the event `sender` should be used instead.
|
|
type: string
|
|
m.federate:
|
|
description: Whether users on other servers can join this room. Defaults to `true` if key does not exist.
|
|
type: boolean
|
|
room_version:
|
|
description: The version of the room. Defaults to `"1"` if the key does not exist.
|
|
type: string
|
|
type:
|
|
description: |-
|
|
Optional [room type](#types) to denote a room's intended function outside of traditional conversation.
|
|
|
|
Unspecified room types are possible using [Namespaced Identifiers](/appendices/#common-namespaced-identifier-grammar).
|
|
type: string
|
|
predecessor:
|
|
description: A reference to the room this room replaces, if the previous room was upgraded.
|
|
type: object
|
|
title: Previous Room
|
|
properties:
|
|
room_id:
|
|
type: string
|
|
description: The ID of the old room.
|
|
event_id:
|
|
type: string
|
|
description: The event ID of the last known event in the old room.
|
|
required: [room_id, event_id]
|
|
type: object
|
|
state_key:
|
|
description: A zero-length string.
|
|
pattern: '^$'
|
|
type: string
|
|
type:
|
|
enum:
|
|
- m.room.create
|
|
type: string
|
|
title: The first event in the room.
|
|
type: object
|