mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-01-15 20:13:43 +01:00
b11cf560b5
MSC: https://github.com/matrix-org/matrix-doc/pull/2432 This commit does not deal with areas which will be covered by the room version specifications (namely the redaction algorithm). It feels a bit overly cruel to completely obliterate all mentions of `m.room.aliases` from the spec as client/server developers may encounter the event type in the wild. To ensure that CTRL+F still works, a brief mention that they do nothing has been put in place, leaving no other references (except the redaction algorithm - see previous paragraph).
35 lines
1.1 KiB
Plaintext
35 lines
1.1 KiB
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, and which other aliases point to the room.
|
|
This could be for display purposes or as suggestion to users which alias
|
|
to use to advertise and access the room.
|
|
properties:
|
|
content:
|
|
properties:
|
|
alias:
|
|
description: |
|
|
The canonical alias for the room. If not present, null, or empty the
|
|
room should be considered to have no canonical alias.
|
|
type: string
|
|
alt_aliases:
|
|
description: |
|
|
Alternative aliases the room advertises. This list can have aliases
|
|
despite the ``alias`` field being null, empty, or otherwise not present.
|
|
type: array
|
|
items:
|
|
type: string
|
|
type: object
|
|
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
|