Mirrors
/
synapse
mirror of https://github.com/element-hq/synapse.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Docs and arg name clarification

This commit is contained in:
Andrew Morgan 2019-02-25 12:42:30 +00:00 committed by Erik Johnston
parent bd398b874e
commit 07493607a8
1 changed files with 15 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
synapse/handlers/room_list.py
View File

@ -302,9 +302,22 @@ class RoomListHandler(BaseHandler):
chunk.append(result) chunk.append(result)
@cachedInlineCallbacks(num_args=2, cache_context=True) @cachedInlineCallbacks(num_args=2, cache_context=True)
def generate_room_entry(self, room_id, allow_federated, num_joined_users, def generate_room_entry(self, room_id, allow_non_federated, num_joined_users,
cache_context, with_alias=True, allow_private=False): cache_context, with_alias=True, allow_private=False):
"""Returns the entry for a room """Returns the entry for a room
Args:
room_id (str): The room's ID.
allow_non_federated (bool): Whether rooms with federation
disabled should be shown.
num_joined_users (int): Number of users in the room.
cache_context: Information for cached responses.
with_alias (bool): Whether to return the room's aliases in the result.
allow_private (bool): Whether invite-only rooms should be shown.
Returns:
Deferred[dict|None]: Returns a room entry as a dictionary, or None if this
room was determined not to be shown publicly.
""" """
result = { result = {
"room_id": room_id, "room_id": room_id,
@ -342,7 +355,7 @@ class RoomListHandler(BaseHandler):
if not allow_private and join_rule and join_rule != JoinRules.PUBLIC: if not allow_private and join_rule and join_rule != JoinRules.PUBLIC:
defer.returnValue(None) defer.returnValue(None)
if not allow_federated: if not allow_non_federated:
# Disallow non-federated from appearing # Disallow non-federated from appearing
create_event = current_state.get((EventTypes.Create, "")) create_event = current_state.get((EventTypes.Create, ""))
if create_event: if create_event: