Interface TopLevelGuildMessageChannel
- All Superinterfaces:
CategorizableChannel
,Channel
,DiscordObject
,Entity
,GuildChannel
,GuildMessageChannel
,MessageChannel
,TopLevelGuildChannel
- All Known Implementing Classes:
NewsChannel
,TextChannel
,VoiceChannel
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.Flag, Channel.Type
-
Method Summary
Modifier and TypeMethodDescriptioncreateWebhook
(discord4j.core.spec.WebhookCreateSpec spec) Requests to create a webhook.default discord4j.core.spec.WebhookCreateMono
createWebhook
(String name) Requests to create a webhook.createWebhook
(Consumer<? super LegacyWebhookCreateSpec> spec) Deprecated.default Flux<ThreadListPart>
Requests to retrieve the joined private archived threads for this channel.default Flux<ThreadListPart>
Requests to retrieve the private archived threads for this channel.default Flux<ThreadListPart>
Requests to retrieve the public archived threads for this channel.getTopic()
Gets the channel topic, if present.Requests to retrieve the webhooks of the channel.default Mono<ThreadChannel>
startThread
(discord4j.core.spec.StartThreadWithoutMessageSpec spec) Creates a new thread that is not connected to an existing message.Methods inherited from interface discord4j.core.object.entity.channel.CategorizableChannel
createInvite, createInvite, createInvite, getCategory, getCategory, getCategoryId, getInvites, getRateLimitPerUser
Methods inherited from interface discord4j.core.object.entity.channel.Channel
delete, delete, getData, getId, getMention, getRestChannel, getType
Methods inherited from interface discord4j.core.object.DiscordObject
getClient
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, 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 Details
-
getTopic
Gets the channel topic, if present.- Returns:
- The channel topic, if present.
-
createWebhook
Deprecated.usecreateWebhook(WebhookCreateSpec)
orcreateWebhook(String)
which offer an immutable approach to build specsRequests to create a webhook.- Parameters:
spec
- AConsumer
that provides a "blank"LegacyWebhookCreateSpec
to be operated on.- Returns:
- A
Mono
where, upon successful completion, emits the createdWebhook
. If an error is received, it is emitted through theMono
.
-
createWebhook
Requests to create a webhook. Properties specifying how to create the webhook can be set via thewithXxx
methods of the returnedWebhookCreateMono
. -
createWebhook
Requests to create a webhook. -
getWebhooks
Requests to retrieve the webhooks of the channel. -
startThread
Creates a new thread that is not connected to an existing message.- Parameters:
spec
- an immutable object that specifies how to create the thread- Returns:
- A
Mono
where, upon successful completion, emits the createdThreadChannel
. If an error is received, it is emitted through theMono
.
-
getPublicArchivedThreads
Requests to retrieve the public archived threads for this channel.The audit log parts can be
combined
for easier querying. For example,channel.getPublicArchivedThreads() .take(10) .reduce(ThreadListPart::combine)
- Returns:
- A
Flux
that continually parts of this channel's thread list. If an error is received, it is emitted through theFlux
.
-
getPrivateArchivedThreads
Requests to retrieve the private archived threads for this channel.The thread list parts can be
combined
for easier querying. For example,channel.getPrivateArchivedThreads() .take(10) .reduce(ThreadListPart::combine)
- Returns:
- A
Flux
that continually parts of this channel's thread list. If an error is received, it is emitted through theFlux
.
-
getJoinedPrivateArchivedThreads
Requests to retrieve the joined private archived threads for this channel.The thread list parts can be
combined
for easier querying. For example,channel.getJoinedPrivateArchivedThreads() .take(10) .reduce(ThreadListPart::combine)
- Returns:
- A
Flux
that continually parts of this channel's thread list. If an error is received, it is emitted through theFlux
.
-
createWebhook(WebhookCreateSpec)
orcreateWebhook(String)
which offer an immutable approach to build specs