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

Handling the reason field in kick and ban endpoints #798

Closed
mujx opened this issue Feb 5, 2017 · 3 comments
Closed

Handling the reason field in kick and ban endpoints #798

mujx opened this issue Feb 5, 2017 · 3 comments
Assignees
Labels
spec-omission implemented but not currently specified

Comments

@mujx
Copy link
Contributor

mujx commented Feb 5, 2017

Could you clarify the usage of this field? The spec doesn't seem to use it, unless I have missed something.

I guess that there should be a reason field on the m.room.member event.

@MilkManzJourDaddy
Copy link

MilkManzJourDaddy commented Feb 24, 2017

If you mean that which more or less directly translates to, in an IRC client, or Matrix client:

- /kick <IRC_nickname|Matrix_MXID> [<reason>]

- /ban <IRC_nickname|Matrix_MXID> [<reason>]

(At the time of this writing, I don't recall if issuing the above with 
a "Matrix_Display_Name" works in Matrix, 
but IRC_nickname is for use within IRC clients.)

Then it is probably assumed that those seasoned in IRC know the context and usage.

Conventionally, by the above example notations of the command, the parts enclosed with the square brackets "[" & "]" are optional. And you don't literally issue the characters "<", ">", "[", or "]".

Traditionally in IRC, and now Matrix, giving the kicked, or banned a reason is probably good practice. Those kicked or banned should understand why an IRC Op' (now Matrix Admin' PL100/Mod'/Custom PL), at their discretion, decided to do so. And, IRC often has had the ability to issue a ban of a fixed duration, through 'bots. So, users might be readmitted, automatically, after a time.

For such an example, with, more or less, a "services" bot, "X"; See:

/msg X ban <#channel> <nick!*@* | *!*userid@host> [duration] [leve] [reason]
https://cservice.undernet.org/docs/xcmds.txt
([sic] "[leve]" probably should be "[level}", which, as used, means the PL required to over-ride,
chosen by the issuer, up to their own PL.)

Regardless, the API i.e. kick & ban, they do show cURL context for the JSON, albiet POST is advised, over GET.

@mujx
Copy link
Contributor Author

mujx commented Feb 24, 2017

My question was what a homeserver should do with the reason field. How the user being kicked or banned should be notified by the server?

I guess that the reason should be present in an event (probably m.room.member so the user will be notified when his membership changes) but I couldn't find something relevant in the spec.

@richvdh
Copy link
Member

richvdh commented Feb 24, 2017

@mujx I think you're right.

@dbkr you were looking at this just recently IIRC: can you confirm?

@richvdh richvdh added clarification An area where the spec could do with being more explicit spec-omission implemented but not currently specified and removed clarification An area where the spec could do with being more explicit labels Oct 16, 2017
@turt2live turt2live self-assigned this Jul 3, 2018
turt2live added a commit to turt2live/matrix-doc that referenced this issue Jul 3, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
spec-omission implemented but not currently specified
Projects
None yet
Development

No branches or pull requests

4 participants