Interface IInviteContainer
- All Superinterfaces:
Channel,Comparable<GuildChannel>,Formattable,GuildChannel,IDetachableEntity,IMentionable,ISnowflake
- All Known Subinterfaces:
AudioChannel,AudioChannelUnion,DefaultGuildChannelUnion,ForumChannel,MediaChannel,NewsChannel,StageChannel,StandardGuildChannel,StandardGuildMessageChannel,TextChannel,VoiceChannel
Represents a
GuildChannel that can be the target of a Guild's invite.
Invites have to be targeted at exactly one IInviteContainer, which will open when the invite is used (unless restricted by permissions).
-
Field Summary
Fields inherited from interface net.dv8tion.jda.api.entities.channel.Channel
MAX_NAME_LENGTHFields inherited from interface net.dv8tion.jda.api.entities.channel.middleman.GuildChannel
JUMP_URL -
Method Summary
Modifier and TypeMethodDescriptionCreates a newInviteActionwhich can be used to create a newInvite.Returns all invites for this channel.Methods inherited from interface net.dv8tion.jda.api.entities.channel.Channel
formatTo, getAsMention, getFlags, getJDA, getName, getTypeMethods inherited from interface java.lang.Comparable
compareToMethods inherited from interface net.dv8tion.jda.api.entities.channel.middleman.GuildChannel
delete, getGuild, getJumpUrl, getManager, getPermissionContainerMethods inherited from interface net.dv8tion.jda.api.entities.detached.IDetachableEntity
isDetachedMethods inherited from interface net.dv8tion.jda.api.entities.ISnowflake
getId, getIdLong, getTimeCreated
-
Method Details
-
createInvite
Creates a newInviteActionwhich can be used to create a newInvite.
RequiresCREATE_INSTANT_INVITEin this channel.- Returns:
- A new
InviteAction - Throws:
InsufficientPermissionException- If the account does not haveCREATE_INSTANT_INVITEin this channelIllegalArgumentException- If this is an instance of aCategoryDetachedEntityException- If this entity isdetached- See Also:
-
retrieveInvites
Returns all invites for this channel.
RequiresMANAGE_CHANNELin this channel. Will throw anInsufficientPermissionExceptionotherwise.- Returns:
RestAction- Type: List<Invite>
The list of expanded Invite objects- Throws:
InsufficientPermissionException- if the account does not haveMANAGE_CHANNELin this channelDetachedEntityException- If this entity isdetached- See Also:
-