kord-rest/dev.kord.rest.service/ChannelService

ChannelService

class ChannelService(requestHandler: RequestHandler) : RestService(source)

Constructors

ChannelService

constructor(requestHandler: RequestHandler)

Functions

addPinnedMessage

suspend fun addPinnedMessage(channelId: Snowflake, messageId: Snowflake, reason: String? = null)

addToGroup

suspend fun addToGroup(channelId: Snowflake, userId: Snowflake, addUser: UserAddDMRequest)

addUserToThread

suspend fun addUserToThread(channelId: Snowflake, userId: Snowflake)

bulkDelete

suspend fun bulkDelete(channelId: Snowflake, messages: BulkDeleteRequest, reason: String? = null)

createInvite

inline suspend fun createInvite(channelId: Snowflake, builder: InviteCreateBuilder.() -> Unit = {}): DiscordInviteWithMetadata

createMessage

suspend fun createMessage(channelId: Snowflake, multipartRequest: MultipartMessageCreateRequest): DiscordMessage

inline suspend fun createMessage(channelId: Snowflake, builder: UserMessageCreateBuilder.() -> Unit): DiscordMessage

createReaction

suspend fun createReaction(channelId: Snowflake, messageId: Snowflake, emoji: String)

crossPost

suspend fun crossPost(channelId: Snowflake, messageId: Snowflake): DiscordMessage

deleteAllReactions

suspend fun deleteAllReactions(channelId: Snowflake, messageId: Snowflake)

deleteAllReactionsForEmoji

suspend fun deleteAllReactionsForEmoji(channelId: Snowflake, messageId: Snowflake, emoji: String)

deleteChannel

suspend fun deleteChannel(channelId: Snowflake, reason: String? = null): DiscordChannel

deleteChannelPermission

suspend fun deleteChannelPermission(channelId: Snowflake, overwriteId: Snowflake, reason: String? = null)

deleteMessage

suspend fun deleteMessage(channelId: Snowflake, messageId: Snowflake, reason: String? = null)

deleteOwnReaction

suspend fun deleteOwnReaction(channelId: Snowflake, messageId: Snowflake, emoji: String)

deletePinnedMessage

suspend fun deletePinnedMessage(channelId: Snowflake, messageId: Snowflake, reason: String? = null)

deleteReaction

suspend fun deleteReaction(channelId: Snowflake, messageId: Snowflake, userId: Snowflake, emoji: String)

editChannelPermissions

suspend fun editChannelPermissions(channelId: Snowflake, overwriteId: Snowflake, permissions: ChannelPermissionEditRequest, reason: String? = null)

editMemberPermissions

inline suspend fun ChannelService.editMemberPermissions(channelId: Snowflake, memberId: Snowflake, builder: ChannelPermissionModifyBuilder.() -> Unit)

editMessage

suspend fun editMessage(channelId: Snowflake, messageId: Snowflake, request: MessageEditPatchRequest): DiscordMessage

suspend fun editMessage(channelId: Snowflake, messageId: Snowflake, request: MultipartMessagePatchRequest): DiscordMessage

suspend fun editMessage(channelId: Snowflake, messageId: Snowflake, request: MultipartWebhookEditMessageRequest): DiscordMessage

inline suspend fun editMessage(channelId: Snowflake, messageId: Snowflake, builder: UserMessageModifyBuilder.() -> Unit): DiscordMessage

editRolePermission

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

followNewsChannel

suspend fun followNewsChannel(channelId: Snowflake, request: ChannelFollowRequest): FollowedChannelResponse

getChannel

suspend fun getChannel(channelId: Snowflake): DiscordChannel

getChannelInvites

suspend fun getChannelInvites(channelId: Snowflake): List<DiscordInviteWithMetadata>

getChannelPins

suspend fun getChannelPins(channelId: Snowflake): List<DiscordMessage>

getMessage

suspend fun getMessage(channelId: Snowflake, messageId: Snowflake): DiscordMessage

getMessages

suspend fun getMessages(channelId: Snowflake, position: Position? = null, limit: Int? = null): List<DiscordMessage>

getReactions

suspend fun getReactions(channelId: Snowflake, messageId: Snowflake, emoji: String, after: Position.After? = null, limit: Int? = null): List<DiscordUser>

joinThread

suspend fun joinThread(channelId: Snowflake)

leaveThread

suspend fun leaveThread(channelId: Snowflake)

listJoinedPrivateArchivedThreads

suspend fun listJoinedPrivateArchivedThreads(channelId: Snowflake, request: ListThreadsBySnowflakeRequest): ListThreadsResponse

listPrivateArchivedThreads

suspend fun listPrivateArchivedThreads(channelId: Snowflake, request: ListThreadsByTimestampRequest): ListThreadsResponse

listPublicArchivedThreads

suspend fun listPublicArchivedThreads(channelId: Snowflake, request: ListThreadsByTimestampRequest): ListThreadsResponse

listThreadMembers

suspend fun listThreadMembers(channelId: Snowflake): List<DiscordThreadMember>

patchCategory

inline suspend fun ChannelService.patchCategory(channelId: Snowflake, builder: CategoryModifyBuilder.() -> Unit): DiscordChannel

patchChannel

suspend fun patchChannel(channelId: Snowflake, channel: ChannelModifyPatchRequest, reason: String? = null): DiscordChannel

patchForumChannel

inline suspend fun ChannelService.patchForumChannel(channelId: Snowflake, builder: ForumChannelModifyBuilder.() -> Unit): DiscordChannel

patchMediaChannel

inline suspend fun ChannelService.patchMediaChannel(channelId: Snowflake, builder: MediaChannelModifyBuilder.() -> Unit): DiscordChannel

patchNewsChannel

inline suspend fun ChannelService.patchNewsChannel(channelId: Snowflake, builder: NewsChannelModifyBuilder.() -> Unit): DiscordChannel

patchStageVoiceChannel

inline suspend fun ChannelService.patchStageVoiceChannel(channelId: Snowflake, builder: StageVoiceChannelModifyBuilder.() -> Unit): DiscordChannel

patchTextChannel

inline suspend fun ChannelService.patchTextChannel(channelId: Snowflake, builder: TextChannelModifyBuilder.() -> Unit): DiscordChannel

patchThread

suspend fun patchThread(threadId: Snowflake, thread: ChannelModifyPatchRequest, reason: String? = null): DiscordChannel

patchVoiceChannel

inline suspend fun ChannelService.patchVoiceChannel(channelId: Snowflake, builder: VoiceChannelModifyBuilder.() -> Unit): DiscordChannel

putChannel

suspend fun putChannel(channelId: Snowflake, channel: ChannelModifyPutRequest, reason: String? = null): DiscordChannel

removeFromGroup

suspend fun removeFromGroup(channelId: Snowflake, userId: Snowflake)

removeUserFromThread

suspend fun removeUserFromThread(channelId: Snowflake, userId: Snowflake)

startForumThread

suspend fun startForumThread(channelId: Snowflake, name: String, builder: StartForumThreadBuilder.() -> Unit = {}): DiscordChannel

startThread

suspend fun startThread(channelId: Snowflake, multipartRequest: MultipartStartThreadRequest, reason: String? = null): DiscordChannel

suspend fun startThread(channelId: Snowflake, request: StartThreadRequest, reason: String? = null): DiscordChannel

suspend fun startThread(channelId: Snowflake, name: String, archiveDuration: ArchiveDuration, type: ChannelType, builder: StartThreadBuilder.() -> Unit = {}): DiscordChannel

startThreadWithMessage

suspend fun startThreadWithMessage(channelId: Snowflake, messageId: Snowflake, request: StartThreadRequest, reason: String? = null): DiscordChannel

suspend fun startThreadWithMessage(channelId: Snowflake, messageId: Snowflake, name: String, archiveDuration: ArchiveDuration, builder: StartThreadWithMessageBuilder.() -> Unit): DiscordChannel

triggerTypingIndicator

suspend fun triggerTypingIndicator(channelId: Snowflake)