Refine docs for QueryJoinedHostsInRoom

This commit is contained in:
Alex Chen 2019-08-20 16:31:38 +08:00 committed by GitHub
parent a20f581ab5
commit 4d400cbb6c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -33,9 +33,9 @@ type QueryJoinedHostServerNamesInRoomResponse struct {
// FederationSenderQueryAPI is used to query information from the federation sender.
type FederationSenderQueryAPI interface {
// Query the joined hosts in a room.
// The membership events accounting for each server's participation are
// also contained in the response.
// Query the joined hosts and the membership events accounting for their participation in a room.
// Note that if a server has multiple users in the room, it will have multiple entries in the returned slice.
// See `QueryJoinedHostServerNamesInRoom` for a de-duplicated version.
QueryJoinedHostsInRoom(
ctx context.Context,
request *QueryJoinedHostsInRoomRequest,