Interface CategorizableChannel
-
- All Superinterfaces:
Channel
,DiscordObject
,Entity
,GuildChannel
,TopLevelGuildChannel
- All Known Subinterfaces:
GuildMessageChannel
,TopLevelGuildMessageChannel
- All Known Implementing Classes:
NewsChannel
,StoreChannel
,TextChannel
,VoiceChannel
public interface CategorizableChannel extends TopLevelGuildChannel
A Discord channel which can be categorized into aCategory
. These channels can also have invites.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface discord4j.core.object.entity.channel.Channel
Channel.Type
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description default discord4j.core.spec.InviteCreateMono
createInvite()
Requests to create an invite.Mono<ExtendedInvite>
createInvite(discord4j.core.spec.InviteCreateSpec spec)
Requests to create an invite.Mono<ExtendedInvite>
createInvite(Consumer<? super LegacyInviteCreateSpec> spec)
Deprecated.usecreateInvite(InviteCreateSpec)
orcreateInvite()
which offer an immutable approach to build specsMono<Category>
getCategory()
Requests to retrieve the category for this channel, if present.Mono<Category>
getCategory(EntityRetrievalStrategy retrievalStrategy)
Requests to retrieve the category for this channel, if present, using the given retrieval strategy.Optional<Snowflake>
getCategoryId()
Gets the ID of the category for this channel, if present.Flux<ExtendedInvite>
getInvites()
Requests to retrieve this channel's invites.-
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.channel.GuildChannel
getEffectivePermissions, getEffectivePermissions, getGuild, getGuild, getGuildId, getName
-
Methods inherited from interface discord4j.core.object.entity.channel.TopLevelGuildChannel
addMemberOverwrite, addMemberOverwrite, addRoleOverwrite, addRoleOverwrite, getOverwriteForMember, getOverwriteForRole, getPermissionOverwrites, getPosition, getRawPosition
-
-
-
-
Method Detail
-
getCategoryId
Optional<Snowflake> getCategoryId()
Gets the ID of the category for this channel, if present.- Returns:
- The ID of the category for this channel, if present.
-
getCategory
Mono<Category> getCategory()
Requests to retrieve the category for this channel, if present.
-
getCategory
Mono<Category> getCategory(EntityRetrievalStrategy retrievalStrategy)
Requests to retrieve the category for this channel, if present, using the given retrieval strategy.
-
createInvite
@Deprecated Mono<ExtendedInvite> createInvite(Consumer<? super LegacyInviteCreateSpec> spec)
Deprecated.usecreateInvite(InviteCreateSpec)
orcreateInvite()
which offer an immutable approach to build specsRequests to create an invite.- Parameters:
spec
- AConsumer
that provides a "blank"LegacyInviteCreateSpec
to be operated on.- Returns:
- A
Mono
where, upon successful completion, emits the createdExtendedInvite
. If an error is received, it is emitted through theMono
.
-
createInvite
default discord4j.core.spec.InviteCreateMono createInvite()
Requests to create an invite. Properties specifying how to create the invite can be set via thewithXxx
methods of the returnedInviteCreateMono
.- Returns:
- A
InviteCreateMono
where, upon successful completion, emits the createdExtendedInvite
. If an error is received, it is emitted through theInviteCreateMono
.
-
createInvite
Mono<ExtendedInvite> createInvite(discord4j.core.spec.InviteCreateSpec spec)
Requests to create an invite.- Parameters:
spec
- an immutable object that specifies how to create the invite- Returns:
- A
Mono
where, upon successful completion, emits the createdExtendedInvite
. If an error is received, it is emitted through theMono
.
-
getInvites
Flux<ExtendedInvite> getInvites()
Requests to retrieve this channel's invites.
-
-