Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-03-16 16:34:09 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Move m.direct description to the swagger

Browse source 
Also change the swagger to yaml so I can put that description in it
without having to figure out how to embed that in json.
This commit is contained in:
David Baker 2016-10-05 13:12:14 +01:00
parent b789251f70
commit 4480553bf9
2 changed files with 24 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
event-schemas/schema/m.direct
View file

@ -1,23 +1,21 @@
{ ---
"type": "object", allOf:
"title": "Direct Message Map Event", - $ref: core-event-schema/event.yaml
"description": "Account Data event used to store which rooms are 'direct chats' for which users.", description: |-
"allOf": [{ A map of which rooms are considered 'direct' rooms for specific users
"$ref": "core-event-schema/event.yaml" is kept in ``account_data`` in an event of type ``m.direct``. The
}], content of this event is an object where the keys are the user IDs
"properties": { and values are lists of room ID strings of the 'direct' rooms for
"type": { that user ID.
"type": "string", properties:
"enum": ["m.direct"] content:
}, additionalProperties:
"content": { type: array
"type": "object", title: User ID
"description": "Object mapping user IDs to lists of room IDs.", type: object
"additionalProperties": { type:
"title": "User ID", enum:
"type": "array" - m.direct
} type: string
} title: Direct Chat Mapping
}, type: object
"required": ["type", "content"]
}

12
specification/modules/dm.rst
View file

@ -32,21 +32,15 @@ whether a chat is 'direct' to an invitee.
Events Events
------ ------
A map of which rooms are considered 'direct' rooms for specific users {{m_direct_event}}
is kept in ``account_data`` in an event of type ``m.direct``. The
content of this event is an object where the keys are the user IDs
and values are lists of room ID strings of the 'direct' rooms for
that user ID.
Client behaviour
----------------
When creating a room, the ``is_direct`` flag may be specified to signal to the When creating a room, the ``is_direct`` flag may be specified to signal to the
invitee that this is a direct chat. See `POST invitee that this is a direct chat. See `POST
/_matrix/client/%CLIENT_MAJOR_VERSION%/createRoom`_. This flag appears as /_matrix/client/%CLIENT_MAJOR_VERSION%/createRoom`_. This flag appears as
``is_direct`` in the member event: see `m.room.member`_. ``is_direct`` in the member event: see `m.room.member`_.
{{m_direct_event}}
Client behaviour
----------------
The invitee's client may use the ``is_direct`` flag to automatically mark the The invitee's client may use the ``is_direct`` flag to automatically mark the
room as a direct message but this is not required: it may for example, prompt room as a direct message but this is not required: it may for example, prompt
the user, ignore the flag altogether. the user, ignore the flag altogether.