Package discord4j.core.object.entity.channel

Interface TopLevelGuildMessageChannel

All Superinterfaces:

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

All Known Implementing Classes:

NewsChannel, TextChannel, VoiceChannel

public interface TopLevelGuildMessageChannel
extends CategorizableChannel, GuildMessageChannel

A Discord message channel in a guild that isn't a thread.

Nested Class Summary

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

Channel.Type

Method Summary

Modifier and Type	Method	Description
Mono<Webhook>	createWebhook(discord4j.core.spec.WebhookCreateSpec spec)	Requests to create a webhook.
default discord4j.core.spec.WebhookCreateMono	createWebhook(String name)	Requests to create a webhook.
Mono<Webhook>	createWebhook(Consumer<? super LegacyWebhookCreateSpec> 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.

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.GuildMessageChannel

bulkDelete, bulkDeleteMessages, createInvite, createInvite, getCategory, getCategory, getCategoryId, getInvites, getMembers

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

Optional<String> getTopic()

Description copied from interface: GuildMessageChannel

Gets the channel topic, if present.

Specified by:

getTopic in interface GuildMessageChannel

Returns:

The channel topic, if present.

createWebhook

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

Description copied from interface: GuildMessageChannel

Requests to create a webhook.

Specified by:

createWebhook in interface GuildMessageChannel

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

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

Description copied from interface: GuildMessageChannel

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

Specified by:

createWebhook in interface GuildMessageChannel

Returns:

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

createWebhook

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

Description copied from interface: GuildMessageChannel

Requests to create a webhook.

Specified by:

createWebhook in interface GuildMessageChannel

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

Flux<Webhook> getWebhooks()

Description copied from interface: GuildMessageChannel

Requests to retrieve the webhooks of the channel.

Specified by:

getWebhooks in interface GuildMessageChannel

Returns:

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