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

Spec ignoring users #1142

Merged
merged 7 commits into from Mar 6, 2018

Conversation

Projects
None yet
2 participants
@turt2live
Member

turt2live commented Mar 3, 2018

Adds #528

turt2live added some commits Mar 3, 2018

Spec ignoring users
Adds #528

Signed-off-by: Travis Ralston <travpc@gmail.com>
Add ignoring users to the changelog
Signed-off-by: Travis Ralston <travpc@gmail.com>

@turt2live turt2live force-pushed the turt2live:travis/m.ignored_user_list branch from dbd8d31 to 1daf6af Mar 3, 2018

@richvdh

need to add the module to specification/targets.yaml!

A map of users which are considered ignored is kept in ``acount_data``
in an event type of ``m.ignored_user_list``.
properties:
content:

This comment has been minimized.

@richvdh

richvdh Mar 6, 2018

Member

I think we've lost a layer of objects here. Shouldn't there be an ignored_users property?

This comment has been minimized.

@turt2live
.. See the License for the specific language governing permissions and
.. limitations under the License.
Ignore Users

This comment has been minimized.

@richvdh

richvdh Mar 6, 2018

Member

"Ignoring users", possibly? "User ignore lists"?

should perform a fresh sync. The client may also un-hide any events it previously
hid due to the user becoming ignored.
Clients should be aware that split-brain

This comment has been minimized.

@richvdh

richvdh Mar 6, 2018

Member

this sentence seems to be split-brain

This comment has been minimized.

@turt2live

turt2live Mar 6, 2018

Member

My brain seemingly split while writing this... not sure where I was going with that.

Client behaviour
----------------
To ignore a user, effectively blocking them, the client should add the target
user to the ``m.ignored_user_list`` event in their account data. Once ignored,

This comment has been minimized.

@richvdh

richvdh Mar 6, 2018

Member

It would be useful to link to the right API for this, as the "Direct Messaging" module does.

Server behaviour
----------------
Following an update of the ``m.ignored_user_list``, the sync API for all clients
will immediately start ignoring (or un-ignoring) the user. Clients are responsible

This comment has been minimized.

@richvdh

richvdh Mar 6, 2018

Member

s/will/should/

@@ -19,6 +19,8 @@ Unreleased changes
(`#1106 <https://github.com/matrix-org/matrix-doc/pull/1106>`_).
- Clarify default values for some fields on the /search API
(`#1109 <https://github.com/matrix-org/matrix-doc/pull/1109>`_).
- Add spec for ignoring users

This comment has been minimized.

@richvdh

richvdh Mar 6, 2018

Member

Should be under "Changes to the API which will be backwards-compatible for clients".

turt2live added some commits Mar 6, 2018

Move the changelog entry for ignoring users
Signed-off-by: Travis Ralston <travpc@gmail.com>
Improve the documentation of ignored users
* Fix the event schema to represent the real world
* Add the module to the spec targets
* Remove incomplete thought from the client behaviour
* Link to the account data API
* Minor word choice changes

Signed-off-by: Travis Ralston <travpc@gmail.com>
title: "Ignored User"
description: "An empty object for future enhancement"
x-pattern: "$USER_ID"
required:

This comment has been minimized.

@richvdh

richvdh Mar 6, 2018

Member

should be under properties.content, not properties.content.properties

This comment has been minimized.

@turt2live

turt2live Mar 6, 2018

Member

that did it, thanks :D

Represent the ignored users event correctly
Signed-off-by: Travis Ralston <travpc@gmail.com>

@turt2live turt2live force-pushed the turt2live:travis/m.ignored_user_list branch from 5176f0e to 0835612 Mar 6, 2018

@richvdh

richvdh approved these changes Mar 6, 2018

@richvdh richvdh merged commit 624082d into matrix-org:master Mar 6, 2018

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

@turt2live turt2live deleted the turt2live:travis/m.ignored_user_list branch Mar 6, 2018

@turt2live turt2live referenced this pull request May 17, 2018

Closed

Ignoring Users #1197

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment