mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-03-21 19:04:10 +01:00
31 lines
849 B
Plaintext
31 lines
849 B
Plaintext
---
|
|
allOf:
|
|
- $ref: core-event-schema/state_event.yaml
|
|
description: |-
|
|
This event is used to inform the room about which alias should be
|
|
considered the canonical one. This could be for display purposes or as
|
|
suggestion to users which alias to use to advertise the room.
|
|
|
|
A room with an ``m.room.canonical_alias`` event with an empty or absent
|
|
``alias`` field should be treated the same as a room with no
|
|
``m.room.canonical_alias`` event.
|
|
properties:
|
|
content:
|
|
properties:
|
|
alias:
|
|
description: The canonical alias.
|
|
type: string
|
|
type: object
|
|
required:
|
|
- alias
|
|
state_key:
|
|
description: A zero-length string.
|
|
pattern: '^$'
|
|
type: string
|
|
type:
|
|
enum:
|
|
- m.room.canonical_alias
|
|
type: string
|
|
title: Informs the room as to which alias is the canonical one.
|
|
type: object
|