Package com.mewna.catnip.entity.channel

Interface TextChannel

All Superinterfaces:

Channel, Entity, GuildChannel, GuildEntity, HasGuild, HasName, HasParentChannel, Mentionable, MessageChannel, Snowflake, Timestamped

All Known Subinterfaces:

NewsChannel, StageChannel, ThreadChannel, VoiceChannel

All Known Implementing Classes:

NewsChannelImpl, StageChannelImpl, TextChannelImpl, ThreadChannelImpl, VoiceChannelImpl

public interface TextChannel
extends GuildChannel, MessageChannel, Mentionable

A channel in a guild that can have text messages sent in it.

Since:

9/12/18

Author:

natanbc

Nested Class Summary

Nested classes/interfaces inherited from interface com.mewna.catnip.entity.channel.Channel

Channel.ChannelType

Nested classes/interfaces inherited from interface com.mewna.catnip.entity.channel.GuildChannel

GuildChannel.ChannelEditFields

Nested classes/interfaces inherited from interface com.mewna.catnip.entity.partials.Timestamped

Timestamped.TimestampStyle

Method Summary

Modifier and Type	Method	Description
default String	asMention()
default io.reactivex.rxjava3.core.Observable<Webhook>	fetchWebhooks()	Fetch all webhooks on this channel.
default boolean	isCategory()
default boolean	isNews()	Whether or not this channel is a news channel.
default boolean	isText()
default boolean	isVoice()
boolean	nsfw()
int	rateLimitPerUser()	The slowmode set on this channel.
String	topic()	The channel's topic.

Methods inherited from interface com.mewna.catnip.entity.channel.Channel

asCategory, asDMChannel, asGroupDMChannel, asGuildChannel, asMessageChannel, asTextChannel, asUserDMChannel, asVoiceChannel, delete, isGuildMessageChannel, isStore, type

Methods inherited from interface com.mewna.catnip.entity.Entity

catnip, serialize

Methods inherited from interface com.mewna.catnip.entity.channel.GuildChannel

createInvite, createInvite, createInvite, delete, edit, fetchInvites, isDM, isGroupDM, isGuild, isUserDM, overrides, position

Methods inherited from interface com.mewna.catnip.entity.partials.GuildEntity

guild

Methods inherited from interface com.mewna.catnip.entity.partials.HasGuild

guildId, guildIdAsLong

Methods inherited from interface com.mewna.catnip.entity.partials.HasName

name

Methods inherited from interface com.mewna.catnip.entity.partials.HasParentChannel

parentId, parentIdAsLong

Methods inherited from interface com.mewna.catnip.entity.channel.MessageChannel

addReaction, addReaction, bulkRemoveReaction, deleteMessage, deleteMessage, deleteOwnReaction, deleteOwnReaction, deleteUserReaction, deleteUserReaction, editMessage, editMessage, editMessage, fetchMessage, fetchMessages, sendMessage, sendMessage, sendMessage, sendMessage, triggerTypingIndicator

Methods inherited from interface com.mewna.catnip.entity.partials.Snowflake

creationTime, creationTimestamp, id, idAsLong

Methods inherited from interface com.mewna.catnip.entity.partials.Timestamped

asDiscordTimestamp, parseTimestamp

Method Details

topic

@Nullable
@CheckReturnValue
String topic()

The channel's topic. Shown at the top of the channel. May be null.

Returns:

The channel's topic.

nsfw

@CheckReturnValue
boolean nsfw()

Returns:

Whether or not this channel has been marked as nsfw.

rateLimitPerUser

@Nonnegative
@CheckReturnValue
int rateLimitPerUser()

The slowmode set on this channel. A value of 0 means no slowmode. Bots are not affected by slowmode.

Returns:

The slowmode set on this channel, in seconds.

isText

@CheckReturnValue
default boolean isText()

Specified by:

isText in interface Channel

Returns:

Whether or not this channel is a text channel.

isNews

@CheckReturnValue
default boolean isNews()

Description copied from interface: Channel

Whether or not this channel is a news channel. See discordapp/discord-api-docs#881.

Specified by:

isNews in interface Channel

isVoice

@CheckReturnValue
default boolean isVoice()

Specified by:

isVoice in interface Channel

Returns:

Whether or not this channel is a voice channel.

isCategory

@CheckReturnValue
default boolean isCategory()

Specified by:

isCategory in interface Channel

Returns:

Whether or not this channel is a category.

fetchWebhooks

@Nonnull
@CheckReturnValue
default io.reactivex.rxjava3.core.Observable<Webhook> fetchWebhooks()

Fetch all webhooks on this channel.

Returns:

A not-null, possibly-empty list of webhooks for this channel.

asMention

@Nonnull
@CheckReturnValue
default String asMention()

Specified by:

asMention in interface Mentionable

Returns:

A mention for this channel that can be sent in a message.