From 301595c071856538cc97c85266a81b68d02c7704 Mon Sep 17 00:00:00 2001 From: David Baker Date: Thu, 6 Oct 2016 11:15:44 +0100 Subject: [PATCH] Linkify account_data API Also change other links because it turns out the .. isn't part of the syntax --- changelogs/client_server.rst | 2 +- specification/client_server_api.rst | 3 +++ specification/modules/dm.rst | 7 +++---- 3 files changed, 7 insertions(+), 5 deletions(-) diff --git a/changelogs/client_server.rst b/changelogs/client_server.rst index 0386166b..273ac85c 100644 --- a/changelogs/client_server.rst +++ b/changelogs/client_server.rst @@ -37,7 +37,7 @@ - Add top-level ``account_data`` key to the responses to ``GET /sync`` and ``GET /initialSync`` (`#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. (`#389 `_). - Add ``contains_url`` option to ``RoomEventFilter``. diff --git a/specification/client_server_api.rst b/specification/client_server_api.rst index f12b495b..38dcd188 100644 --- a/specification/client_server_api.rst +++ b/specification/client_server_api.rst @@ -1281,3 +1281,6 @@ have to wait in milliseconds before they can try again. .. |/account/3pid| replace:: ``/account/3pid`` .. _/account/3pid: #post-matrix-client-%CLIENT_MAJOR_VERSION%-account-3pid + +.. |/user//account_data/| replace:: ``/user//account_data/`` +.. _/user//account_data/: #put-matrix-client-%CLIENT_MAJOR_VERSION%-user-userid-account-data-type diff --git a/specification/modules/dm.rst b/specification/modules/dm.rst index d148b945..26c5d85a 100644 --- a/specification/modules/dm.rst +++ b/specification/modules/dm.rst @@ -39,10 +39,9 @@ Client behaviour 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 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 -Config`_. +stores this event in account data using the |/user//account_data/|_ API. -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 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 @@ -50,6 +49,6 @@ person's profile picture would imply the ``is_direct`` flag should be set. 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 invited in the ``createRoom`` call.