Package discord4j.core.object.entity.channel

Interface GuildMessageChannel

All Superinterfaces:

CategorizableChannel, Channel, DiscordObject, Entity, GuildChannel, MessageChannel, TopLevelGuildChannel

All Known Subinterfaces:

TopLevelGuildMessageChannel

All Known Implementing Classes:

NewsChannel, TextChannel, VoiceChannel

public interface GuildMessageChannel
extends CategorizableChannel, MessageChannel

A Discord channel in a guild that can have messages sent to it.

Nested Class Summary

Nested classes/interfaces inherited from interface discord4j.core.object.entity.channel.Channel

Channel.Type

Method Summary

Modifier and Type	Method	Description
Flux<Snowflake>	bulkDelete(Publisher<Snowflake> messageIds)	Requests to bulk delete the supplied message IDs.
Flux<Message>	bulkDeleteMessages(Publisher<Message> messages)	Requests to bulk delete the supplied messages.
default discord4j.core.spec.InviteCreateMono	createInvite()	Deprecated. Threads aren't categorizable, so when they are released, GuildMessageChannel will no longer extend CategorizableChannel.
Mono<ExtendedInvite>	createInvite(discord4j.core.spec.InviteCreateSpec spec)	Deprecated. Threads aren't categorizable, so when they are released, GuildMessageChannel will no longer extend CategorizableChannel.
Mono<Webhook>	createWebhook(discord4j.core.spec.WebhookCreateSpec spec)	Deprecated. Threads don't have webhooks, so when they are released, this will be moved to TopLevelGuildMessageChannel.createWebhook(WebhookCreateSpec).
default discord4j.core.spec.WebhookCreateMono	createWebhook(String name)	Deprecated. Threads don't have webhooks, so when they are released, this will be moved to TopLevelGuildMessageChannel.createWebhook(String).
Mono<Webhook>	createWebhook(Consumer<? super LegacyWebhookCreateSpec> spec)	Deprecated. use createWebhook(WebhookCreateSpec) or createWebhook(String) which offer an immutable approach to build specs
Mono<Category>	getCategory()	Deprecated. Threads aren't categorizable, so when they are released, GuildMessageChannel will no longer extend CategorizableChannel.
Mono<Category>	getCategory(EntityRetrievalStrategy retrievalStrategy)	Deprecated. Threads aren't categorizable, so when they are released, GuildMessageChannel will no longer extend CategorizableChannel.
Optional<Snowflake>	getCategoryId()	Deprecated. Threads aren't categorizable, so when they are released, GuildMessageChannel will no longer extend CategorizableChannel.
Flux<ExtendedInvite>	getInvites()	Deprecated. Threads aren't categorizable, so when they are released, GuildMessageChannel will no longer extend CategorizableChannel.
Flux<Member>	getMembers()	Returns all members in the guild which have access to view this channel.
Optional<String>	getTopic()	Deprecated. Threads don't have topics, so when they are released, this will be moved to TopLevelGuildMessageChannel.getTopic().
Flux<Webhook>	getWebhooks()	Deprecated. Threads don't have webhooks, so when they are released, this will be moved to TopLevelGuildMessageChannel.getWebhooks().

Methods inherited from interface discord4j.core.object.entity.channel.CategorizableChannel

createInvite

Methods inherited from interface discord4j.core.object.entity.channel.Channel

delete, delete, getMention, getRestChannel, getType

Methods inherited from interface discord4j.core.object.DiscordObject

getClient

Methods inherited from interface discord4j.core.object.entity.Entity

getId

Methods inherited from interface discord4j.core.object.entity.channel.GuildChannel

getEffectivePermissions, getEffectivePermissions, getGuild, getGuild, getGuildId, getName

Methods inherited from interface discord4j.core.object.entity.channel.MessageChannel

createEmbed, createEmbed, createMessage, createMessage, createMessage, createMessage, getLastMessage, getLastMessage, getLastMessageId, getLastPinTimestamp, getMessageById, getMessageById, getMessagesAfter, getMessagesBefore, getPinnedMessages, type, typeUntil

Methods inherited from interface discord4j.core.object.entity.channel.TopLevelGuildChannel

addMemberOverwrite, addMemberOverwrite, addRoleOverwrite, addRoleOverwrite, getOverwriteForMember, getOverwriteForRole, getPermissionOverwrites, getPosition, getRawPosition

Method Detail

getTopic

@Deprecated
Optional<String> getTopic()

Deprecated.

Threads don't have topics, so when they are released, this will be moved to TopLevelGuildMessageChannel.getTopic().

Gets the channel topic, if present.

Returns:

The channel topic, if present.

bulkDelete

Flux<Snowflake> bulkDelete(Publisher<Snowflake> messageIds)

Requests to bulk delete the supplied message IDs.

Typically this method is paired with a call from MessageChannel.getMessagesBefore(Snowflake) or MessageChannel.getMessagesAfter(Snowflake) to delete some or (potentially) all messages from a channel.

 
 channel.getMessagesBefore(Snowflake.of(Instant.now()))
     .take(420)
     .map(Message::getId)
     .transform(channel::bulkDelete)
 
 

If you have a Publisher<Message>, consider bulkDeleteMessages(Publisher).

Parameters:

messageIds - A Publisher to supply the message IDs to bulk delete.

Returns:

A Flux that continually emits message IDs that were not bulk deleted (typically if the ID was older than 2 weeks). If an error is received, it is emitted through the Flux.

bulkDeleteMessages

Flux<Message> bulkDeleteMessages(Publisher<Message> messages)

Requests to bulk delete the supplied messages.

Typically this method is paired with a call from MessageChannel.getMessagesBefore(Snowflake) or MessageChannel.getMessagesAfter(Snowflake) to delete some or (potentially) all messages from a channel.

 
 channel.getMessagesBefore(Snowflake.of(Instant.now()))
     .take(420)
     .transform(channel::bulkDeleteMessages)
 
 

If you have a Publisher<Snowflake>, consider bulkDelete(Publisher).

Parameters:

messages - A Publisher to supply the messages to bulk delete.

Returns:

A Flux that continually emits messages that were not bulk deleted (typically if the message was older than 2 weeks). If an error is received, it is emitted through the Flux.

createWebhook

@Deprecated
Mono<Webhook> createWebhook(Consumer<? super LegacyWebhookCreateSpec> spec)

Deprecated.

use createWebhook(WebhookCreateSpec) or createWebhook(String) which offer an immutable approach to build specs

Requests to create a webhook.

Parameters:

spec - A Consumer that provides a "blank" LegacyWebhookCreateSpec to be operated on.

Returns:

A Mono where, upon successful completion, emits the created Webhook. If an error is received, it is emitted through the Mono.

createWebhook

@Deprecated
default discord4j.core.spec.WebhookCreateMono createWebhook(String name)

Deprecated.

Threads don't have webhooks, so when they are released, this will be moved to TopLevelGuildMessageChannel.createWebhook(String).

Requests to create a webhook. Properties specifying how to create the webhook can be set via the withXxx methods of the returned WebhookCreateMono.

Returns:

A Mono where, upon successful completion, emits the created Webhook. If an error is received, it is emitted through the Mono.

createWebhook

@Deprecated
Mono<Webhook> createWebhook(discord4j.core.spec.WebhookCreateSpec spec)

Deprecated.

Threads don't have webhooks, so when they are released, this will be moved to TopLevelGuildMessageChannel.createWebhook(WebhookCreateSpec).

Requests to create a webhook.

Parameters:

spec - an immutable object that specifies how to create the webhook

Returns:

A Mono where, upon successful completion, emits the created Webhook. If an error is received, it is emitted through the Mono.

getWebhooks

@Deprecated
Flux<Webhook> getWebhooks()

Deprecated.

Threads don't have webhooks, so when they are released, this will be moved to TopLevelGuildMessageChannel.getWebhooks().

Requests to retrieve the webhooks of the channel.

Returns:

A Flux that continually emits the webhooks of the channel. If an error is received, it is emitted through the Flux.

getMembers

Flux<Member> getMembers()

Returns all members in the guild which have access to view this channel.

Returns:

A Flux that continually emits all members from Guild.getMembers() which have access to view this channel Permission.VIEW_CHANNEL

getCategoryId

@Deprecated
Optional<Snowflake> getCategoryId()

Deprecated.

Threads aren't categorizable, so when they are released, GuildMessageChannel will no longer extend CategorizableChannel. Use CategorizableChannel.getCategoryId()

Description copied from interface: CategorizableChannel

Gets the ID of the category for this channel, if present.

Specified by:

getCategoryId in interface CategorizableChannel

Returns:

The ID of the category for this channel, if present.

getCategory

@Deprecated
Mono<Category> getCategory()

Deprecated.

Threads aren't categorizable, so when they are released, GuildMessageChannel will no longer extend CategorizableChannel. Use CategorizableChannel.getCategory()

Description copied from interface: CategorizableChannel

Requests to retrieve the category for this channel, if present.

Specified by:

getCategory in interface CategorizableChannel

Returns:

A Mono where, upon successful completion, emits the category this channel, if present. If an error is received, it is emitted through the Mono.

getCategory

@Deprecated
Mono<Category> getCategory(EntityRetrievalStrategy retrievalStrategy)

Deprecated.

Threads aren't categorizable, so when they are released, GuildMessageChannel will no longer extend CategorizableChannel. Use CategorizableChannel.getCategory(EntityRetrievalStrategy)

Description copied from interface: CategorizableChannel

Requests to retrieve the category for this channel, if present, using the given retrieval strategy.

Specified by:

getCategory in interface CategorizableChannel

Parameters:

retrievalStrategy - the strategy to use to get the category

Returns:

A Mono where, upon successful completion, emits the category this channel, if present. If an error is received, it is emitted through the Mono.

createInvite

@Deprecated
default discord4j.core.spec.InviteCreateMono createInvite()

Deprecated.

Threads aren't categorizable, so when they are released, GuildMessageChannel will no longer extend CategorizableChannel. Use CategorizableChannel.createInvite()

Description copied from interface: CategorizableChannel

Requests to create an invite. Properties specifying how to create the invite can be set via the withXxx methods of the returned InviteCreateMono.

Specified by:

createInvite in interface CategorizableChannel

Returns:

A InviteCreateMono where, upon successful completion, emits the created ExtendedInvite. If an error is received, it is emitted through the InviteCreateMono.

createInvite

@Deprecated
Mono<ExtendedInvite> createInvite(discord4j.core.spec.InviteCreateSpec spec)

Deprecated.

Threads aren't categorizable, so when they are released, GuildMessageChannel will no longer extend CategorizableChannel. Use CategorizableChannel.createInvite(InviteCreateSpec) )}

Description copied from interface: CategorizableChannel

Requests to create an invite.

Specified by:

createInvite in interface CategorizableChannel

Parameters:

spec - an immutable object that specifies how to create the invite

Returns:

A Mono where, upon successful completion, emits the created ExtendedInvite. If an error is received, it is emitted through the Mono.

getInvites

@Deprecated
Flux<ExtendedInvite> getInvites()

Deprecated.

Threads aren't categorizable, so when they are released, GuildMessageChannel will no longer extend CategorizableChannel. Use CategorizableChannel.getInvites() )}

Description copied from interface: CategorizableChannel

Requests to retrieve this channel's invites.

Specified by:

getInvites in interface CategorizableChannel

Returns:

A Flux that continually emits this channel's invites. If an error is received, it is emitted through the Flux.