kord-rest/dev.kord.rest.service/GuildService

GuildService

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

Constructors

Link copied to clipboard
constructor(requestHandler: RequestHandler)

Functions

Link copied to clipboard
inline suspend fun addGuildBan(guildId: Snowflake, userId: Snowflake, builder: BanCreateBuilder.() -> Unit)
Link copied to clipboard
suspend fun addGuildMember(guildId: Snowflake, userId: Snowflake, token: String, builder: MemberAddBuilder.() -> Unit)
Link copied to clipboard
suspend fun addRoleToGuildMember(guildId: Snowflake, userId: Snowflake, roleId: Snowflake, reason: String? = null)
Link copied to clipboard
suspend fun beginGuildPrune(guildId: Snowflake, days: Int = 7, computePruneCount: Boolean = true, reason: String? = null): PruneResponse
Link copied to clipboard
inline suspend fun GuildService.createCategory(guildId: Snowflake, name: String, builder: CategoryCreateBuilder.() -> Unit): DiscordChannel
Link copied to clipboard
inline suspend fun GuildService.createForumChannel(guildId: Snowflake, name: String, builder: ForumChannelCreateBuilder.() -> Unit): DiscordChannel
Link copied to clipboard
inline suspend fun createGuild(name: String, builder: GuildCreateBuilder.() -> Unit): DiscordGuild
Link copied to clipboard
suspend fun createGuildChannel(guildId: Snowflake, channel: GuildChannelCreateRequest, reason: String? = null): DiscordChannel
Link copied to clipboard
suspend fun createGuildIntegration(guildId: Snowflake, integration: GuildIntegrationCreateRequest)
Link copied to clipboard
inline suspend fun createGuildRole(guildId: Snowflake, builder: RoleCreateBuilder.() -> Unit = {}): DiscordRole
Link copied to clipboard
inline suspend fun GuildService.createNewsChannel(guildId: Snowflake, name: String, builder: NewsChannelCreateBuilder.() -> Unit): DiscordChannel
Link copied to clipboard
suspend fun createScheduledEvent(guildId: Snowflake, request: GuildScheduledEventCreateRequest, reason: String? = null): DiscordGuildScheduledEvent
Link copied to clipboard
inline suspend fun GuildService.createScheduledEvent(guildId: Snowflake, name: String, privacyLevel: GuildScheduledEventPrivacyLevel, scheduledStartTime: Instant, entityType: ScheduledEntityType, builder: ScheduledEventCreateBuilder.() -> Unit = {}): DiscordGuildScheduledEvent
Link copied to clipboard
inline suspend fun GuildService.createTextChannel(guildId: Snowflake, name: String, builder: TextChannelCreateBuilder.() -> Unit): DiscordChannel
Link copied to clipboard
inline suspend fun GuildService.createVoiceChannel(guildId: Snowflake, name: String, builder: VoiceChannelCreateBuilder.() -> Unit): DiscordChannel
Link copied to clipboard
suspend fun deleteGuild(guildId: Snowflake)
Link copied to clipboard
suspend fun deleteGuildBan(guildId: Snowflake, userId: Snowflake, reason: String? = null)
Link copied to clipboard
suspend fun deleteGuildIntegration(guildId: Snowflake, integrationId: Snowflake, reason: String? = null)
Link copied to clipboard
suspend fun deleteGuildMember(guildId: Snowflake, userId: Snowflake, reason: String? = null)
Link copied to clipboard
suspend fun deleteGuildRole(guildId: Snowflake, roleId: Snowflake, reason: String? = null)
Link copied to clipboard
suspend fun deleteRoleFromGuildMember(guildId: Snowflake, userId: Snowflake, roleId: Snowflake, reason: String? = null)
Link copied to clipboard
suspend fun deleteScheduledEvent(guildId: Snowflake, eventId: Snowflake)
Link copied to clipboard
suspend fun getGuild(guildId: Snowflake, withCounts: Boolean = false): DiscordGuild
Link copied to clipboard
suspend fun getGuildBan(guildId: Snowflake, userId: Snowflake): BanResponse
Link copied to clipboard
suspend fun getGuildBans(guildId: Snowflake, position: Position.BeforeOrAfter? = null, limit: Int? = null): List<BanResponse>
Link copied to clipboard
suspend fun getGuildChannels(guildId: Snowflake): List<DiscordChannel>
Link copied to clipboard
suspend fun getGuildIntegrations(guildId: Snowflake): List<DiscordIntegration>
Link copied to clipboard
suspend fun getGuildInvites(guildId: Snowflake): List<DiscordInviteWithMetadata>
Link copied to clipboard
suspend fun getGuildMember(guildId: Snowflake, userId: Snowflake): DiscordGuildMember
Link copied to clipboard
suspend fun getGuildMembers(guildId: Snowflake, after: Position.After? = null, limit: Int? = null): List<DiscordGuildMember>

@KordExperimental
suspend fun getGuildMembers(guildId: Snowflake, query: String, limit: Int? = null): List<DiscordGuildMember>

Requests members with a username or nickname starting with query.

Link copied to clipboard
suspend fun getGuildOnboarding(guildId: Snowflake): DiscordGuildOnboarding

Returns the onboarding object for the guildId.

Link copied to clipboard
suspend fun getGuildPreview(guildId: Snowflake): DiscordGuildPreview

Returns the preview of this guildId.

Link copied to clipboard
suspend fun getGuildPruneCount(guildId: Snowflake, days: Int = 7): GetPruneResponse
Link copied to clipboard
suspend fun getGuildRoles(guildId: Snowflake): List<DiscordRole>
Link copied to clipboard
suspend fun getGuildVoiceRegions(guildId: Snowflake): List<DiscordVoiceRegion>
Link copied to clipboard
suspend fun getGuildWelcomeScreen(guildId: Snowflake): DiscordWelcomeScreen
Link copied to clipboard
suspend fun getGuildWidget(guildId: Snowflake): DiscordGuildWidget
Link copied to clipboard
suspend fun getScheduledEvent(guildId: Snowflake, eventId: Snowflake): DiscordGuildScheduledEvent
Link copied to clipboard
suspend fun getScheduledEventUsers(guildId: Snowflake, eventId: Snowflake, position: Position.BeforeOrAfter? = null, withMember: Boolean? = null, limit: Int? = null): List<GuildScheduledEventUsersResponse>
Link copied to clipboard
suspend fun getScheduledEventUsersAfter(guildId: Snowflake, eventId: Snowflake, after: Snowflake, withMember: Boolean? = null, limit: Int? = null): List<GuildScheduledEventUsersResponse>
Link copied to clipboard
suspend fun getScheduledEventUsersBefore(guildId: Snowflake, eventId: Snowflake, before: Snowflake, withMember: Boolean? = null, limit: Int? = null): List<GuildScheduledEventUsersResponse>
Link copied to clipboard
suspend fun getVanityInvite(guildId: Snowflake): DiscordPartialInvite
Link copied to clipboard
suspend fun listActiveThreads(guildId: Snowflake): ListThreadsResponse
Link copied to clipboard
suspend fun listScheduledEvents(guildId: Snowflake, withUserCount: Boolean? = null): List<DiscordGuildScheduledEvent>
Link copied to clipboard
Link copied to clipboard
suspend fun modifyCurrentVoiceState(guildId: Snowflake, request: CurrentVoiceStateModifyRequest)
Link copied to clipboard
inline suspend fun GuildService.modifyCurrentVoiceState(guildId: Snowflake, builder: CurrentVoiceStateModifyBuilder.() -> Unit)
Link copied to clipboard
inline suspend fun modifyGuild(guildId: Snowflake, builder: GuildModifyBuilder.() -> Unit): DiscordGuild
Link copied to clipboard
inline suspend fun modifyGuildChannelPosition(guildId: Snowflake, builder: GuildChannelPositionModifyBuilder.() -> Unit)
Link copied to clipboard
inline suspend fun modifyGuildIntegration(guildId: Snowflake, integrationId: Snowflake, builder: IntegrationModifyBuilder.() -> Unit)
Link copied to clipboard
inline suspend fun modifyGuildMember(guildId: Snowflake, userId: Snowflake, builder: MemberModifyBuilder.() -> Unit): DiscordGuildMember
Link copied to clipboard
suspend fun modifyGuildMFALevel(guildId: Snowflake, level: MFALevel, reason: String? = null): GuildMFALevelModifyResponse
Link copied to clipboard
inline suspend fun modifyGuildRole(guildId: Snowflake, roleId: Snowflake, builder: RoleModifyBuilder.() -> Unit): DiscordRole
Link copied to clipboard
inline suspend fun modifyGuildRolePosition(guildId: Snowflake, builder: RolePositionsModifyBuilder.() -> Unit): List<DiscordRole>
Link copied to clipboard
suspend fun modifyGuildWelcomeScreen(guildId: Snowflake, request: GuildWelcomeScreenModifyRequest, reason: String? = null): DiscordWelcomeScreen
Link copied to clipboard
inline suspend fun GuildService.modifyGuildWelcomeScreen(guildId: Snowflake, builder: WelcomeScreenModifyBuilder.() -> Unit): DiscordWelcomeScreen
Link copied to clipboard
inline suspend fun modifyGuildWidget(guildId: Snowflake, builder: GuildWidgetModifyBuilder.() -> Unit): DiscordGuildWidget
suspend fun modifyGuildWidget(guildId: Snowflake, widget: GuildWidgetModifyRequest, reason: String? = null): DiscordGuildWidget
Link copied to clipboard
suspend fun modifyScheduledEvent(guildId: Snowflake, eventId: Snowflake, request: ScheduledEventModifyRequest, reason: String? = null): DiscordGuildScheduledEvent
Link copied to clipboard
inline suspend fun GuildService.modifyScheduledEvent(guildId: Snowflake, eventId: Snowflake, builder: ScheduledEventModifyBuilder.() -> Unit): DiscordGuildScheduledEvent
Link copied to clipboard
suspend fun modifyVoiceState(guildId: Snowflake, userId: Snowflake, request: VoiceStateModifyRequest)
Link copied to clipboard
inline suspend fun GuildService.modifyVoiceState(guildId: Snowflake, channelId: Snowflake, userId: Snowflake, builder: VoiceStateModifyBuilder.() -> Unit)
Link copied to clipboard
suspend fun syncGuildIntegration(guildId: Snowflake, integrationId: Snowflake)