GatewayDiscordClient (discord4j-core (3.1.0.RC4))

java.lang.Object
- discord4j.core.GatewayDiscordClient

All Implemented Interfaces:

EntityRetriever
```
public class GatewayDiscordClient
extends Object
implements EntityRetriever
```
An aggregation of all dependencies Discord4J requires to operate with the Discord Gateway, REST API and Voice Gateway. Maintains a set of connections to every shard logged in from the same GatewayBootstrap and therefore tracks state updates from all connected shards.
The following are some of the resources available through this aggregate:
- Access to the base DiscordClient for direct REST API operations through rest().
- Access to CoreResources like the RestClient used to perform API requests.
- Access to GatewayResources that configure Gateway stores, actions and coordination among shards.
- Access to EventDispatcher publishing events from all participating shards.

Constructor Summary

Constructors
Constructor and Description
`GatewayDiscordClient(DiscordClient discordClient, GatewayResources gatewayResources, MonoProcessor<Void> closeProcessor, GatewayClientGroup gatewayClientGroup, VoiceConnectionFactory voiceConnectionFactory, EntityRetrievalStrategy entityRetrievalStrategy)`

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.
`CoreResources`	`getCoreResources()` Returns the set of resources essential to operate on a `DiscordClient` for entity manipulation, scheduling and API communication, like the `RestClient`, `JacksonResources` and `ReactorResources`.
`EventDispatcher`	`getEventDispatcher()` Distributes events to subscribers.
`Optional<GatewayClient>`	`getGatewayClient(int shardId)` Returns a `GatewayClient` instance created by this `GatewayDiscordClient`, which is associated to a given shard index.
`GatewayClientGroup`	`getGatewayClientGroup()` Returns the `GatewayClientGroup` capable of performing operations across all `GatewayClient` instances created or managed by this `GatewayDiscordClient`.
`GatewayResources`	`getGatewayResources()` Returns the set of resources essential to build `GatewayClient` instances and manage multiple Discord Gateway connections.
`Mono<Guild>`	`getGuildById(Snowflake guildId)` Requests to retrieve the guild represented by the supplied ID.
`Flux<GuildChannel>`	`getGuildChannels(Snowflake guildId)` Requests to retrieve the guild's channels.
`Mono<GuildEmoji>`	`getGuildEmojiById(Snowflake guildId, Snowflake emojiId)` Requests to retrieve the guild emoji represented by the supplied IDs.
`Flux<GuildEmoji>`	`getGuildEmojis(Snowflake guildId)` Requests to retrieve the guild's emojis.
`Flux<Member>`	`getGuildMembers(Snowflake guildId)` Requests to retrieve the guild's members.
`Flux<Role>`	`getGuildRoles(Snowflake guildId)` Requests to retrieve the guild's roles.
`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.
`RestClient`	`getRestClient()` Returns the `RestClient` used to execute REST API requests.
`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.
`Snowflake`	`getSelfId()` Gets the bot user's ID.
`Mono<User>`	`getUserById(Snowflake userId)` Requests to retrieve the user represented by the supplied ID.
`Flux<User>`	`getUsers()` Retrieve the currently stored (cached) users.
`VoiceConnectionFactory`	`getVoiceConnectionFactory()` Returns the `VoiceConnectionFactory` instance created by this `GatewayDiscordClient`.
`VoiceConnectionRegistry`	`getVoiceConnectionRegistry()` Return the `VoiceConnectionRegistry` for this `GatewayDiscordClient`.
`Mono<Webhook>`	`getWebhookById(Snowflake webhookId)` Requests to retrieve the webhook represented by the supplied ID.
`Mono<Void>`	`logout()` Disconnects this `GatewayDiscordClient` from Discord upon subscribing.
`<E extends Event> Flux<E>`	`on(Class<E> eventClass)` Retrieves a `Flux` with elements of the given `Event` type.
`<E extends Event,T> Flux<T>`	`on(Class<E> eventClass, Function<E,Publisher<T>> mapper)` Retrieves a `Flux` with elements of the given `Event` type, processing them through a given `Function`.
`Mono<Void>`	`onDisconnect()` Return a `Mono` that signals completion when all `GatewayClient` instances in this shard group have disconnected.
`Flux<Member>`	`requestMembers(discord4j.discordjson.json.gateway.RequestGuildMembers request)` Submit a `RequestGuildMembers` payload using the current Gateway connection and wait for its completion, delivering `Member` elements asynchronously through a `Flux`.
`Flux<Member>`	`requestMembers(Snowflake guildId)` Return all `members` from the given `guildId` using the current Gateway connection.
`Flux<Member>`	`requestMembers(Snowflake guildId, Set<Snowflake> userIds)` Return a set of `members` from the given `guildId` using the current Gateway connection.
`DiscordClient`	`rest()` Access the parent `DiscordClient` capable of performing direct REST API requests and REST entities.
`Mono<Void>`	`updatePresence(discord4j.discordjson.json.gateway.StatusUpdate statusUpdate)` Update the bot's `Presence` (client status) for every shard in this shard group.
`Mono<Void>`	`updatePresence(discord4j.discordjson.json.gateway.StatusUpdate statusUpdate, int shardId)` Update the bot's `Presence` (status) for the given shard index, provided it belongs in this shard group.
`EntityRetriever`	`withRetrievalStrategy(EntityRetrievalStrategy retrievalStrategy)` Applies the given strategy to retrieve entities using this `GatewayDiscordClient`.

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

- Constructor Detail
  - GatewayDiscordClient
```
public GatewayDiscordClient(DiscordClient discordClient,
                            GatewayResources gatewayResources,
                            MonoProcessor<Void> closeProcessor,
                            GatewayClientGroup gatewayClientGroup,
                            VoiceConnectionFactory voiceConnectionFactory,
                            EntityRetrievalStrategy entityRetrievalStrategy)
```
- Method Detail
  - rest
```
public DiscordClient rest()
```
    Access the parent DiscordClient capable of performing direct REST API requests and REST entities.
    
    Returns:
    
    the DiscordClient that created this GatewayDiscordClient
  - getCoreResources
```
public CoreResources getCoreResources()
```
    Returns the set of resources essential to operate on a DiscordClient for entity manipulation, scheduling and API communication, like the RestClient, JacksonResources and ReactorResources.
    
    Returns:
    
    the RestResources for the parent DiscordClient
  - getGatewayResources
```
public GatewayResources getGatewayResources()
```
    Returns the set of resources essential to build GatewayClient instances and manage multiple Discord Gateway connections.
    
    Returns:
    
    the GatewayResources tied to this GatewayDiscordClient
  - getEventDispatcher
```
public EventDispatcher getEventDispatcher()
```
    Distributes events to subscribers. Starting from v3.1, the EventDispatcher is capable of distributing events from all GatewayClient connections (shards) that were specified when this GatewayDiscordClient was created.
    
    Returns:
    
    the EventDispatcher tied to this GatewayDiscordClient
  - getGatewayClient
```
public Optional<GatewayClient> getGatewayClient(int shardId)
```
    Returns a GatewayClient instance created by this GatewayDiscordClient, which is associated to a given shard index.
    
    Parameters:
    
    shardId - the shard index used to get the client instance
    
    Returns:
    
    a GatewayClient instance represented by the given shard, if present
  - getGatewayClientGroup
```
public GatewayClientGroup getGatewayClientGroup()
```
    Returns the GatewayClientGroup capable of performing operations across all GatewayClient instances created or managed by this GatewayDiscordClient.
    
    Returns:
    
    a GatewayClientGroup to aggregate gateway operations
  - getVoiceConnectionFactory
```
public VoiceConnectionFactory getVoiceConnectionFactory()
```
    Returns the VoiceConnectionFactory instance created by this GatewayDiscordClient.
    
    Returns:
    
    a VoiceConnectionFactory instance capable of initiating voice connections
  - getVoiceConnectionRegistry
```
public VoiceConnectionRegistry getVoiceConnectionRegistry()
```
    Return the VoiceConnectionRegistry for this GatewayDiscordClient. This allows you to retrieve currently registered VoiceConnection instances.
    
    Returns:
    
    a VoiceConnectionRegistry for voice connections
  - getRestClient
```
public RestClient getRestClient()
```
    Returns the RestClient used to execute REST API requests.
    
    Returns:
    
    the RestClient tied to this Gateway client.
  - 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.
  - 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.
  - getSelfId
```
public Snowflake getSelfId()
```
    Gets the bot user's ID.
    
    Returns:
    
    The bot user's ID.
  - 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(discord4j.discordjson.json.gateway.StatusUpdate statusUpdate)
```
    Update the bot's Presence (client status) for every shard in this shard group.
    Factories exist to build an StatusUpdate object to update the bot's status:
    Factories exist to build an ActivityUpdateRequest object for StatusUpdate:
    Parameters:
    
    statusUpdate - The updated client status.
    
    Returns:
    
    A Mono that signals completion upon successful update. If an error is received, it is emitted through the Mono.
  - updatePresence
```
public Mono<Void> updatePresence(discord4j.discordjson.json.gateway.StatusUpdate statusUpdate,
                                 int shardId)
```
    Update the bot's Presence (status) for the given shard index, provided it belongs in this shard group.
    Factories exist to build an StatusUpdate object to update the bot's status:
    Factories exist to build an ActivityUpdateRequest object for StatusUpdate:
    Parameters:
    
    statusUpdate - 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.
  - logout
```
public Mono<Void> logout()
```
    Disconnects this GatewayDiscordClient from Discord upon subscribing. All GatewayClient instances in this shard group will attempt to close their current Gateway session and complete this Mono after all of them have disconnected.
    
    Returns:
    
    A Mono that upon subscription, will disconnect each Gateway connection established by this GatewayDiscordClient and complete after all of them have closed.
  - onDisconnect
```
public Mono<Void> onDisconnect()
```
    Return a Mono that signals completion when all GatewayClient instances in this shard group have disconnected.
    
    Returns:
    
    a Mono that will complete once all GatewayClient instances in this shard group have disconnected.
  - on
```
public <E extends Event> Flux<E> on(Class<E> eventClass)
```
    Retrieves a Flux with elements of the given Event type.
    Note: Errors occurring while processing events will terminate your sequence. If you wish to use a version capable of handling errors for you, use on(Class, Function). See Reactive Streams Spec explaining this behavior.
    A recommended pattern to use this method is wrapping your code that may throw exceptions within a flatMap block and use Mono.onErrorResume(Function), Flux.onErrorResume(Function) or equivalent methods to maintain the sequence active:
```
 client.on(MessageCreateEvent.class)
     .flatMap(event -> myCodeThatMightThrow(event)
             .onErrorResume(error -> {
                 // log and then discard the error to keep the sequence alive
                 log.error("Failed to handle event!", error);
                 return Mono.empty();
             }))
     .subscribe();
 
```
    For more alternatives to handling errors, please see Error Handling wiki page.
    Type Parameters:
    
    E - the type of the event class
    
    Parameters:
    
    eventClass - the event class to obtain events from
    
    Returns:
    
    a new Flux with the requested events
  - on
```
public <E extends Event,T> Flux<T> on(Class<E> eventClass,
                                      Function<E,Publisher<T>> mapper)
```
    Retrieves a Flux with elements of the given Event type, processing them through a given Function. Errors occurring within the mapper will be logged and discarded, preventing the termination of the "infinite" event sequence.
    There are multiple ways of using this event handling method, for example:
```
 client.on(MessageCreateEvent.class, event -> {
         // myCodeThatMightThrow should return a Reactor type (Mono or Flux)
         return myCodeThatMightThrow(event);
     })
     .subscribe();

 client.on(MessageCreateEvent.class, event -> {
         // myCodeThatMightThrow *can* be blocking
         myCodeThatMightThrow(event);
         return Mono.empty(); // but we have to return a Reactor type
     })
     .subscribe();
 
```
    Continuing the chain after on(class, event -> ...) will require your own error handling strategy. Check the docs for on(Class) for more details.
    Type Parameters:
    
    E - the type of the event class
    
    T - the type of the event mapper function
    
    Parameters:
    
    eventClass - the event class to obtain events from
    
    mapper - an event mapping function called on each event. If you do not wish to perform further operations you can return Mono.empty().
    
    Returns:
    
    a new Flux with the type resulting from the given event mapper
  - requestMembers
```
public Flux<Member> requestMembers(Snowflake guildId)
```
    Return all members from the given guildId using the current Gateway connection. This method performs a check to validate whether the given guild's data can be obtained from this GatewayDiscordClient.
    
    Parameters:
    
    guildId - the Snowflake of the guild to obtain members from
    
    Returns:
    
    a Flux of Member for the given Guild. If an error occurs, it is emitted through the Flux.
  - requestMembers
```
public Flux<Member> requestMembers(Snowflake guildId,
                                   Set<Snowflake> userIds)
```
    Return a set of members from the given guildId using the current Gateway connection. This method performs a check to validate whether the given guild's data can be obtained from this GatewayDiscordClient.
    
    Parameters:
    
    guildId - the Snowflake of the guild to obtain members from
    
    userIds - the Snowflake set of users to request
    
    Returns:
    
    a Flux of Member for the given Guild. If an error occurs, it is emitted through the Flux.
  - requestMembers
```
public Flux<Member> requestMembers(discord4j.discordjson.json.gateway.RequestGuildMembers request)
```
    Submit a RequestGuildMembers payload using the current Gateway connection and wait for its completion, delivering Member elements asynchronously through a Flux. This method performs a check to validate whether the given guild's data can be obtained from this GatewayDiscordClient.
    
    Parameters:
    
    request - the member request to submit. Create one using RequestGuildMembers.builder().
    
    Returns:
    
    a Flux of Member for the given Guild. If an error occurs, it is emitted through the Flux.
  - withRetrievalStrategy
```
public EntityRetriever withRetrievalStrategy(EntityRetrievalStrategy retrievalStrategy)
```
    Applies the given strategy to retrieve entities using this GatewayDiscordClient.
    
    Parameters:
    
    retrievalStrategy - the strategy to apply
    
    Returns:
    
    an EntityRetriever able to retrieve entities using the given strategy
  - getChannelById
```
public Mono<Channel> getChannelById(Snowflake channelId)
```
    Description copied from interface: EntityRetriever
    
    Requests to retrieve the channel represented by the supplied ID.
    
    Specified by:
    
    getChannelById in interface EntityRetriever
    
    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)
```
    Description copied from interface: EntityRetriever
    
    Requests to retrieve the guild represented by the supplied ID.
    
    Specified by:
    
    getGuildById in interface EntityRetriever
    
    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)
```
    Description copied from interface: EntityRetriever
    
    Requests to retrieve the guild emoji represented by the supplied IDs.
    
    Specified by:
    
    getGuildEmojiById in interface EntityRetriever
    
    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)
```
    Description copied from interface: EntityRetriever
    
    Requests to retrieve the member represented by the supplied IDs.
    
    Specified by:
    
    getMemberById in interface EntityRetriever
    
    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)
```
    Description copied from interface: EntityRetriever
    
    Requests to retrieve the message represented by the supplied IDs.
    
    Specified by:
    
    getMessageById in interface EntityRetriever
    
    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)
```
    Description copied from interface: EntityRetriever
    
    Requests to retrieve the role represented by the supplied IDs.
    
    Specified by:
    
    getRoleById in interface EntityRetriever
    
    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)
```
    Description copied from interface: EntityRetriever
    
    Requests to retrieve the user represented by the supplied ID.
    
    Specified by:
    
    getUserById in interface EntityRetriever
    
    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.
  - getGuilds
```
public Flux<Guild> getGuilds()
```
    Description copied from interface: EntityRetriever
    
    Requests to retrieve the guilds the current client is in.
    
    Specified by:
    
    getGuilds in interface EntityRetriever
    
    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.
  - getSelf
```
public Mono<User> getSelf()
```
    Description copied from interface: EntityRetriever
    
    Requests to retrieve the bot user.
    
    Specified by:
    
    getSelf in interface EntityRetriever
    
    Returns:
    
    A Mono where, upon successful completion, emits the bot user. If an error is received, it is emitted through the Mono.
  - getGuildMembers
```
public Flux<Member> getGuildMembers(Snowflake guildId)
```
    Description copied from interface: EntityRetriever
    
    Requests to retrieve the guild's members.
    
    Specified by:
    
    getGuildMembers in interface EntityRetriever
    
    Parameters:
    
    guildId - the ID of the guild.
    
    Returns:
    
    A Flux that continually emits the members of the guild. If an error is received, it is emitted through the Flux.
  - getGuildChannels
```
public Flux<GuildChannel> getGuildChannels(Snowflake guildId)
```
    Description copied from interface: EntityRetriever
    
    Requests to retrieve the guild's channels.
    The order of items emitted by the returned Flux is unspecified. Use OrderUtil.orderGuildChannels(Flux) to consistently order channels.
    
    Specified by:
    
    getGuildChannels in interface EntityRetriever
    
    Parameters:
    
    guildId - the ID of the guild.
    
    Returns:
    
    A Flux that continually emits the guild's channels. If an error is received, it is emitted through the Flux.
  - getGuildRoles
```
public Flux<Role> getGuildRoles(Snowflake guildId)
```
    Description copied from interface: EntityRetriever
    
    Requests to retrieve the guild's roles.
    The order of items emitted by the returned Flux is unspecified. Use OrderUtil.orderRoles(Flux) to consistently order roles.
    
    Specified by:
    
    getGuildRoles in interface EntityRetriever
    
    Returns:
    
    A Flux that continually emits the guild's roles. If an error is received, it is emitted through the Flux.
  - getGuildEmojis
```
public Flux<GuildEmoji> getGuildEmojis(Snowflake guildId)
```
    Description copied from interface: EntityRetriever
    
    Requests to retrieve the guild's emojis.
    
    Specified by:
    
    getGuildEmojis in interface EntityRetriever
    
    Returns:
    
    A Flux that continually emits the guild's emojis. If an error is received, it is emitted through the Flux.

Class GatewayDiscordClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GatewayDiscordClient

Method Detail

rest

getCoreResources

getGatewayResources

getEventDispatcher

getGatewayClient

getGatewayClientGroup

getVoiceConnectionFactory

getVoiceConnectionRegistry

getRestClient

getWebhookById

getApplicationInfo

getUsers

getRegions

getSelfId

createGuild

updatePresence

updatePresence

getInvite

edit

logout

onDisconnect

on

on

requestMembers

requestMembers

requestMembers

withRetrievalStrategy

getChannelById

getGuildById

getGuildEmojiById

getMemberById

getMessageById

getRoleById

getUserById

getGuilds

getSelf

getGuildMembers

getGuildChannels

getGuildRoles

getGuildEmojis