Package net.dv8tion.jda.api.entities
Interface IInviteContainer
-
- All Superinterfaces:
Channel
,Comparable<GuildChannel>
,Formattable
,GuildChannel
,IMentionable
,ISnowflake
- All Known Subinterfaces:
BaseGuildMessageChannel
,NewsChannel
,StageChannel
,TextChannel
,VoiceChannel
public interface IInviteContainer extends GuildChannel
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description InviteAction
createInvite()
Creates a newInviteAction
which can be used to create a newInvite
.RestAction<List<Invite>>
retrieveInvites()
Returns all invites for this channel.-
Methods inherited from interface net.dv8tion.jda.api.entities.Channel
formatTo, getAsMention, getJDA, getName, getType
-
Methods inherited from interface java.lang.Comparable
compareTo
-
Methods inherited from interface net.dv8tion.jda.api.entities.GuildChannel
delete, getGuild, getManager, getPermissionContainer
-
Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake
getId, getIdLong, getTimeCreated
-
-
-
-
Method Detail
-
createInvite
@Nonnull @CheckReturnValue InviteAction createInvite()
Creates a newInviteAction
which can be used to create a newInvite
.
RequiresCREATE_INSTANT_INVITE
in this channel.- Returns:
- A new
InviteAction
- Throws:
InsufficientPermissionException
- If the account does not haveCREATE_INSTANT_INVITE
in this channelIllegalArgumentException
- If this is an instance of aCategory
- See Also:
InviteAction
-
retrieveInvites
@Nonnull @CheckReturnValue RestAction<List<Invite>> retrieveInvites()
Returns all invites for this channel.
RequiresMANAGE_CHANNEL
in this channel. Will throw anInsufficientPermissionException
otherwise.- Returns:
RestAction
- Type: List<Invite
>
The list of expanded Invite objects- Throws:
InsufficientPermissionException
- if the account does not haveMANAGE_CHANNEL
in this channel- See Also:
Guild.retrieveInvites()
-
-