discord4j.core.object.entity

Interface GuildMessageChannel

All Superinterfaces:

Categorizable, Channel, DiscordObject, Entity, GuildChannel, Invitable, MessageChannel

All Known Implementing Classes:

NewsChannel, TextChannel

public interface GuildMessageChannel
extends Categorizable, GuildChannel, Invitable, MessageChannel

A Discord channel that is associated to a Guild and can utilize messages.

Nested Class Summary

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

Channel.Type

Method Summary

Modifier and Type	Method and Description
Flux<Snowflake>	bulkDelete(Publisher<Snowflake> messageIds) Requests to bulk delete the supplied message IDs.
Mono<Webhook>	createWebhook(Consumer<? super WebhookCreateSpec> spec) Requests to create a webhook.
Optional<String>	getTopic() Gets the channel topic, if present
Flux<Webhook>	getWebhooks() Requests to retrieve the webhooks of the channel.
boolean	isNsfw() Gets whether this channel is considered NSFW (Not Safe For Work).

Methods inherited from interface discord4j.core.object.trait.Categorizable

getCategory, getCategoryId

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

addMemberOverwrite, addMemberOverwrite, addRoleOverwrite, addRoleOverwrite, getEffectivePermissions, getGuild, getGuildId, getName, getOverwriteForMember, getOverwriteForRole, getPermissionOverwrites, getPosition, getRawPosition

Methods inherited from interface discord4j.core.object.trait.Invitable

createInvite, getInvites

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

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

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

delete, delete, getMention, getType

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

getId

Methods inherited from interface discord4j.core.object.DiscordObject

getClient

Method Detail

getTopic

Optional<String> getTopic()

Gets the channel topic, if present

Returns:

The channel topic, if present.

isNsfw

boolean isNsfw()

Gets whether this channel is considered NSFW (Not Safe For Work).

Returns:

true if this channel is considered NSFW (Not Safe For Work), false otherwise.

bulkDelete

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

Requests to bulk delete the supplied message IDs.

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.

createWebhook

Mono<Webhook> createWebhook(Consumer<? super WebhookCreateSpec> spec)

Requests to create a webhook.

Parameters:

spec - A Consumer that provides a "blank" WebhookCreateSpec 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.

getWebhooks

Flux<Webhook> 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.