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 11 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
46 changes: 46 additions & 0 deletions proposals/3283-enable_set_displayname-capabilities.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# MSC3283: Expose enable_set_displayname, enable_set_avatar_url and enable_3pid_changes in capabilities response

Some home servers like [Synapse](https://github.com/matrix-org/synapse/blob/756fd513dfaebddd28bf783eafa95b4505ce8745/docs/sample_config.yaml#L1207)
can be configured to enable_set_displayname: false, enable_set_avatar_url: false or enable_3pid_changes: false.
JonasKress marked this conversation as resolved.
Show resolved Hide resolved
To enable clients to handle that gracefully in the UI this setting should be exposed.

## Proposal

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

Whether users are allowed to change their displayname after it has been initially set.
Useful when provisioning users based on the contents of a third-party directory.

- `m.set_avatar_url`

Whether users are allowed to change their avatar after it has been initially set.
Useful when provisioning users based on the contents of a third-party directory.

- `m.3pid_changes`

Whether users can change the 3PIDs associated with their accounts
(email address and msisdn).
JonasKress marked this conversation as resolved.
Show resolved Hide resolved

## 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.set_displayname, m.set_avatar_url or m.3pid_changes
until the MSC has finished the Final Comment Period.

While the MSC is in review, implementations can use an unstable prefix
(e.g. im.vector.set_displayname) instead.
JonasKress marked this conversation as resolved.
Show resolved Hide resolved