matrix-spec-proposals/event-schemas/schema/m.room.canonical_alias

---
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
Convert event schemas to yaml We've decided to make the event schemas YAML, so we might as well take advantage of it. (This conversion was done mostly automatically, except for: - s/null/"null"/ in m.room.member - reformat description in m.room.power_levels 9 years ago			`---`
			`allOf:`
			`- $ref: core-event-schema/state_event.yaml`
Clarify the room-naming behaviour Make behaviour on empty `m.room.name` and `m.room.canonical_alias` events explicit. 8 years ago			`description: \|-`
			`This event is used to inform the room about which alias should be`
Add spec for new alias handling (client-server) 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). 5 years ago			`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.`
Convert event schemas to yaml We've decided to make the event schemas YAML, so we might as well take advantage of it. (This conversion was done mostly automatically, except for: - s/null/"null"/ in m.room.member - reformat description in m.room.power_levels 9 years ago			`properties:`
			`content:`
			`properties:`
			`alias:`
Add spec for new alias handling (client-server) 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). 5 years ago			`description: \|`
			`The canonical alias for the room. If not present, null, or empty the`
			`room should be considered to have no canonical alias.`
Convert event schemas to yaml We've decided to make the event schemas YAML, so we might as well take advantage of it. (This conversion was done mostly automatically, except for: - s/null/"null"/ in m.room.member - reformat description in m.room.power_levels 9 years ago			`type: string`
Add spec for new alias handling (client-server) 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). 5 years ago			`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`
Convert event schemas to yaml We've decided to make the event schemas YAML, so we might as well take advantage of it. (This conversion was done mostly automatically, except for: - s/null/"null"/ in m.room.member - reformat description in m.room.power_levels 9 years ago			`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`