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

Interface IInviteContainer

All Superinterfaces:

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

All Known Subinterfaces:

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

public interface IInviteContainer
extends GuildChannel

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_LENGTH

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

JUMP_URL

Method Summary

Modifier and Type	Method	Description
InviteAction	createInvite()	Creates a new InviteAction which can be used to create a new Invite.
RestAction<List<Invite>>	retrieveInvites()	Returns all invites for this channel.

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.ISnowflake

getId, getIdLong, getTimeCreated

Method Details

createInvite

@Nonnull
@CheckReturnValue
InviteAction createInvite()

Creates a new InviteAction which can be used to create a new Invite.
Requires CREATE_INSTANT_INVITE in this channel.

Returns:

A new InviteAction

Throws:

InsufficientPermissionException - If the account does not have CREATE_INSTANT_INVITE in this channel

IllegalArgumentException - If this is an instance of a Category

See Also:

• InviteAction

retrieveInvites

@Nonnull
@CheckReturnValue
RestAction<List<Invite>> retrieveInvites()

Returns all invites for this channel.
Requires MANAGE_CHANNEL in this channel. Will throw an InsufficientPermissionException otherwise.

Returns:

RestAction - Type: List<Invite>
The list of expanded Invite objects

Throws:

InsufficientPermissionException - if the account does not have MANAGE_CHANNEL in this channel

See Also:

• Guild.retrieveInvites()