yde/io.github.ydwk.yde.entities.channel/TextChannel

TextChannel

interface TextChannel : Channel, SendAble, NameAbleEntity(source)

Contains all the functions that are common to all 'text' channels (i.e. channels that can send messages).

Inheritors

Functions

Link copied to clipboard
open fun format(format: String): String

Formats the name of the entity

Link copied to clipboard
open override fun formatTo(formatter: Formatter?, flags: Int, width: Int, precision: Int)

Formats the object using the provided {@link Formatter formatter}.

Link copied to clipboard
open suspend fun send(): CompletableDeferred<Message>

Sends the message.

Link copied to clipboard
open fun setContent(message: String): SendAble

Sets the content of the message.

Link copied to clipboard
open fun setEmbed(embed: Embed): SendAble

Sets the embed of the message.

Link copied to clipboard
open fun setEmbeds(vararg embeds: Embed): SendAble
open fun setEmbeds(embeds: List<Embed>): SendAble

Sets the embeds of the message.

Link copied to clipboard
open fun setFlag(flag: MessageFlag): SendAble

Set a message flag.

Link copied to clipboard
open fun setFlags(vararg flags: MessageFlag): SendAble
open fun setFlags(flags: List<MessageFlag>): SendAble

Sets the message flags.

Link copied to clipboard
open fun setTts(tts: Boolean): SendAble

Whether the message should be sent with text-to-speech.

Properties

Link copied to clipboard
open val asIncrement: Long

The increment of this snowflake.

Link copied to clipboard
open val asProcessId: Long

The process id of this snowflake.

Link copied to clipboard
open val asTimestamp: Long

The timestamp of this snowflake. (Milliseconds since Discord Epoch, the first second of 2015 or 1420070400000.)

Link copied to clipboard
open val asWorkerId: Long

The worker id of this snowflake.

Link copied to clipboard
abstract val channelGetter: ChannelGetter

The channel getter which gives access to the channels.

Link copied to clipboard
open val id: String

The id of this snowflake as a String.

Link copied to clipboard
abstract val idAsLong: Long

The id of this snowflake as a Long.

Link copied to clipboard
abstract val isDmChannel: Boolean

Weather the channel is a dm channel.

Link copied to clipboard
abstract val isGuildChannel: Boolean

Weather the channel is a guild channel.

Link copied to clipboard
abstract val json: JsonNode

The json representation of this entity.

Link copied to clipboard
open val messageBuilder: MessageBuilder

The actual message builder instance.

Link copied to clipboard
abstract var name: String
Link copied to clipboard
abstract val type: ChannelType

Get the channel type.

Link copied to clipboard
abstract val yde: YDE

The main YDE instance.