wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Linkify account_data API

Browse source 
Also change other links because it turns out the .. isn't part
of the syntax
This commit is contained in:
David Baker 2016-10-06 11:15:44 +01:00
parent e2736ba167
commit 301595c071
3 changed files with 7 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

2
changelogs/client_server.rst
View file

@ -37,7 +37,7 @@
- Add top-level ``account_data`` key to the responses to ``GET /sync`` and - Add top-level ``account_data`` key to the responses to ``GET /sync`` and
``GET /initialSync`` ``GET /initialSync``
(`#380 <https://github.com/matrix-org/matrix-doc/pull/380>`_). (`#380 <https://github.com/matrix-org/matrix-doc/pull/380>`_).
- Add ``is_direct`` flag to .. |/createRoom|_ and invite member event. - Add ``is_direct`` flag to |/createRoom|_ and invite member event.
Add 'Direct Messaging' module. Add 'Direct Messaging' module.
(`#389 <https://github.com/matrix-org/matrix-doc/pull/389>`_). (`#389 <https://github.com/matrix-org/matrix-doc/pull/389>`_).
- Add ``contains_url`` option to ``RoomEventFilter``. - Add ``contains_url`` option to ``RoomEventFilter``.

3
specification/client_server_api.rst
View file

@ -1281,3 +1281,6 @@ have to wait in milliseconds before they can try again.
.. |/account/3pid| replace:: ``/account/3pid`` .. |/account/3pid| replace:: ``/account/3pid``
.. _/account/3pid: #post-matrix-client-%CLIENT_MAJOR_VERSION%-account-3pid .. _/account/3pid: #post-matrix-client-%CLIENT_MAJOR_VERSION%-account-3pid
.. |/user/<user_id>/account_data/<type>| replace:: ``/user/<user_id>/account_data/<type>``
.. _/user/<user_id>/account_data/<type>: #put-matrix-client-%CLIENT_MAJOR_VERSION%-user-userid-account-data-type

7
specification/modules/dm.rst
View file

@ -39,10 +39,9 @@ Client behaviour
The invitee's client may use the ``is_direct`` flag in `m.room.member`_ to The invitee's client may use the ``is_direct`` flag in `m.room.member`_ to
automatically mark the room as a direct message but this is not required: it automatically mark the room as a direct message but this is not required: it
may for example, prompt the user, ignore the flag altogether. To do this, it may for example, prompt the user, ignore the flag altogether. To do this, it
stores this event in account data using the ``account_data`` API: see `Client stores this event in account data using the |/user/<user_id>/account_data/<type>|_ API.
Config`_.
The inviter's client should set the ``is_direct`` flag to .. |/createRoom|_ The inviter's client should set the ``is_direct`` flag to |/createRoom|_
whenever the flow the user has followed is one where their whenever the flow the user has followed is one where their
intention is to speak directly with another person, as opposed to bringing that intention is to speak directly with another person, as opposed to bringing that
person in to a shared room. For example, clicking on, 'Start Chat' beside a person in to a shared room. For example, clicking on, 'Start Chat' beside a
@ -50,6 +49,6 @@ person's profile picture would imply the ``is_direct`` flag should be set.
Server behaviour Server behaviour
---------------- ----------------
When the ``is_direct`` flag is given to .. |/createRoom|_, the home When the ``is_direct`` flag is given to |/createRoom|_, the home
server must set the ``is_direct`` flag in the invite member event for any users server must set the ``is_direct`` flag in the invite member event for any users
invited in the ``createRoom`` call. invited in the ``createRoom`` call.