MirrorHub/synapse
0
0
Fork 1
mirror of https://mau.dev/maunium/synapse.git synced 2024-12-14 10:53:54 +01:00
Code Issues Projects Releases Wiki Activity

Docstring

Browse source
This commit is contained in:
David Baker 2016-04-29 19:47:35 +01:00
parent b0a1036d93
commit c7c75e87dc
1 changed files with 14 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
synapse/util/presentable_names.py
View file

@ -23,6 +23,20 @@ ALL_ALONE = "Empty Room"
def calculate_room_name(room_state, user_id, fallback_to_members=True): def calculate_room_name(room_state, user_id, fallback_to_members=True):
"""
Works out a user-facing name for the given room as per Matrix
spec recommendations.
Does not yet support internationalisation.
Args:
room_state: Dictionary of the room's state
user_id: The ID of the user to whom the room name is being presented
fallback_to_members: If False, return None instead of generating a name
based on the room's members if the room has no
title or aliases.
Returns:
(string or None) A human readable name for the room.
"""
# does it have a name? # does it have a name?
if ("m.room.name", "") in room_state: if ("m.room.name", "") in room_state:
m_room_name = room_state[("m.room.name", "")] m_room_name = room_state[("m.room.name", "")]