matrix-spec/event-schemas/schema/m.room.message$m.notice
Travis Ralston d6d74c4cbe Switch to using $ instead of # for sub-types
# is reserved by the swagger validator as a way to include partial content from a JSON object (eg: "#/path" would include {"test": true} from the object {"path":{"test":true}}). Instead of trying to convince the validator that it is wrong, we'll just use a different character.

Note that our rendering tools do not care about #-style references to objects. It's still somewhat worth changing the character though.
2019-05-29 15:28:48 -06:00

25 lines
869 B
Plaintext

---
allOf:
- $ref: core-event-schema/room_event.yaml
description: 'The ``m.notice`` type is primarily intended for responses from automated clients. An ``m.notice`` message must be treated the same way as a regular ``m.text`` message with two exceptions. Firstly, clients should present ``m.notice`` messages to users in a distinct manner, and secondly, ``m.notice`` messages must never be automatically responded to. This helps to prevent infinite-loop situations where two automated clients continuously exchange messages.'
properties:
content:
properties:
body:
description: The notice text to send.
type: string
msgtype:
enum:
- m.notice
type: string
required:
- msgtype
- body
type: object
type:
enum:
- m.room.message
type: string
title: NoticeMessage
type: object