Package net.dv8tion.jda.api.entities.channel.attribute

Interface IMemberContainer

All Superinterfaces:

Channel, Comparable<GuildChannel>, Formattable, GuildChannel, IDetachableEntity, IMentionable, ISnowflake

All Known Subinterfaces:

AudioChannel, AudioChannelUnion, Category, DefaultGuildChannelUnion, ForumChannel, MediaChannel, NewsChannel, StageChannel, StandardGuildChannel, StandardGuildMessageChannel, TextChannel, ThreadChannel, VoiceChannel

public interface IMemberContainer
extends GuildChannel

Represents a GuildChannel that is capable of containing members.

Implementations interpret this meaning as best applies to them:

For example,

• TextChannels implement this as the members that have Permission.VIEW_CHANNEL
• VoiceChannels implement this as what members are currently connected to the channel.

See Also:

• getMembers()

Field Summary

Fields inherited from interface net.dv8tion.jda.api.entities.channel.Channel

MAX_NAME_LENGTH

Fields inherited from interface net.dv8tion.jda.api.entities.channel.middleman.GuildChannel

JUMP_URL

Method Summary

Modifier and Type	Method	Description
@Unmodifiable List<Member>	getMembers()	A List of all Members that are in this GuildChannel For TextChannels, this returns all Members with the Permission.VIEW_CHANNEL Permission.

Methods inherited from interface net.dv8tion.jda.api.entities.channel.Channel

formatTo, getAsMention, getFlags, getJDA, getName, getType

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface net.dv8tion.jda.api.entities.channel.middleman.GuildChannel

delete, getGuild, getJumpUrl, getManager, getPermissionContainer

Methods inherited from interface net.dv8tion.jda.api.entities.detached.IDetachableEntity

isDetached

Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake

getId, getIdLong, getTimeCreated

Method Details

getMembers

@Nonnull
@Unmodifiable List<Member> getMembers()

A List of all Members that are in this GuildChannel
For TextChannels, this returns all Members with the Permission.VIEW_CHANNEL Permission.
For VoiceChannels, this returns all Members that joined that VoiceChannel.
For Categories, this returns all Members who are in its child channels.

Returns:

An immutable List of Members that are in this GuildChannel.

Throws:

DetachedEntityException - If this entity is detached