docs: Update summary of SocketVoiceChannel.Users (#1714)

The inherited summary incorrectly stated that all users who _see_ the channel are returned when in reality only the ones _connected_ are.
This commit is contained in:
Joel Liechti
2020-12-14 04:42:04 +01:00
committed by GitHub
parent 9d7cb39faa
commit e385c40fc7

View File

@@ -34,7 +34,12 @@ namespace Discord.WebSocket
public Task SyncPermissionsAsync(RequestOptions options = null)
=> ChannelHelper.SyncPermissionsAsync(this, Discord, options);
/// <inheritdoc />
/// <summary>
/// Gets a collection of users that are currently connected to this voice channel.
/// </summary>
/// <returns>
/// A read-only collection of users that are currently connected to this voice channel.
/// </returns>
public override IReadOnlyCollection<SocketGuildUser> Users
=> Guild.Users.Where(x => x.VoiceChannel?.Id == Id).ToImmutableArray();