Package net.dv8tion.jda.internal.entities

Class InviteImpl

java.lang.Object

net.dv8tion.jda.internal.entities.InviteImpl

All Implemented Interfaces:

Invite

public class InviteImpl
extends Object
implements Invite

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InviteImpl.ChannelImpl
static class	InviteImpl.EmbeddedApplicationImpl
static class	InviteImpl.GroupImpl
static class	InviteImpl.GuildImpl
static class	InviteImpl.InviteTargetImpl

Nested classes/interfaces inherited from interface net.dv8tion.jda.api.entities.Invite

Invite.Channel, Invite.EmbeddedApplication, Invite.Group, Invite.Guild, Invite.InviteTarget, Invite.InviteType, Invite.TargetType

Constructor Summary

Constructors

Constructor	Description
InviteImpl(JDAImpl api, String code, boolean expanded, User inviter, int maxAge, int maxUses, boolean temporary, OffsetDateTime timeCreated, int uses, Invite.Channel channel, Invite.Guild guild, Invite.Group group, Invite.InviteTarget target, Invite.InviteType type)

Method Summary

Modifier and Type	Method	Description
AuditableRestAction<Void>	delete()	Deletes this invite.
boolean	equals(Object obj)
RestAction<Invite>	expand()	Tries to retrieve a new expanded Invite with more info.
Invite.Channel	getChannel()	An Invite.Channel object containing information about this invite's origin channel.
String	getCode()	The invite code
Invite.Group	getGroup()	An Invite.Group object containing information about this invite's origin group.
Invite.Guild	getGuild()	An Invite.Guild object containing information about this invite's origin guild.
User	getInviter()	The user who created this invite.
JDAImpl	getJDA()	The JDA instance used to create this Invite
int	getMaxAge()	The max age of this invite in seconds.
int	getMaxUses()	The max uses of this invite.
Invite.InviteTarget	getTarget()	An Invite.InviteTarget object containing information about this invite's target or null if this invite does not have a target.
Invite.TargetType	getTargetType()	The target type of this invite or Invite.TargetType.NONE if this invite does not have a InviteTarget.
OffsetDateTime	getTimeCreated()	Returns creation date of this invite.
Invite.InviteType	getType()	The type of this invite.
int	getUses()	How often this invite has been used.
int	hashCode()
boolean	isExpanded()	Whether this Invite is expanded or not.
boolean	isTemporary()	Whether this Invite grants only temporary access or not.
static RestAction<Invite>	resolve(JDA api, String code, boolean withCounts)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

getUrl

Constructor Details

InviteImpl

public InviteImpl(JDAImpl api,
 String code,
 boolean expanded,
 User inviter,
 int maxAge,
 int maxUses,
 boolean temporary,
 OffsetDateTime timeCreated,
 int uses,
 Invite.Channel channel,
 Invite.Guild guild,
 Invite.Group group,
 Invite.InviteTarget target,
 Invite.InviteType type)

Method Details

resolve

public static RestAction<Invite> resolve(JDA api,
 String code,
 boolean withCounts)

delete

@Nonnull
public AuditableRestAction<Void> delete()

Description copied from interface: Invite

Deletes this invite.
Requires MANAGE_CHANNEL in the invite's channel. Will throw an InsufficientPermissionException otherwise.

Specified by:

delete in interface Invite

Returns:

AuditableRestAction

expand

@Nonnull
public RestAction<Invite> expand()

Description copied from interface: Invite

Tries to retrieve a new expanded Invite with more info.
As bots can't be in groups this is only available for guild invites and will throw an IllegalStateException for other types.
Requires either MANAGE_SERVER in the invite's guild or MANAGE_CHANNEL in the invite's channel. Will throw an InsufficientPermissionException otherwise.

Specified by:

expand in interface Invite

Returns:

RestAction - Type: Invite
The expanded Invite object

See Also:

• Invite.getType()
• Invite.isExpanded()

getType

@Nonnull
public Invite.InviteType getType()

Description copied from interface: Invite

The type of this invite.

Specified by:

getType in interface Invite

Returns:

The invite's type

getTargetType

@Nonnull
public Invite.TargetType getTargetType()

Description copied from interface: Invite

The target type of this invite or Invite.TargetType.NONE if this invite does not have a InviteTarget.

Specified by:

getTargetType in interface Invite

Returns:

The invite's target type or Invite.TargetType.NONE

See Also:

• Invite.TargetType

getChannel

public Invite.Channel getChannel()

Description copied from interface: Invite

An Invite.Channel object containing information about this invite's origin channel.

Specified by:

getChannel in interface Invite

Returns:

Information about this invite's origin channel or null in case of a group invite

See Also:

• Invite.Channel

getCode

@Nonnull
public String getCode()

Description copied from interface: Invite

The invite code

Specified by:

getCode in interface Invite

Returns:

the invite code

getGuild

public Invite.Guild getGuild()

Description copied from interface: Invite

An Invite.Guild object containing information about this invite's origin guild.

Specified by:

getGuild in interface Invite

Returns:

Information about this invite's origin guild or null in case of a group invite

See Also:

• Invite.Guild

getGroup

public Invite.Group getGroup()

Description copied from interface: Invite

An Invite.Group object containing information about this invite's origin group.

Specified by:

getGroup in interface Invite

Returns:

Information about this invite's origin group or null in case of a guild invite

See Also:

• Invite.Group

getTarget

@Nullable
public Invite.InviteTarget getTarget()

Description copied from interface: Invite

An Invite.InviteTarget object containing information about this invite's target or null if this invite does not have a target.

Specified by:

getTarget in interface Invite

Returns:

Information about this invite's target or null

See Also:

• Invite.InviteTarget

getInviter

public User getInviter()

Description copied from interface: Invite

The user who created this invite. For not expanded invites this may be null.

Specified by:

getInviter in interface Invite

Returns:

The user who created this invite

getJDA

@Nonnull
public JDAImpl getJDA()

Description copied from interface: Invite

The JDA instance used to create this Invite

Specified by:

getJDA in interface Invite

Returns:

the corresponding JDA instance

getMaxAge

public int getMaxAge()

Description copied from interface: Invite

The max age of this invite in seconds.

This works only for expanded invites and will throw a IllegalStateException otherwise!

Specified by:

getMaxAge in interface Invite

Returns:

The max age of this invite in seconds

See Also:

• Invite.expand()
• Invite.isExpanded()

getMaxUses

public int getMaxUses()

Description copied from interface: Invite

The max uses of this invite. If there is no limit thus will return 0.

This works only for expanded invites and will throw a IllegalStateException otherwise!

Specified by:

getMaxUses in interface Invite

Returns:

The max uses of this invite or 0 if there is no limit

See Also:

• Invite.expand()
• Invite.isExpanded()

getTimeCreated

@Nonnull
public OffsetDateTime getTimeCreated()

Description copied from interface: Invite

Returns creation date of this invite.

This works only for expanded invites and will throw a IllegalStateException otherwise!

Specified by:

getTimeCreated in interface Invite

Returns:

The creation date of this invite

See Also:

• Invite.expand()
• Invite.isExpanded()

getUses

public int getUses()

Description copied from interface: Invite

How often this invite has been used.

This works only for expanded invites and will throw a IllegalStateException otherwise!

Specified by:

getUses in interface Invite

Returns:

The uses of this invite

See Also:

• Invite.expand()
• Invite.isExpanded()

isExpanded

public boolean isExpanded()

Description copied from interface: Invite

Whether this Invite is expanded or not. Expanded invites contain more information, but they can only be obtained by Guild#retrieveInvites() (requires Permission.MANAGE_SERVER) or IInviteContainer#retrieveInvites() (requires Permission.MANAGE_CHANNEL).

There is a convenience method Invite.expand() to get the expanded invite for an unexpanded one.

Specified by:

isExpanded in interface Invite

Returns:

Whether this invite is expanded or not

See Also:

• Invite.expand()

isTemporary

public boolean isTemporary()

Description copied from interface: Invite

Whether this Invite grants only temporary access or not.

This works only for expanded invites and will throw a IllegalStateException otherwise!

Specified by:

isTemporary in interface Invite

Returns:

Whether this invite is temporary or not

See Also:

• Invite.expand()
• Invite.isExpanded()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object