Package net.dv8tion.jda.internal.entities.channel.mixin.attribute

Interface IInviteContainerMixin<T extends IInviteContainerMixin<T>>

All Superinterfaces:

Channel, ChannelMixin<T>, ChannelUnion, Comparable<GuildChannel>, Formattable, GuildChannel, GuildChannelMixin<T>, GuildChannelUnion, IDetachableEntity, IDetachableEntityMixin, IInviteContainer, IMentionable, ISnowflake

All Known Subinterfaces:

AudioChannelMixin<T>, ForumChannelMixin<T>, MediaChannelMixin<T>, NewsChannelMixin<T>, StageChannelMixin<T>, StandardGuildChannelMixin<T>, StandardGuildMessageChannelMixin<T>, TextChannelMixin<T>, VoiceChannelMixin<T>

All Known Implementing Classes:

AbstractStandardGuildChannelImpl, AbstractStandardGuildMessageChannelImpl, DetachedForumChannelImpl, DetachedMediaChannelImpl, DetachedNewsChannelImpl, DetachedStageChannelImpl, DetachedTextChannelImpl, DetachedVoiceChannelImpl, ForumChannelImpl, MediaChannelImpl, NewsChannelImpl, StageChannelImpl, TextChannelImpl, VoiceChannelImpl

public interface IInviteContainerMixin<T extends IInviteContainerMixin<T>>
extends IInviteContainer, GuildChannelMixin<T>

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
default InviteAction	createInvite()	Creates a new InviteAction which can be used to create a new Invite.
default 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 net.dv8tion.jda.internal.entities.channel.mixin.ChannelMixin

setName

Methods inherited from interface net.dv8tion.jda.api.entities.channel.unions.ChannelUnion

asAudioChannel, asCategory, asForumChannel, asGroupChannel, asGuildChannel, asGuildMessageChannel, asMediaChannel, asMessageChannel, asNewsChannel, asPrivateChannel, asStageChannel, asStandardGuildChannel, asStandardGuildMessageChannel, asTextChannel, asThreadChannel, asThreadContainer, asVoiceChannel

Methods inherited from interface java.lang.Comparable

compareTo

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

getGuild, getJumpUrl, getManager, getPermissionContainer

Methods inherited from interface net.dv8tion.jda.internal.entities.channel.mixin.middleman.GuildChannelMixin

checkCanAccess, checkCanManage, checkPermission, checkPermission, delete, hasPermission

Methods inherited from interface net.dv8tion.jda.api.entities.channel.unions.GuildChannelUnion

asAudioChannel, asCategory, asForumChannel, asGuildMessageChannel, asMediaChannel, asNewsChannel, asStageChannel, asStandardGuildChannel, asStandardGuildMessageChannel, asTextChannel, asThreadChannel, asThreadContainer, asVoiceChannel

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

isDetached

Methods inherited from interface net.dv8tion.jda.internal.entities.detached.mixin.IDetachableEntityMixin

checkAttached, detachedException, detachedRequiresChannelException

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

getId, getIdLong, getTimeCreated

Method Details

createInvite

@Nonnull
default InviteAction createInvite()

Description copied from interface: IInviteContainer

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

Specified by:

createInvite in interface IInviteContainer

Returns:

A new InviteAction

See Also:

• InviteAction

retrieveInvites

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

Description copied from interface: IInviteContainer

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

Specified by:

retrieveInvites in interface IInviteContainer

Returns:

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

See Also:

• Guild.retrieveInvites()