Spec ignoring users #1142
Merged
Spec ignoring users #1142
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adds matrix-org#528 Signed-off-by: Travis Ralston <travpc@gmail.com>
Signed-off-by: Travis Ralston <travpc@gmail.com>
turt2live
force-pushed
the
travis/m.ignored_user_list
branch
from
dbd8d31
to
1daf6af
Compare
richvdh
requested changes
Mar 6, 2018
| A map of users which are considered ignored is kept in ``acount_data`` | ||
| in an event type of ``m.ignored_user_list``. | ||
| properties: | ||
| content: |
There was a problem hiding this comment.
I think we've lost a layer of objects here. Shouldn't there be an ignored_users property?
| .. See the License for the specific language governing permissions and | ||
| .. limitations under the License. | ||
|
|
||
| Ignore Users |
There was a problem hiding this comment.
"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 |
There was a problem hiding this comment.
this sentence seems to be split-brain
There was a problem hiding this comment.
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, |
There was a problem hiding this comment.
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 |
richvdh
reviewed
Mar 6, 2018
changelogs/client_server.rst
Outdated
| @@ -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 | |||
There was a problem hiding this comment.
Should be under "Changes to the API which will be backwards-compatible for clients".
Signed-off-by: Travis Ralston <travpc@gmail.com>
* 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>
richvdh
reviewed
Mar 6, 2018
| title: "Ignored User" | ||
| description: "An empty object for future enhancement" | ||
| x-pattern: "$USER_ID" | ||
| required: |
There was a problem hiding this comment.
should be under properties.content, not properties.content.properties
Signed-off-by: Travis Ralston <travpc@gmail.com>
turt2live
force-pushed
the
travis/m.ignored_user_list
branch
from
5176f0e
to
0835612
Compare
richvdh
approved these changes
Mar 6, 2018
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds #528