discord4j.core.retriever

Class RestEntityRetriever

java.lang.Object

discord4j.core.retriever.RestEntityRetriever

All Implemented Interfaces:

EntityRetriever

public class RestEntityRetriever
extends Object
implements EntityRetriever

Constructor Summary

Constructors

Constructor and Description
RestEntityRetriever(GatewayDiscordClient gateway)

Method Summary

Modifier and Type	Method and Description
Mono<Channel>	getChannelById(Snowflake channelId) Requests to retrieve the channel represented by the supplied ID.
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<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.
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.
Mono<User>	getUserById(Snowflake userId) Requests to retrieve the user represented by the supplied ID.

Methods inherited from class java.lang.Object

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

Constructor Detail

RestEntityRetriever

public RestEntityRetriever(GatewayDiscordClient gateway)

Method Detail

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.