Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document how per-room profiles work #1367

Closed
wants to merge 2 commits into from
Closed

Document how per-room profiles work #1367

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
32ef663
Document how per-room profiles work
turt2live Jul 3, 2018
5a1aa76
Add to changelog
turt2live Jul 4, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions changelogs/client_server.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ Unreleased changes
(`#1245 <https:/matrix-org/matrix-doc/pull/1244>`_).
- Describe ``StateEvent`` for ``/createRoom``
(`#1329 <https:/matrix-org/matrix-doc/pull/1329>`_).
- Describe how per-room profiles work
(`#1367 <https:/matrix-org/matrix-doc/pull/1367>`_).

- Changes to the API which will be backwards-compatible for clients:

Expand Down
9 changes: 9 additions & 0 deletions specification/client_server_api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1372,6 +1372,15 @@ users, they should include the display name and avatar URL fields in these
events so that clients already have these details to hand, and do not have to
perform extra round trips to query it.

Per-room Profiles
+++++++++++++++++
Users may wish to have a different display name or avatar or both in a specific
room. To accomplish this, the client should modify the ``displayname`` and
``avatar_url`` properties of the user's ``m.room.member`` event in the room.

Clients SHOULD use the ``m.room.member`` event for users in a room when showing
profiles to the user.

Security
--------

Expand Down