net.dv8tion.jda.utils

Class InviteUtil

java.lang.Object

net.dv8tion.jda.utils.InviteUtil

public class InviteUtil
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InviteUtil.AdvancedInvite
static class	InviteUtil.Invite
static class	InviteUtil.InviteDuration

Constructor Summary

Constructors

Constructor and Description
InviteUtil()

Method Summary

Modifier and Type	Method and Description
static InviteUtil.AdvancedInvite	createInvite(Channel chan) Creates a standard-invite (valid for 24hrs, infinite usages, permanent access and not human-readable).
static InviteUtil.AdvancedInvite	createInvite(Channel chan, InviteUtil.InviteDuration duration, int maxUses, boolean temporary, boolean humanReadable) Creates an advanced invite.
static InviteUtil.AdvancedInvite	createInvite(Channel chan, JDA jda) Deprecated.
static void	delete(InviteUtil.Invite invite, JDA jda) Tells Discord to delete the specified Invite from the server.
static void	delete(java.lang.String code, JDA jda) Tells Discord to delete the specified Invite from the server.
static java.util.List<InviteUtil.AdvancedInvite>	getInvites(Channel channelObj) Provides a list of all Invites for the given Channel.
static java.util.List<InviteUtil.AdvancedInvite>	getInvites(Guild guildObj) Provides a list of all Invites for the given Guild.
static void	join(InviteUtil.Invite invite, JDA jda) Deprecated.
static void	join(InviteUtil.Invite invite, JDA jda, java.util.function.Consumer<Guild> callback) Uses joins the Guild specified by the provided Invite.
static void	join(java.lang.String code, JDA jda) Deprecated.
static void	join(java.lang.String code, JDA jda, java.util.function.Consumer<Guild> callback) Uses joins the Guild specified by the provided invite code/url.
static InviteUtil.Invite	resolve(java.lang.String code) Takes an invite url or invite code and changes it into an Invite.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InviteUtil

public InviteUtil()

Method Detail

resolve

public static InviteUtil.Invite resolve(java.lang.String code)

Takes an invite url or invite code and changes it into an Invite. If the url or code isn't a proper invite, this returns null

Parameters:

code - The invite url or code

Returns:

An Invite representing the invite specified by the provided code or url. This will return null if the provided code or url is invalid.

Throws:

java.lang.NullPointerException - If the provided String is null.

createInvite

@Deprecated
public static InviteUtil.AdvancedInvite createInvite(Channel chan,
                                                                  JDA jda)

Deprecated.

This method is deprecated, use createInvite(net.dv8tion.jda.entities.Channel) instead.

Creates a standard-invite (valid for 24hrs, infinite usages, permanent access and not human-readable). To create a customized Invite, use createInvite(Channel, InviteDuration, int, boolean, boolean) instead.

Parameters:

chan - The channel to create the invite for.

jda - The JDA-instance from who the invite should be created from.

Returns:

The created AdvancedInvite object.

Throws:

PermissionException - If the account connected to the provided JDA object does not have Permission.CREATE_INSTANT_INVITE for the provided channel.

createInvite

public static InviteUtil.AdvancedInvite createInvite(Channel chan)

Creates a standard-invite (valid for 24hrs, infinite usages, permanent access and not human-readable). To create a customized Invite, use createInvite(Channel, InviteDuration, int, boolean, boolean) instead.

Parameters:

chan - The channel to create the invite for.

Returns:

The created AdvancedInvite object.

Throws:

PermissionException - If the account connected to the provided JDA object does not have Permission.CREATE_INSTANT_INVITE for the provided channel.

createInvite

public static InviteUtil.AdvancedInvite createInvite(Channel chan,
                                                     InviteUtil.InviteDuration duration,
                                                     int maxUses,
                                                     boolean temporary,
                                                     boolean humanReadable)

Creates an advanced invite.

Parameters:

chan - The channel to create the invite for.

duration - The duration the invide should be valid for.

maxUses - The maximum amount of usages of this invite. 0 means infinite usages.

temporary - Whether or not the invite should only grant temporary access to the Guild (members will get removed after they log out, unless they get a role assigned).

humanReadable - Wheter or not the invite should be in human-readable form.

Returns:

The created AdvancedInvite object.

Throws:

PermissionException - If the account connected to the provided JDA object does not have Permission.CREATE_INSTANT_INVITE for the provided channel.

join

@Deprecated
public static void join(InviteUtil.Invite invite,
                                     JDA jda)

Deprecated.

join

public static void join(InviteUtil.Invite invite,
                        JDA jda,
                        java.util.function.Consumer<Guild> callback)

Uses joins the Guild specified by the provided Invite. Joining invites is always an async process, so you can provided a Consumer to define code to be run after the Guild is joined.
Example:

 InviteUtil.join(Invite, JDA, joinedGuild ->
 {
     System.out.println("I just joined a guild called: " + joinedGuild.getName();
 });
 

Note: If you do not wish to execute any code after joining, provide null for the consumer.

Parameters:

invite - The Invite which to join.

jda - The JDA instance which will join the Guild specified by the invie.

callback - The code which will be executed when the Guild has been successfully joined. This value can be null.

join

@Deprecated
public static void join(java.lang.String code,
                                     JDA jda)

Deprecated.

join

public static void join(java.lang.String code,
                        JDA jda,
                        java.util.function.Consumer<Guild> callback)

Uses joins the Guild specified by the provided invite code/url. Joining invites is always an async process, so you can provided a Consumer to define code to be run after the Guild is joined.
Example:

 InviteUtil.join(Invite, JDA, joinedGuild ->
 {
     System.out.println("I just joined a guild called: " + joinedGuild.getName();
 });
 

Note: If you do not wish to execute any code after joining, provide null for the consumer.

Parameters:

code - The code/url of the invite which to join.

jda - The JDA instance which will join the Guild specified by the invite.

callback - The code which will be executed when the Guild has been successfully joined. This value can be null.

delete

public static void delete(InviteUtil.Invite invite,
                          JDA jda)

Tells Discord to delete the specified Invite from the server. After deleting, this Invite will no longer work for anyone.

Parameters:

invite - The Invite to delete.

jda - The account to use to delete the provided invite.

Throws:

PermissionException - Thrown if the account connected to the provided JDA object does not have permission to delete the invite.

delete

public static void delete(java.lang.String code,
                          JDA jda)

Tells Discord to delete the specified Invite from the server. After deleting, this Invite will no longer work for anyone.

Parameters:

code - The invite code or url specifying the discord invite to delete.

jda - The account to use to delete the provided invite.

Throws:

PermissionException - Thrown if the account connected to the provided JDA object does not have permission to delete the invite.

java.lang.IllegalArgumentException - Thrown if the provided invite code/url was an invalid Invite.

getInvites

public static java.util.List<InviteUtil.AdvancedInvite> getInvites(Guild guildObj)

Provides a list of all Invites for the given Guild.

Parameters:

guildObj - The Guild whose invites are being retrieved.

Returns:

An Immutable List of Invites.

getInvites

public static java.util.List<InviteUtil.AdvancedInvite> getInvites(Channel channelObj)

Provides a list of all Invites for the given Channel.

Parameters:

channelObj - The Guild whose invites are being retrieved.

Returns:

An Immutable List of Invites.