DiscordClient (discord4j-core (3.0.5))

java.lang.Object
- discord4j.core.DiscordClient

```
public final class DiscordClient
extends Object
```
A high-level abstraction of common Discord operations such as entity retrieval and Discord shard manipulation.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Mono<Guild>`	`createGuild(Consumer<? super GuildCreateSpec> spec)` Requests to create a guild.
`Mono<User>`	`edit(Consumer<? super UserEditSpec> spec)` Requests to edit this client (i.e., modify the current bot user).
`Mono<ApplicationInfo>`	`getApplicationInfo()` Requests to retrieve the application info.
`Mono<Channel>`	`getChannelById(Snowflake channelId)` Requests to retrieve the channel represented by the supplied ID.
`ClientConfig`	`getConfig()` Gets the configuration for this client.
`EventDispatcher`	`getEventDispatcher()` Gets the event dispatcher, allowing reactive subscription of client events.
`Mono<Guild>`	`getGuildById(Snowflake guildId)` Requests to retrieve the guild represented by the supplied ID.
`Mono<GuildEmoji>`	`getGuildEmojiById(Snowflake guildId, Snowflake emojiId)` Requests to retrieve the guild emoji represented by the supplied IDs.
`Flux<Guild>`	`getGuilds()` Requests to retrieve the guilds the current client is in.
`Mono<Invite>`	`getInvite(String inviteCode)` Requests to retrieve an invite.
`Mono<Member>`	`getMemberById(Snowflake guildId, Snowflake userId)` Requests to retrieve the member represented by the supplied IDs.
`Mono<Message>`	`getMessageById(Snowflake channelId, Snowflake messageId)` Requests to retrieve the message represented by the supplied IDs.
`Flux<Region>`	`getRegions()` Requests to retrieve the voice regions that are available.
`long`	`getResponseTime()` Gets the amount of time it last took Discord Gateway to respond to a heartbeat with an ack.
`Mono<Role>`	`getRoleById(Snowflake guildId, Snowflake roleId)` Requests to retrieve the role represented by the supplied IDs.
`Mono<User>`	`getSelf()` Requests to retrieve the bot user.
`Optional<Snowflake>`	`getSelfId()` Gets the bot user's ID.
`ServiceMediator`	`getServiceMediator()` Obtain the `ServiceMediator` associated with this `DiscordClient`.
`Mono<User>`	`getUserById(Snowflake userId)` Requests to retrieve the user represented by the supplied ID.
`Flux<User>`	`getUsers()` Retrieve the currently stored (cached) users.
`Mono<Webhook>`	`getWebhookById(Snowflake webhookId)` Requests to retrieve the webhook represented by the supplied ID.
`boolean`	`isConnected()` Returns whether this client is currently connected to Discord Gateway.
`Mono<Void>`	`login()` Logs in the client to the gateway.
`Mono<Void>`	`logout()` Logs out the client from the gateway.
`Mono<Void>`	`updatePresence(Presence presence)` Update this client `Presence`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getServiceMediator
```
public ServiceMediator getServiceMediator()
```
    Obtain the ServiceMediator associated with this DiscordClient. This is an advanced method to access underlying middleware and resources.
    
    Returns:
    
    the current ServiceMediator for this client
  - getChannelById
```
public Mono<Channel> getChannelById(Snowflake channelId)
```
    Requests to retrieve the channel represented by the supplied ID.
    
    Parameters:
    
    channelId - The ID of the channel.
    
    Returns:
    
    A Mono where, upon successful completion, emits the Channel as represented by the supplied ID. If an error is received, it is emitted through the Mono.
  - getGuildById
```
public Mono<Guild> getGuildById(Snowflake guildId)
```
    Requests to retrieve the guild represented by the supplied ID.
    
    Parameters:
    
    guildId - The ID of the guild.
    
    Returns:
    
    A Mono where, upon successful completion, emits the Guild as represented by the supplied ID. If an error is received, it is emitted through the Mono.
  - getGuildEmojiById
```
public Mono<GuildEmoji> getGuildEmojiById(Snowflake guildId,
                                          Snowflake emojiId)
```
    Requests to retrieve the guild emoji represented by the supplied IDs.
    
    Parameters:
    
    guildId - The ID of the guild.
    
    emojiId - The ID of the emoji.
    
    Returns:
    
    A Mono where, upon successful completion, emits the GuildEmoji as represented by the supplied IDs. If an error is received, it is emitted through the Mono.
  - getMemberById
```
public Mono<Member> getMemberById(Snowflake guildId,
                                  Snowflake userId)
```
    Requests to retrieve the member represented by the supplied IDs.
    
    Parameters:
    
    guildId - The ID of the guild.
    
    userId - The ID of the user.
    
    Returns:
    
    A Mono where, upon successful completion, emits the Member as represented by the supplied IDs. If an error is received, it is emitted through the Mono.
  - getMessageById
```
public Mono<Message> getMessageById(Snowflake channelId,
                                    Snowflake messageId)
```
    Requests to retrieve the message represented by the supplied IDs.
    
    Parameters:
    
    channelId - The ID of the channel.
    
    messageId - The ID of the message.
    
    Returns:
    
    A Mono where, upon successful completion, emits the Message as represented by the supplied IDs. If an error is received, it is emitted through the Mono.
  - getRoleById
```
public Mono<Role> getRoleById(Snowflake guildId,
                              Snowflake roleId)
```
    Requests to retrieve the role represented by the supplied IDs.
    
    Parameters:
    
    guildId - The ID of the guild.
    
    roleId - The ID of the role.
    
    Returns:
    
    A Mono where, upon successful completion, emits the Role as represented by the supplied IDs. If an error is received, it is emitted through the Mono.
  - getUserById
```
public Mono<User> getUserById(Snowflake userId)
```
    Requests to retrieve the user represented by the supplied ID.
    
    Parameters:
    
    userId - The ID of the user.
    
    Returns:
    
    A Mono where, upon successful completion, emits the User as represented by the supplied ID. If an error is received, it is emitted through the Mono.
  - getWebhookById
```
public Mono<Webhook> getWebhookById(Snowflake webhookId)
```
    Requests to retrieve the webhook represented by the supplied ID.
    
    Parameters:
    
    webhookId - The ID of the webhook.
    
    Returns:
    
    A Mono where, upon successful completion, emits the Webhook as represented by the supplied ID. If an error is received, it is emitted through the Mono.
  - getApplicationInfo
```
public Mono<ApplicationInfo> getApplicationInfo()
```
    Requests to retrieve the application info.
    
    Returns:
    
    A Mono where, upon successful completion, emits the application info. If an error is received, it is emitted through the Mono.
  - getGuilds
```
public Flux<Guild> getGuilds()
```
    Requests to retrieve the guilds the current client is in.
    
    Returns:
    
    A Flux that continually emits the guilds that the current client is in. If an error is received, it is emitted through the Flux.
  - getUsers
```
public Flux<User> getUsers()
```
    Retrieve the currently stored (cached) users.
    
    Returns:
    
    A Flux that continually emits the users that the current client has stored. If an error is received, it is emitted through the Flux.
  - getRegions
```
public Flux<Region> getRegions()
```
    Requests to retrieve the voice regions that are available.
    
    Returns:
    
    A Flux that continually emits the regions that are available. If an error is received, it is emitted through the Flux.
  - getSelf
```
public Mono<User> getSelf()
```
    Requests to retrieve the bot user.
    
    Returns:
    
    A Mono where, upon successful completion, emits the bot user. If an error is received, it is emitted through the Mono.
  - getSelfId
```
public Optional<Snowflake> getSelfId()
```
    Gets the bot user's ID. This may not be present if this client is not yet logged in.
    
    Returns:
    
    The bot user's ID.
  - login
```
public Mono<Void> login()
```
    Logs in the client to the gateway.
    
    Returns:
    
    A Mono that completes (either successfully or with an error) when the client disconnects from the gateway without a reconnect attempt. It is recommended to call this from main and as a final statement invoke Mono.block().
  - logout
```
public Mono<Void> logout()
```
    Logs out the client from the gateway.
    
    Returns:
    
    a Mono deferring completion until this client has completely disconnected from the gateway
  - isConnected
```
public boolean isConnected()
```
    Returns whether this client is currently connected to Discord Gateway.
    
    Returns:
    
    true if the gateway connection is currently established, false otherwise.
  - getResponseTime
```
public long getResponseTime()
```
    Gets the amount of time it last took Discord Gateway to respond to a heartbeat with an ack.
    
    Returns:
    
    the time in milliseconds took Discord to respond to the last heartbeat with an ack.
  - createGuild
```
public Mono<Guild> createGuild(Consumer<? super GuildCreateSpec> spec)
```
    Requests to create a guild.
    
    Parameters:
    
    spec - A Consumer that provides a "blank" GuildCreateSpec to be operated on.
    
    Returns:
    
    A Mono where, upon successful completion, emits the created Guild. If an error is received, it is emitted through the Mono.
  - updatePresence
```
public Mono<Void> updatePresence(Presence presence)
```
    Update this client Presence.
    
    Parameters:
    
    presence - The updated client presence.
    
    Returns:
    
    A Mono that signals completion upon successful update. If an error is received, it is emitted through the Mono.
  - getInvite
```
public Mono<Invite> getInvite(String inviteCode)
```
    Requests to retrieve an invite.
    
    Parameters:
    
    inviteCode - The code for the invite (e.g. "xdYkpp").
    
    Returns:
    
    A Mono where, upon successful completion, emits the Invite as represented by the supplied invite code. If an error is received, it is emitted through the Mono.
  - edit
```
public Mono<User> edit(Consumer<? super UserEditSpec> spec)
```
    Requests to edit this client (i.e., modify the current bot user).
    
    Parameters:
    
    spec - A Consumer that provides a "blank" UserEditSpec to be operated on.
    
    Returns:
    
    A Mono where, upon successful completion, emits the edited User. If an error is received, it is emitted through the Mono.
  - getEventDispatcher
```
public EventDispatcher getEventDispatcher()
```
    Gets the event dispatcher, allowing reactive subscription of client events.
    
    Returns:
    
    an EventDispatcher associated with this client.
  - getConfig
```
public ClientConfig getConfig()
```
    Gets the configuration for this client.
    
    Returns:
    
    The configuration for this client.

Class DiscordClient

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getServiceMediator

getChannelById

getGuildById

getGuildEmojiById

getMemberById

getMessageById

getRoleById

getUserById

getWebhookById

getApplicationInfo

getGuilds

getUsers

getRegions

getSelf

getSelfId

login

logout

isConnected

getResponseTime

createGuild

updatePresence

getInvite

edit

getEventDispatcher

getConfig