Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions matrix/room.py
Original file line number Diff line number Diff line change
Expand Up @@ -461,3 +461,22 @@ async def kick_user(self, user_id: str, reason: str | None = None) -> None:
)
except Exception as e:
raise MatrixError(f"Failed to kick user: {e}")

async def get_members(self) -> list[str]:
"""Fetch the list of user IDs currently joined to the room.
Comment thread
PenguinBoi12 marked this conversation as resolved.

This queries the Matrix server directly for the current membership,
which may include members not yet reflected in local room state.

## Example

```python
members = await room.get_members()
print(f"{len(members)} members: {', '.join(members)}")
```
"""
try:
response = await self.client.joined_members(self.room_id)
return [member.user_id for member in response.members]
except Exception as e:
raise MatrixError(f"Failed to get members: {e}")
28 changes: 28 additions & 0 deletions tests/test_room.py
Original file line number Diff line number Diff line change
Expand Up @@ -368,6 +368,34 @@ async def test_kick_user_with_error__expect_matrix_error(room, client):
await room.kick_user("@troublemaker:example.com")


# GET MEMBERS


@pytest.mark.asyncio
async def test_get_members__expect_list_of_user_ids(room, client):
member1 = Mock()
member1.user_id = "@alice:example.com"
member2 = Mock()
member2.user_id = "@bob:example.com"

response = Mock()
response.members = [member1, member2]
client.joined_members = AsyncMock(return_value=response)

result = await room.get_members()

client.joined_members.assert_awaited_once_with("!room:example.com")
assert result == ["@alice:example.com", "@bob:example.com"]


@pytest.mark.asyncio
async def test_get_members_with_error__expect_matrix_error(room, client):
client.joined_members = AsyncMock(side_effect=Exception("Network error"))

with pytest.raises(MatrixError, match="Failed to get members"):
await room.get_members()


def test_room_properties__expect_correct_delegation_to_matrix_room(room, matrix_room):
assert room.room_id == "!room:example.com"
assert room.name == "Test Room"
Expand Down
Loading