JDA (JDA 1.2.2

All Known Implementing Classes:

JDAImpl
```
public interface JDA
```
Represents the core of the Discord API. All functionality is connected through this.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addEventListener(java.lang.Object listener)` Adds an Object to the event-listeners that will be used to handle events.
`GuildManager`	`createGuild(java.lang.String name)` Deprecated.
`GuildManager`	`createGuild(java.lang.String name, Region region)` Creates a new `Guild`.
`void`	`createGuildAsync(java.lang.String name, java.util.function.Consumer<GuildManager> callback)` Deprecated.
`void`	`createGuildAsync(java.lang.String name, Region region, java.util.function.Consumer<GuildManager> callback)` Creates a new `Guild`.
`AccountManager`	`getAccountManager()` Returns the `AccountManager` for the currently logged in account. Account settings can only be modified using this object.
`AudioManager`	`getAudioManager()` Returns the `AudioManager` for this `JDA` instance.
`java.lang.String`	`getAuthToken()` The login token that is currently being used for Discord authentication.
`org.apache.http.HttpHost`	`getGlobalProxy()` The proxy settings used by all JDA instances.
`Guild`	`getGuildById(java.lang.String id)` This returns the `Guild` which has the same id as the one provided. If there is no known guild with an id that matches the provided one, then this returns `null`.
`java.util.List<Guild>`	`getGuilds()` An unmodifiable list of all `Guilds` that this account is connected to. If this account is not connected to any `Guilds`, this will return an empty list.
`java.util.List<Guild>`	`getGuildsByName(java.lang.String name)` An unmodifiable list of all `Guilds` that have the same name as the one provided. If there are no `Guilds` with the provided name, then this returns an empty list.
`PrivateChannel`	`getPrivateChannelById(java.lang.String id)` This returns the `PrivateChannel` which has the same id as the one provided. If there is no known `PrivateChannel` with an id that matches the provided one, then this returns `null`.
`java.util.List<PrivateChannel>`	`getPrivateChannels()` An unmodifiable list of all known `PrivateChannels`.
`int`	`getResponseTotal()` This value is the total amount of JSON responses that discord has sent. This value resets every time the websocket has to reconnect.
`SelfInfo`	`getSelfInfo()` Returns the currently logged in account represented by `SelfInfo`. Account settings cannot be modified using this object.
`TextChannel`	`getTextChannelById(java.lang.String id)` This returns the `TextChannel` which has the same id as the one provided. If there is no known `TextChannel` with an id that matches the provided one, then this returns `null`.
`java.util.List<TextChannel>`	`getTextChannels()` An unmodifiable list of all `TextChannels` of all `Guilds` that this account is a member of.
`java.util.List<TextChannel>`	`getTextChannelsByName(java.lang.String name)` An unmodifiable list of all `TextChannels` that have the same name as the one provided. If there are no `TextChannels` with the provided name, then this returns an empty list.
`User`	`getUserById(java.lang.String id)` This returns the `User` who has the same id as the one provided. If there is no known user with an id that matches the provided one, this this returns `null`.
`java.util.List<User>`	`getUsers()` An unmodifiable list of all known `Users`. This list will never contain duplicates and represents all `Users` that JDA can currently see.
`java.util.List<User>`	`getUsersByName(java.lang.String name)` This unmodifiable returns all `Users` that have the same username as the one provided. If there are no `Users` with the provided name, then this returns an empty list.
`VoiceChannel`	`getVoiceChannelById(java.lang.String id)` This returns the `VoiceChannel` which has the same id as the one provided. If there is no known `VoiceChannel` with an id that matches the provided one, then this returns `null`.
`java.util.List<VoiceChannel>`	`getVoiceChannelByName(java.lang.String name)` An unmodifiable list of all `VoiceChannels` that have the same name as the one provided. If there are no `VoiceChannels` with the provided name, then this returns an empty list.
`java.util.List<VoiceChannel>`	`getVoiceChannels()` An unmodifiable list of all `VoiceChannels` of all `Guilds` that this account is a member of.
`boolean`	`isDebug()` Used to determine if JDA is currently in debug mode.
`void`	`removeEventListener(java.lang.Object listener)` Removes the provided Object from the event-listeners and no longer uses it to handle events.
`void`	`setDebug(boolean enableDebug)` Used to enable JDA debug output.
`void`	`setEventManager(IEventManager manager)` Changes the internal EventManager.
`void`	`shutdown()` Shuts down JDA, closing all its connections.
`void`	`shutdown(boolean free)` Shuts down JDA, closing all its connections.

- Method Detail
  - setEventManager
```
void setEventManager(IEventManager manager)
```
    Changes the internal EventManager. The default EventManager is InterfacedEventListener. There is also an AnnotatedEventManager available.
    
    Parameters:
    
    manager - The new EventManager to use
  - addEventListener
```
void addEventListener(java.lang.Object listener)
```
    Adds an Object to the event-listeners that will be used to handle events. This uses the InterfacedEventListener by default. To switch to the AnnotatedEventManager, use setEventManager(IEventManager). Note: when using the InterfacedEventListener (default), given listener must be instance of EventListener!
    
    Parameters:
    
    listener - The listener
  - removeEventListener
```
void removeEventListener(java.lang.Object listener)
```
    Removes the provided Object from the event-listeners and no longer uses it to handle events.
    
    Parameters:
    
    listener - The listener to be removed.
  - createGuild
```
@Deprecated
GuildManager createGuild(java.lang.String name)
```
    Deprecated.
    
    This method is deprecated! please switch to createGuild(String, Region). Creates a new Guild. This will a return the Manager to the existing, but still empty Guild (no members, no channels). To create a Guild asynchronously (wait for generation of #general chat), use createGuildAsync(String, Consumer) instead. In the very rare case, that the Discord-server has problems, The created guild can be unavailable until it is actually created. In that case, this will return null.
    
    Parameters:
    
    name - the name of the new Guild
    
    Returns:
    
    the GuildManager for the created Guild, or null, if the created Guild is temporarily unavailable
  - createGuild
```
GuildManager createGuild(java.lang.String name,
                         Region region)
```
    Creates a new Guild. This will a return the Manager to the existing, but still empty Guild (no members, no channels). To create a Guild asynchronously (wait for generation of #general chat), use createGuildAsync(String, Consumer) instead. In the very rare case, that the Discord-server has problems, The created guild can be unavailable until it is actually created. In that case, this will return null.
    
    Parameters:
    
    name - the name of the new Guild
    
    region - the region of the new Guild
    
    Returns:
    
    the GuildManager for the created Guild, or null, if the created Guild is temporarily unavailable
  - createGuildAsync
```
@Deprecated
void createGuildAsync(java.lang.String name,
                                   java.util.function.Consumer<GuildManager> callback)
```
    Deprecated.
    
    This method is deprecated! please switch to createGuildAsync(String, Region, Consumer). Creates a new Guild. This function will wait until the Guild was fully created by the Discord-Server (default channels,...), and then call the provided callback-function with the GuildManager-object To create a Guild synchronously, use createGuild(String) instead
    
    Parameters:
    
    name - the name of the new Guild
    
    callback - the callback-function that gets called once the guild was fully initialized
  - createGuildAsync
```
void createGuildAsync(java.lang.String name,
                      Region region,
                      java.util.function.Consumer<GuildManager> callback)
```
    Creates a new Guild. This function will wait until the Guild was fully created by the Discord-Server (default channels,...), and then call the provided callback-function with the GuildManager-object To create a Guild synchronously, use createGuild(String) instead
    
    Parameters:
    
    name - the name of the new Guild
    
    region - the region of the new Guild
    
    callback - the callback-function that gets called once the guild was fully initialized
  - getAuthToken
```
java.lang.String getAuthToken()
```
    The login token that is currently being used for Discord authentication.
    
    Returns:
    
    Never-null, 18 character length string containing the auth token.
  - getUsers
```
java.util.List<User> getUsers()
```
    An unmodifiable list of all known Users.
    This list will never contain duplicates and represents all Users that JDA can currently see.
    
    Returns:
    
    List of all known Users.
  - getUserById
```
User getUserById(java.lang.String id)
```
    This returns the User who has the same id as the one provided.
    If there is no known user with an id that matches the provided one, this this returns null.
    
    Parameters:
    
    id - The id of the User.
    
    Returns:
    
    Possibly-null User with matching id.
  - getUsersByName
```
java.util.List<User> getUsersByName(java.lang.String name)
```
    This unmodifiable returns all Users that have the same username as the one provided.
    If there are no Users with the provided name, then this returns an empty list.
    
    Parameters:
    
    name - The name of the requested Users.
    
    Returns:
    
    Possibly-empty list of Users that all have the same name as the provided name.
  - getGuilds
```
java.util.List<Guild> getGuilds()
```
    An unmodifiable list of all Guilds that this account is connected to.
    If this account is not connected to any Guilds, this will return an empty list.
    
    Returns:
    
    Possibly-empty list of all the Guilds that this account is connected to.
  - getGuildById
```
Guild getGuildById(java.lang.String id)
```
    This returns the Guild which has the same id as the one provided.
    If there is no known guild with an id that matches the provided one, then this returns null.
    
    Parameters:
    
    id - The id of the Guild.
    
    Returns:
    
    Possibly-null Guild with matching id.
  - getGuildsByName
```
java.util.List<Guild> getGuildsByName(java.lang.String name)
```
    An unmodifiable list of all Guilds that have the same name as the one provided.
    If there are no Guilds with the provided name, then this returns an empty list.
    
    Parameters:
    
    name - The name of the requested Guilds.
    
    Returns:
    
    Possibly-empty list of all the Guilds that all have the same name as the provided name.
  - getTextChannels
```
java.util.List<TextChannel> getTextChannels()
```
    An unmodifiable list of all TextChannels of all Guilds that this account is a member of.
    Note: just because a TextChannel is present in this list does not mean that you will be able to send messages to it. Furthermore, if you log into this account on the discord client, it is possible that you will see fewer channels than this returns. This is because the discord client hides any TextChannel that you don't have the Permission.MESSAGE_READ permission in.
    
    Returns:
    
    Possibly-empty list of all known TextChannels.
  - getTextChannelById
```
TextChannel getTextChannelById(java.lang.String id)
```
    This returns the TextChannel which has the same id as the one provided.
    If there is no known TextChannel with an id that matches the provided one, then this returns null.
    Note: just because a TextChannel is present does not mean that you will be able to send messages to it. Furthermore, if you log into this account on the discord client, it is you will not see the channel that this returns. This is because the discord client hides any TextChannel that you don't have the Permission.MESSAGE_READ permission in.
    
    Parameters:
    
    id - The id of the TextChannel.
    
    Returns:
    
    Possibly-null TextChannel with matching id.
  - getTextChannelsByName
```
java.util.List<TextChannel> getTextChannelsByName(java.lang.String name)
```
    An unmodifiable list of all TextChannels that have the same name as the one provided.
    If there are no TextChannels with the provided name, then this returns an empty list.
    Note: just because a TextChannel is present in this list does not mean that you will be able to send messages to it. Furthermore, if you log into this account on the discord client, it is possible that you will see fewer channels than this returns. This is because the discord client hides any TextChannel that you don't have the Permission.MESSAGE_READ permission in.
    
    Parameters:
    
    name - The name of the requested TextChannels.
    
    Returns:
    
    Possibly-empty list of all the TextChannels that all have the same name as the provided name.
  - getVoiceChannels
```
java.util.List<VoiceChannel> getVoiceChannels()
```
    An unmodifiable list of all VoiceChannels of all Guilds that this account is a member of.
    
    Returns:
    
    Possible-empty list of all known VoiceChannels.
  - getVoiceChannelById
```
VoiceChannel getVoiceChannelById(java.lang.String id)
```
    This returns the VoiceChannel which has the same id as the one provided.
    If there is no known VoiceChannel with an id that matches the provided one, then this returns null.
    
    Parameters:
    
    id - The id of the VoiceChannel.
    
    Returns:
    
    Possibly-null VoiceChannel with matching id.
  - getVoiceChannelByName
```
java.util.List<VoiceChannel> getVoiceChannelByName(java.lang.String name)
```
    An unmodifiable list of all VoiceChannels that have the same name as the one provided.
    If there are no VoiceChannels with the provided name, then this returns an empty list.
    
    Parameters:
    
    name - The name of the requested VoiceChannels.
    
    Returns:
    
    Possibly-empty list of all the VoiceChannels that all have the same name as the provided name.
  - getPrivateChannels
```
java.util.List<PrivateChannel> getPrivateChannels()
```
    An unmodifiable list of all known PrivateChannels.
    
    Returns:
    
    Possibly-empty list of all PrivateChannels.
  - getPrivateChannelById
```
PrivateChannel getPrivateChannelById(java.lang.String id)
```
    This returns the PrivateChannel which has the same id as the one provided.
    If there is no known PrivateChannel with an id that matches the provided one, then this returns null.
    
    Parameters:
    
    id - The id of the PrivateChannel.
    
    Returns:
    
    Possibly-null PrivateChannel with matching id.
  - getSelfInfo
```
SelfInfo getSelfInfo()
```
    Returns the currently logged in account represented by SelfInfo.
    Account settings cannot be modified using this object. If you wish to modify account settings please use the AccountManager.
    
    Returns:
    
    The currently logged in account.
  - getAccountManager
```
AccountManager getAccountManager()
```
    Returns the AccountManager for the currently logged in account.
    Account settings can only be modified using this object.
    
    Returns:
    
    The AccountManager for the currently logged in account.
  - getAudioManager
```
AudioManager getAudioManager()
```
    Returns the AudioManager for this JDA instance. AudioManager deals with creating, managing and severing audio connections to VoiceChannels.
    
    Returns:
    
    The AudioManager for this JDA instance.
  - getResponseTotal
```
int getResponseTotal()
```
    This value is the total amount of JSON responses that discord has sent.
    This value resets every time the websocket has to reconnect.
    
    Returns:
    
    Never-negative int containing total response amount.
  - getGlobalProxy
```
org.apache.http.HttpHost getGlobalProxy()
```
    The proxy settings used by all JDA instances.
    
    Returns:
    
    The proxy settings used by all JDA instances. If JDA currently isn't using a proxy, Proxy.NO_PROXY is returned.
  - setDebug
```
void setDebug(boolean enableDebug)
```
    Used to enable JDA debug output.
    
    Parameters:
    
    enableDebug - If true - enables debug output.
  - isDebug
```
boolean isDebug()
```
    Used to determine if JDA is currently in debug mode.
    
    Returns:
    
    True if JDA is currently in debug mode.
  - shutdown
```
void shutdown()
```
    Shuts down JDA, closing all its connections. After this command is issued the JDA Instance can not be used anymore. This will also close the background-thread used for requests (which is required for further api calls of other JDA instances). If this is not desired, use shutdown(boolean) instead. To reconnect, just create a new JDA instance.
  - shutdown
```
void shutdown(boolean free)
```
    Shuts down JDA, closing all its connections. After this command is issued the JDA Instance can not be used anymore. Depending on the free-parameter, this will also close the background-thread used for requests. If the background-thread is closed, the system can exit properly, but no further JDA requests are possible (includes other JDA instances). If you want to reconnect, and the request-thread was not freed, just create a new JDA instance.
    
    Parameters:
    
    free - If true, shuts down JDA's rest system permanently.

Interface JDA

Method Summary

Method Detail

setEventManager

addEventListener

removeEventListener

createGuild

createGuild

createGuildAsync

createGuildAsync

getAuthToken

getUsers

getUserById

getUsersByName

getGuilds

getGuildById

getGuildsByName

getTextChannels

getTextChannelById

getTextChannelsByName

getVoiceChannels

getVoiceChannelById

getVoiceChannelByName

getPrivateChannels

getPrivateChannelById

getSelfInfo

getAccountManager

getAudioManager

getResponseTotal

getGlobalProxy

setDebug

isDebug

shutdown

shutdown