matrix-spec/data/event-schemas/schema/m.room.name.yaml

---
$schema: https://json-schema.org/draft/2020-12/schema

allOf:
  - $ref: core-event-schema/state_event.yaml
description: |-
    A room has an opaque [room ID](/appendices#room-ids) which is not
    human-friendly to read. A [room alias](appendices#room-aliases) is
    human-friendly, but not all rooms have [room aliases](/client-server-api/#room-aliases).
    The room name is a human-friendly string designed to be displayed to the
    end-user. The room name is not unique, as multiple rooms can have the same
    room name set.

    If a room has an `m.room.name` event with an absent, null, or empty `name`
    field, it should be treated the same as a room with no `m.room.name` event.

    An event of this type is automatically created when creating a room using
    [`/createRoom`](/client-server-api/#post_matrixclientv3createroom) with the
    `name` key.
properties:
  content:
    properties:
      name:
        description: The name of the room.
        type: string
    required:
      - name
    type: object
  state_key:
    description: A zero-length string.
    pattern: '^$'
    type: string
  type:
    enum:
      - m.room.name
    type: string
title: RoomName
type: object