Add note about extra arg to send_membership_event, remove arg in remote_reject_invite (#6009)
Some small fixes to `room_member.py` found while doing other PRs. 1. Add requester to the base `_remote_reject_invite` method. 2. `send_membership_event`'s docstring was out of date and took in a `remote_room_hosts` arg that was not used and no calling function provided.pull/6020/head
parent
6604b64fae
commit
9c555f37e3
|
@ -0,0 +1 @@
|
||||||
|
Small refactor of function arguments and docstrings in RoomMemberHandler.
|
|
@ -100,7 +100,7 @@ class RoomMemberHandler(object):
|
||||||
raise NotImplementedError()
|
raise NotImplementedError()
|
||||||
|
|
||||||
@abc.abstractmethod
|
@abc.abstractmethod
|
||||||
def _remote_reject_invite(self, remote_room_hosts, room_id, target):
|
def _remote_reject_invite(self, requester, remote_room_hosts, room_id, target):
|
||||||
"""Attempt to reject an invite for a room this server is not in. If we
|
"""Attempt to reject an invite for a room this server is not in. If we
|
||||||
fail to do so we locally mark the invite as rejected.
|
fail to do so we locally mark the invite as rejected.
|
||||||
|
|
||||||
|
@ -510,9 +510,7 @@ class RoomMemberHandler(object):
|
||||||
return res
|
return res
|
||||||
|
|
||||||
@defer.inlineCallbacks
|
@defer.inlineCallbacks
|
||||||
def send_membership_event(
|
def send_membership_event(self, requester, event, context, ratelimit=True):
|
||||||
self, requester, event, context, remote_room_hosts=None, ratelimit=True
|
|
||||||
):
|
|
||||||
"""
|
"""
|
||||||
Change the membership status of a user in a room.
|
Change the membership status of a user in a room.
|
||||||
|
|
||||||
|
@ -522,16 +520,10 @@ class RoomMemberHandler(object):
|
||||||
act as the sender, will be skipped.
|
act as the sender, will be skipped.
|
||||||
event (SynapseEvent): The membership event.
|
event (SynapseEvent): The membership event.
|
||||||
context: The context of the event.
|
context: The context of the event.
|
||||||
is_guest (bool): Whether the sender is a guest.
|
|
||||||
room_hosts ([str]): Homeservers which are likely to already be in
|
|
||||||
the room, and could be danced with in order to join this
|
|
||||||
homeserver for the first time.
|
|
||||||
ratelimit (bool): Whether to rate limit this request.
|
ratelimit (bool): Whether to rate limit this request.
|
||||||
Raises:
|
Raises:
|
||||||
SynapseError if there was a problem changing the membership.
|
SynapseError if there was a problem changing the membership.
|
||||||
"""
|
"""
|
||||||
remote_room_hosts = remote_room_hosts or []
|
|
||||||
|
|
||||||
target_user = UserID.from_string(event.state_key)
|
target_user = UserID.from_string(event.state_key)
|
||||||
room_id = event.room_id
|
room_id = event.room_id
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue