Package discord4j.core.object.entity.channel

Interface CategorizableChannel

All Superinterfaces:

Channel, DiscordObject, Entity, GuildChannel

All Known Subinterfaces:

GuildMessageChannel

All Known Implementing Classes:

NewsChannel, StoreChannel, TextChannel, VoiceChannel

public interface CategorizableChannel
extends GuildChannel

A Discord channel which can be categorized into a Category. 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

Modifier and Type	Method	Description
Mono<ExtendedInvite>	createInvite(Consumer<? super InviteCreateSpec> spec)	Requests to create an invite.
Mono<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.Entity

getId

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

addMemberOverwrite, addMemberOverwrite, addRoleOverwrite, addRoleOverwrite, getEffectivePermissions, getGuild, getGuild, getGuildId, getName, 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.

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

Mono<Category> getCategory(EntityRetrievalStrategy retrievalStrategy)

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

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

Mono<ExtendedInvite> createInvite(Consumer<? super InviteCreateSpec> spec)

Requests to create an invite.

Parameters:

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

Returns:

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

getInvites

Flux<ExtendedInvite> getInvites()

Requests to retrieve this channel's invites.

Returns:

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