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

GuildService

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

Constructors

GuildService

constructor(requestHandler: RequestHandler)

Functions

addGuildBan

inline suspend fun addGuildBan(guildId: Snowflake, userId: Snowflake, builder: BanCreateBuilder.() -> Unit)

addGuildMember

suspend fun addGuildMember(guildId: Snowflake, userId: Snowflake, token: String, builder: MemberAddBuilder.() -> Unit)

addRoleToGuildMember

suspend fun addRoleToGuildMember(guildId: Snowflake, userId: Snowflake, roleId: Snowflake, reason: String? = null)

beginGuildPrune

suspend fun beginGuildPrune(guildId: Snowflake, days: Int = 7, computePruneCount: Boolean = true, reason: String? = null): PruneResponse

createCategory

inline suspend fun GuildService.createCategory(guildId: Snowflake, name: String, builder: CategoryCreateBuilder.() -> Unit): DiscordChannel

createForumChannel

inline suspend fun GuildService.createForumChannel(guildId: Snowflake, name: String, builder: ForumChannelCreateBuilder.() -> Unit): DiscordChannel

createGuild

inline suspend fun createGuild(name: String, builder: GuildCreateBuilder.() -> Unit): DiscordGuild

createGuildChannel

suspend fun createGuildChannel(guildId: Snowflake, channel: GuildChannelCreateRequest, reason: String? = null): DiscordChannel

createGuildIntegration

suspend fun createGuildIntegration(guildId: Snowflake, integration: GuildIntegrationCreateRequest)

createGuildRole

inline suspend fun createGuildRole(guildId: Snowflake, builder: RoleCreateBuilder.() -> Unit = {}): DiscordRole

createMediaChannel

inline suspend fun GuildService.createMediaChannel(guildId: Snowflake, name: String, builder: MediaChannelCreateBuilder.() -> Unit): DiscordChannel

createNewsChannel

inline suspend fun GuildService.createNewsChannel(guildId: Snowflake, name: String, builder: NewsChannelCreateBuilder.() -> Unit): DiscordChannel

createScheduledEvent

suspend fun createScheduledEvent(guildId: Snowflake, request: GuildScheduledEventCreateRequest, reason: String? = null): DiscordGuildScheduledEvent

createScheduledEvent

inline suspend fun GuildService.createScheduledEvent(guildId: Snowflake, name: String, privacyLevel: GuildScheduledEventPrivacyLevel, scheduledStartTime: Instant, entityType: ScheduledEntityType, builder: ScheduledEventCreateBuilder.() -> Unit = {}): DiscordGuildScheduledEvent

createStageChannel

inline suspend fun GuildService.createStageChannel(guildId: Snowflake, name: String, builder: StageChannelCreateBuilder.() -> Unit): DiscordChannel

createTextChannel

inline suspend fun GuildService.createTextChannel(guildId: Snowflake, name: String, builder: TextChannelCreateBuilder.() -> Unit): DiscordChannel

createVoiceChannel

inline suspend fun GuildService.createVoiceChannel(guildId: Snowflake, name: String, builder: VoiceChannelCreateBuilder.() -> Unit): DiscordChannel

deleteGuild

suspend fun deleteGuild(guildId: Snowflake)

deleteGuildBan

suspend fun deleteGuildBan(guildId: Snowflake, userId: Snowflake, reason: String? = null)

deleteGuildIntegration

suspend fun deleteGuildIntegration(guildId: Snowflake, integrationId: Snowflake, reason: String? = null)

deleteGuildMember

suspend fun deleteGuildMember(guildId: Snowflake, userId: Snowflake, reason: String? = null)

deleteGuildRole

suspend fun deleteGuildRole(guildId: Snowflake, roleId: Snowflake, reason: String? = null)

deleteRoleFromGuildMember

suspend fun deleteRoleFromGuildMember(guildId: Snowflake, userId: Snowflake, roleId: Snowflake, reason: String? = null)

deleteScheduledEvent

suspend fun deleteScheduledEvent(guildId: Snowflake, eventId: Snowflake)

getGuild

suspend fun getGuild(guildId: Snowflake, withCounts: Boolean = false): DiscordGuild

getGuildBan

suspend fun getGuildBan(guildId: Snowflake, userId: Snowflake): BanResponse

getGuildBans

suspend fun getGuildBans(guildId: Snowflake, position: Position.BeforeOrAfter? = null, limit: Int? = null): List<BanResponse>

getGuildChannels

suspend fun getGuildChannels(guildId: Snowflake): List<DiscordChannel>

getGuildIntegrations

suspend fun getGuildIntegrations(guildId: Snowflake): List<DiscordIntegration>

getGuildInvites

suspend fun getGuildInvites(guildId: Snowflake): List<DiscordInviteWithMetadata>

getGuildMember

suspend fun getGuildMember(guildId: Snowflake, userId: Snowflake): DiscordGuildMember

getGuildMembers

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.

getGuildOnboarding

suspend fun getGuildOnboarding(guildId: Snowflake): DiscordGuildOnboarding

Returns the onboarding object for the guildId.

getGuildPreview

suspend fun getGuildPreview(guildId: Snowflake): DiscordGuildPreview

Returns the preview of this guildId.

getGuildPruneCount

suspend fun getGuildPruneCount(guildId: Snowflake, days: Int = 7): GetPruneResponse

getGuildRoles

suspend fun getGuildRoles(guildId: Snowflake): List<DiscordRole>

getGuildVoiceRegions

suspend fun getGuildVoiceRegions(guildId: Snowflake): List<DiscordVoiceRegion>

getGuildWelcomeScreen

suspend fun getGuildWelcomeScreen(guildId: Snowflake): DiscordWelcomeScreen

getGuildWidget

suspend fun getGuildWidget(guildId: Snowflake): DiscordGuildWidget

getScheduledEvent

suspend fun getScheduledEvent(guildId: Snowflake, eventId: Snowflake): DiscordGuildScheduledEvent

getScheduledEventUsers

suspend fun getScheduledEventUsers(guildId: Snowflake, eventId: Snowflake, position: Position.BeforeOrAfter? = null, withMember: Boolean? = null, limit: Int? = null): List<GuildScheduledEventUsersResponse>

getScheduledEventUsersAfter

suspend fun getScheduledEventUsersAfter(guildId: Snowflake, eventId: Snowflake, after: Snowflake, withMember: Boolean? = null, limit: Int? = null): List<GuildScheduledEventUsersResponse>

getScheduledEventUsersBefore

suspend fun getScheduledEventUsersBefore(guildId: Snowflake, eventId: Snowflake, before: Snowflake, withMember: Boolean? = null, limit: Int? = null): List<GuildScheduledEventUsersResponse>

getVanityInvite

suspend fun getVanityInvite(guildId: Snowflake): DiscordPartialInvite

listActiveThreads

suspend fun listActiveThreads(guildId: Snowflake): ListThreadsResponse

listScheduledEvents

suspend fun listScheduledEvents(guildId: Snowflake, withUserCount: Boolean? = null): List<DiscordGuildScheduledEvent>

modifyCurrentUserNickname

suspend fun modifyCurrentUserNickname(guildId: Snowflake, nick: CurrentUserNicknameModifyRequest, reason: String? = null): CurrentUserNicknameModifyResponse

modifyCurrentVoiceState

suspend fun modifyCurrentVoiceState(guildId: Snowflake, request: CurrentVoiceStateModifyRequest)

modifyCurrentVoiceState

inline suspend fun GuildService.modifyCurrentVoiceState(guildId: Snowflake, builder: CurrentVoiceStateModifyBuilder.() -> Unit)

modifyGuild

inline suspend fun modifyGuild(guildId: Snowflake, builder: GuildModifyBuilder.() -> Unit): DiscordGuild

modifyGuildChannelPosition

inline suspend fun modifyGuildChannelPosition(guildId: Snowflake, builder: GuildChannelPositionModifyBuilder.() -> Unit)

modifyGuildIntegration

inline suspend fun modifyGuildIntegration(guildId: Snowflake, integrationId: Snowflake, builder: IntegrationModifyBuilder.() -> Unit)

modifyGuildMember

inline suspend fun modifyGuildMember(guildId: Snowflake, userId: Snowflake, builder: MemberModifyBuilder.() -> Unit): DiscordGuildMember

modifyGuildMFALevel

suspend fun modifyGuildMFALevel(guildId: Snowflake, level: MFALevel, reason: String? = null): GuildMFALevelModifyResponse

modifyGuildOnboarding

inline suspend fun modifyGuildOnboarding(guildId: Snowflake, builder: GuildOnboardingModifyBuilder.() -> Unit): DiscordGuildOnboarding

suspend fun modifyGuildOnboarding(guildId: Snowflake, request: GuildOnboardingModifyRequest, reason: String? = null): DiscordGuildOnboarding

modifyGuildRole

inline suspend fun modifyGuildRole(guildId: Snowflake, roleId: Snowflake, builder: RoleModifyBuilder.() -> Unit): DiscordRole

modifyGuildRolePosition

inline suspend fun modifyGuildRolePosition(guildId: Snowflake, builder: RolePositionsModifyBuilder.() -> Unit): List<DiscordRole>

modifyGuildWelcomeScreen

suspend fun modifyGuildWelcomeScreen(guildId: Snowflake, request: GuildWelcomeScreenModifyRequest, reason: String? = null): DiscordWelcomeScreen

modifyGuildWelcomeScreen

inline suspend fun GuildService.modifyGuildWelcomeScreen(guildId: Snowflake, builder: WelcomeScreenModifyBuilder.() -> Unit): DiscordWelcomeScreen

modifyGuildWidget

inline suspend fun modifyGuildWidget(guildId: Snowflake, builder: GuildWidgetModifyBuilder.() -> Unit): DiscordGuildWidget

suspend fun modifyGuildWidget(guildId: Snowflake, widget: GuildWidgetModifyRequest, reason: String? = null): DiscordGuildWidget

modifyScheduledEvent

suspend fun modifyScheduledEvent(guildId: Snowflake, eventId: Snowflake, request: ScheduledEventModifyRequest, reason: String? = null): DiscordGuildScheduledEvent

modifyScheduledEvent

inline suspend fun GuildService.modifyScheduledEvent(guildId: Snowflake, eventId: Snowflake, builder: ScheduledEventModifyBuilder.() -> Unit): DiscordGuildScheduledEvent

modifyVoiceState

suspend fun modifyVoiceState(guildId: Snowflake, userId: Snowflake, request: VoiceStateModifyRequest)

modifyVoiceState

inline suspend fun GuildService.modifyVoiceState(guildId: Snowflake, channelId: Snowflake, userId: Snowflake, builder: VoiceStateModifyBuilder.() -> Unit)

syncGuildIntegration

suspend fun syncGuildIntegration(guildId: Snowflake, integrationId: Snowflake)