/
IMemberContainer.java
51 lines (48 loc) · 2.06 KB
/
IMemberContainer.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
/*
* Copyright 2015 Austin Keener, Michael Ritter, Florian Spieß, and the JDA contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.dv8tion.jda.api.entities;
import javax.annotation.Nonnull;
import java.util.List;
/**
* Represents a {@link GuildChannel} that is capable of containing members.
*
* Implementations interpret this meaning as best applies to them:
*
* For example,
* <ul>
* <li>{@link TextChannel TextChannels} implement this as the {@link Member members} that have {@link net.dv8tion.jda.api.Permission#VIEW_CHANNEL}</li>
* <li>{@link VoiceChannel VoiceChannels} implement this as what {@link Member members} are currently connected to the channel.</li>
* </ul>
*
*
* @see IMemberContainer#getMembers()
*/
public interface IMemberContainer extends GuildChannel
{
/**
* A List of all {@link net.dv8tion.jda.api.entities.Member Members} that are in this GuildChannel
* <br>For {@link net.dv8tion.jda.api.entities.TextChannel TextChannels},
* this returns all Members with the {@link net.dv8tion.jda.api.Permission#VIEW_CHANNEL Permission.VIEW_CHANNEL} Permission.
* <br>For {@link net.dv8tion.jda.api.entities.VoiceChannel VoiceChannels},
* this returns all Members that joined that VoiceChannel.
* <br>For {@link net.dv8tion.jda.api.entities.Category Categories},
* this returns all Members who are in its child channels.
*
* @return An immutable List of {@link net.dv8tion.jda.api.entities.Member Members} that are in this GuildChannel.
*/
@Nonnull
List<Member> getMembers();
}