kord-core/dev.kord.core.behavior.channel/NewsChannelBehavior

NewsChannelBehavior

interface NewsChannelBehavior : TopGuildMessageChannelBehavior, ThreadParentChannelBehavior(source)

The behavior of a Discord News Channel associated to a guild.

Inheritors

Properties

open override val activeThreads: Flow<NewsChannelThread>

Returns all active public and private threads in the channel. Threads are ordered by their id, in descending order.

open val guild: GuildBehavior

The guild behavior this channel is associated to.

abstract val guildId: Snowflake

The id of the guild this channel is associated to.

abstract val id: Snowflake

The unique identifier of this entity.

open val invites: Flow<InviteWithMetadata>

Requests to get the invites of this channel.

abstract val kord: Kord

The kord instance that created this object.

open val mention: String

This channel formatted as a mention as used by the Discord API.

open val messages: Flow<Message>

Requests to get all messages in this channel.

open val pinnedMessages: Flow<Message>

Requests to get the pinned messages in this channel.

abstract val supplier: EntitySupplier

The supplier used to request entities.

open val webhooks: Flow<Webhook>

Requests to get all webhooks for this channel.

Functions

open suspend fun addOverwrite(overwrite: PermissionOverwrite, reason: String? = null)

Requests to add or replace a PermissionOverwrite to this entity.

open suspend override fun asChannel(): NewsChannel

Requests to get the this behavior as a NewsChannel.

inline suspend fun <T : Channel> ChannelBehavior.asChannelOf(): T

Requests to get the Channel represented by this ChannelBehavior.

asChannelOfOrNull

inline suspend fun <T : Channel> ChannelBehavior.asChannelOfOrNull(): T?

Requests to get the Channel represented by this ChannelBehavior, returns null if the Channel isn't present.

asChannelOrNull

open suspend override fun asChannelOrNull(): NewsChannel?

Requests to get this behavior as a NewsChannel, returns null if the channel isn't present or if the channel isn't a news channel.

open suspend fun bulkDelete(messages: Iterable<Snowflake>, deleteOlderMessages: Boolean = true, reason: String? = null)

Requests to bulk delete the messages.

open operator override fun compareTo(other: Entity): Int

Compares entities on id.

inline suspend fun MessageChannelBehavior.createEmbed(block: EmbedBuilder.() -> Unit): Message

Requests to create a message with only an embed.

inline suspend fun CategorizableChannelBehavior.createInvite(builder: InviteCreateBuilder.() -> Unit = {}): InviteWithMetadata

Request to create an InviteWithMetadata for this channel.

open suspend fun createMessage(content: String): Message

Requests to create a message with only a MessageCreateBuilder.content.

inline suspend fun MessageChannelBehavior.createMessage(builder: UserMessageCreateBuilder.() -> Unit): Message

Requests to create a message configured by the builder.

inline suspend fun CategorizableChannelBehavior.createWebhook(name: String, builder: WebhookCreateBuilder.() -> Unit = {}): Webhook

Requests to create a new webhook configured by the builder.

open suspend fun delete(reason: String? = null)

Requests to delete a channel (or close it if this is a dm channel).

open suspend fun deleteMessage(id: Snowflake, reason: String? = null)

Requests to delete a message in this channel.

inline suspend fun NewsChannelBehavior.edit(builder: NewsChannelModifyBuilder.() -> Unit): NewsChannel

Requests to edit this channel.

editMemberPermission

inline suspend fun TopGuildChannelBehavior.editMemberPermission(memberId: Snowflake, builder: ChannelPermissionModifyBuilder.() -> Unit)

Requests to add or replace a PermissionOverwrite for the memberId.

editRolePermission

inline suspend fun TopGuildChannelBehavior.editRolePermission(roleId: Snowflake, builder: ChannelPermissionModifyBuilder.() -> Unit)

Requests to add or replace a PermissionOverwrite for the roleId.

open suspend override fun fetchChannel(): NewsChannel

Retrieve the NewsChannel associated with this behaviour from the provided EntitySupplier

fetchChannelOrNull

open suspend override fun fetchChannelOrNull(): NewsChannel?

Retrieve the NewsChannel associated with this behaviour from the provided EntitySupplier returns null if the NewsChannel isn't present.

open suspend fun follow(target: Snowflake)

Requests to follow this channel, publishing cross posted messages to the target channel.

open suspend fun getGuild(): Guild

Requests to get this channel's Guild.

open suspend fun getGuildOrNull(): Guild?

Requests to get this channel's Guild, returns null if the guild isn't present.

open suspend fun getMessage(messageId: Snowflake): Message

Requests to get a message with the given messageId.

getMessageOrNull

open suspend fun getMessageOrNull(messageId: Snowflake): Message?

Requests to get a message with the given messageId, returns null if the message isn't present or is not part of this channel.

getMessagesAfter

open fun getMessagesAfter(messageId: Snowflake, limit: Int? = null): Flow<Message>

Requests to get all messages in this channel that were created after messageId.

getMessagesAround

open fun getMessagesAround(messageId: Snowflake, limit: Int = 100): Flow<Message>

Requests to get Messages around (both older and newer) the messageId.

getMessagesBefore

open fun getMessagesBefore(messageId: Snowflake, limit: Int? = null): Flow<Message>

Requests to get all messages in this channel that were created before messageId.

open suspend fun getPosition(): Int

Requests to get the position of this channel in the guild, as displayed in Discord.

getPublicArchivedThreads

open override fun getPublicArchivedThreads(before: Instant?, limit: Int?): Flow<NewsChannelThread>

Returns archived threads in the channel that are public. Threads are ordered by ThreadChannel.archiveTimestamp in descending order. Requires the Read Message History Permission

startPublicThread

open suspend fun startPublicThread(name: String, builder: StartThreadBuilder.() -> Unit = {}): NewsChannelThread

startPublicThreadWithMessage

open suspend fun startPublicThreadWithMessage(messageId: Snowflake, name: String, builder: StartThreadWithMessageBuilder.() -> Unit = {}): NewsChannelThread

open suspend fun type()

Requests to trigger the typing indicator for the bot in this channel. The typing status will persist for 10 seconds or until the bot creates a message in the channel.

open suspend fun typeUntil(mark: TimeMark)

Requests to trigger the typing indicator for the bot in this channel. The typing status will persist until the mark is reached.

open suspend fun typeUntil(instant: Instant)

Requests to trigger the typing indicator for the bot in this channel. The typing status will persist until the instant is reached.

open override fun withStrategy(strategy: EntitySupplyStrategy<*>): NewsChannelBehavior

Returns a new NewsChannelBehavior with the given strategy.