mirror of
https://github.com/matrix-org/dendrite.git
synced 2025-12-18 12:23:09 -06:00
Refine docs for QueryJoinedHostsInRoom
This commit is contained in:
parent
a20f581ab5
commit
4d400cbb6c
|
|
@ -33,9 +33,9 @@ type QueryJoinedHostServerNamesInRoomResponse struct {
|
||||||
|
|
||||||
// FederationSenderQueryAPI is used to query information from the federation sender.
|
// FederationSenderQueryAPI is used to query information from the federation sender.
|
||||||
type FederationSenderQueryAPI interface {
|
type FederationSenderQueryAPI interface {
|
||||||
// Query the joined hosts in a room.
|
// Query the joined hosts and the membership events accounting for their participation in a room.
|
||||||
// The membership events accounting for each server's participation are
|
// Note that if a server has multiple users in the room, it will have multiple entries in the returned slice.
|
||||||
// also contained in the response.
|
// See `QueryJoinedHostServerNamesInRoom` for a de-duplicated version.
|
||||||
QueryJoinedHostsInRoom(
|
QueryJoinedHostsInRoom(
|
||||||
ctx context.Context,
|
ctx context.Context,
|
||||||
request *QueryJoinedHostsInRoomRequest,
|
request *QueryJoinedHostsInRoomRequest,
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue