mirror of
https://github.com/matrix-org/matrix-spec
synced 2025-12-20 16:38:37 +01:00
6e16a19ac9
Some checks failed
Spec / 🔎 Validate OpenAPI specifications (push) Has been cancelled
Spec / 🔎 Check Event schema examples (push) Has been cancelled
Spec / 🔎 Check OpenAPI definitions examples (push) Has been cancelled
Spec / 🔎 Check JSON Schemas inline examples (push) Has been cancelled
Spec / ⚙️ Calculate baseURL for later jobs (push) Has been cancelled
Spec / 📢 Run towncrier for changelog (push) Has been cancelled
Spell Check / Spell Check with Typos (push) Has been cancelled
Spec / 🐍 Build OpenAPI definitions (push) Has been cancelled
Spec / 📖 Build the spec (push) Has been cancelled
Spec / 🔎 Validate generated HTML (push) Has been cancelled
Spec / 📖 Build the historical backup spec (push) Has been cancelled
79 lines
3.2 KiB
YAML
79 lines
3.2 KiB
YAML
---
|
|
$schema: https://json-schema.org/draft/2020-12/schema
|
|
|
|
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](/client-server-api/#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
|
|
deprecated: true
|
|
x-changedInMatrixVersion:
|
|
"1.16": |-
|
|
This field became deprecated and may not be present in all cases. It SHOULD still
|
|
be populated where possible/practical. Previously, it was required.
|
|
description: |-
|
|
The event ID of the last known event in the old room, if known.
|
|
|
|
If not set, clients SHOULD search for the `m.room.tombstone` state event to navigate to
|
|
when directing the user to the old room (potentially after joining the room, if requested
|
|
by the user).
|
|
required: [room_id]
|
|
additional_creators:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Additional user ID to consider a creator of the room, if supported by the room version.
|
|
x-addedInMatrixVersion: "1.16"
|
|
description: |-
|
|
Starting with room version 12, the other user IDs to consider as creators for the room in
|
|
addition to the `sender` of this event. Each string MUST be a valid [user ID](/appendices#user-identifiers)
|
|
for the room version.
|
|
|
|
When not present or empty, the `sender` of the event is the only creator.
|
|
|
|
In room versions 1 through 11, this field serves no purpose and is not validated. Clients
|
|
SHOULD NOT attempt to parse or understand this field in these room versions.
|
|
|
|
**Note**: Because `creator` was removed in room version 11, the field is not used to determine
|
|
which user(s) are room creators in room version 12 and beyond either.
|
|
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
|