Skip to content

MSC3282: Expose enable_set_displayname in capabilities response #3282

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

Closed
wants to merge 5 commits into from
Closed

MSC3282: Expose enable_set_displayname in capabilities response #3282

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e04ae30
Create 3278-enable_set_displayname-capabilities.md
JonasKress Jul 13, 2021
0fd7c94
Apply suggestions from code review
JonasKress Jul 13, 2021
c711706
Apply suggestions from code review
JonasKress Jul 13, 2021
7291992
Update and rename 3278-enable_set_displayname-capabilities.md to 3279…
JonasKress Jul 13, 2021
9c8fec0
Update and rename 3279-enable_set_displayname-capabilities.md to 3282…
JonasKress Jul 13, 2021
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
25 changes: 25 additions & 0 deletions proposals/3282-enable_set_displayname-capabilities.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# MSC3282: Expose enable_set_displayname in capabilities response


Some home servers like synapse can be configured to enable_set_displayname: false. To enable clients to handle that gracefully in the UI this setting should be exposed.

## Proposal

The `/_matrix/client/r0/capabilities` endpoint could be decorated to provide more information on capabilities.
```javascript
{
"capabilities": {
"m.enable_set_displayname": false,
Copy link

@bmarty bmarty Jul 19, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here, I think that can_set_displayname is a better name from a client point of view.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR is not up to date. The current PR is: #3283

"m.room_versions": {...},
}
}
```
As part of this MSC, a capability will be added that exposes the server setting:
`m.enable_set_displayname`

## Client recommendations
When presenting profile settings, clients should use capabilities in order to display the correct UI.
If capability is not present the default is true.

## Unstable prefix
Implementations won't actually be able to use m.enable_set_displayname until the MSC has finished the Final Comment Period. While the MSC is in review, implementations can use an unstable prefix (im.vector.enable_set_displayname) instead.