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.

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

MSC3283: Expose capabilities for profile actions #3283

Merged
merged 17 commits into from
Nov 17, 2021
Merged
Changes from 7 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
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/3283-enable_set_displayname-capabilities.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# MSC3283: 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.
JonasKress marked this conversation as resolved.
Show resolved Hide resolved
JonasKress marked this conversation as resolved.
Show resolved Hide resolved

## Proposal

The `/_matrix/client/r0/capabilities` endpoint could be decorated to provide more information on capabilities.
JonasKress marked this conversation as resolved.
Show resolved Hide resolved
```javascript
JonasKress marked this conversation as resolved.
Show resolved Hide resolved
{
"capabilities": {
"m.set_displayname": { "enabled": false },
"m.room_versions": {...},
}
}
```
As part of this MSC, a capability will be added that exposes the server setting:
Copy link
Contributor

Choose a reason for hiding this comment

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

It's not actually clear from this MSC whether clients should check this when exposing controls to set the profile, or to set the displayname in a member event, or both?

I'd prefer something like m.set_profile_displayname if only because it describes the key better.

`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.
JonasKress marked this conversation as resolved.
Show resolved Hide resolved

## 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.