implicit final class GuildSyntax extends AnyVal
- Source
- syntax.scala
- Alphabetic
- By Inheritance
- GuildSyntax
- AnyVal
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- Any
- final def ##: Int
- Definition Classes
- Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- Any
- def addGuildMember(userId: UserId, accessToken: String, nick: Option[String] = None, roles: Option[Seq[RoleId]] = None, mute: Option[Boolean] = None, deaf: Option[Boolean] = None): AddGuildMember
Add a guild member to this guild.
Add a guild member to this guild. Requires the
guilds.joinOAuth2 scope.- accessToken
The OAuth2 access token.
- nick
The nickname to give to the user.
- roles
The roles to give to the user.
- mute
If the user should be muted.
- deaf
If the user should be deafened.
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def beginPrune(days: Int, computePruneCount: Boolean = guild match {
case gatewayGuild: GatewayGuild => gatewayGuild.memberCount < 1000
case _ => false
}, includeRoles: Seq[RoleId] = Nil): BeginGuildPrune
Begin a prune.
Begin a prune.
- days
The number of days to prune for.
- def createCategory(name: String, permissionOverwrites: util.JsonOption[Seq[PermissionOverwrite]] = JsonUndefined, nsfw: util.JsonOption[Boolean] = JsonUndefined): CreateGuildChannel
Create a category in this guild.
Create a category in this guild.
- name
The name of the channel.
- permissionOverwrites
The permission overwrites for the channel.
- nsfw
If the channel is NSFW.
- def createRole(name: Option[String] = None, permissions: Option[Permission] = None, color: Option[Int] = None, hoist: Option[Boolean] = None, icon: Option[ImageData] = None, unicodeEmoji: Option[String] = None, mentionable: Option[Boolean] = None): CreateGuildRole
Create a new role.
Create a new role.
- name
The name of the role.
- permissions
The permissions this role has.
- color
The color of the role.
- hoist
If this role is shown in the right sidebar.
- mentionable
If this role is mentionable.
- def createTextChannel(name: String, topic: util.JsonOption[String] = JsonUndefined, rateLimitPerUser: util.JsonOption[Int] = JsonUndefined, permissionOverwrites: util.JsonOption[Seq[PermissionOverwrite]] = JsonUndefined, category: util.JsonOption[SnowflakeType[GuildCategory]] = JsonUndefined, nsfw: util.JsonOption[Boolean] = JsonUndefined): CreateGuildChannel
Create a text channel in this guild.
Create a text channel in this guild.
- name
The name of the channel.
- topic
The topic to give this channel.
- rateLimitPerUser
The user ratelimit to give this channel.
- permissionOverwrites
The permission overwrites for the channel.
- category
The category id for the channel.
- nsfw
If the channel is NSFW.
- def createVoiceChannel(name: String, bitrate: util.JsonOption[Int] = JsonUndefined, userLimit: util.JsonOption[Int] = JsonUndefined, permissionOverwrites: util.JsonOption[Seq[PermissionOverwrite]] = JsonUndefined, category: util.JsonOption[SnowflakeType[GuildCategory]] = JsonUndefined, nsfw: util.JsonOption[Boolean] = JsonUndefined): CreateGuildChannel
Create a voice channel in this guild.
Create a voice channel in this guild.
- name
The name of the channel.
- bitrate
The bitrate for the channel if it's a voice channel.
- userLimit
The user limit for the channel if it's a voice channel.
- permissionOverwrites
The permission overwrites for the channel.
- category
The category id for the channel.
- nsfw
If the channel is NSFW.
- def fetchAllChannels: GetGuildChannels
Fetch all channels in this guild.
- def fetchAllGuildMember(limit: Option[Int] = None, after: Option[UserId] = None): ListGuildMembers
Get all the guild members in this guild.
Get all the guild members in this guild.
- limit
The max amount of members to get.
- after
Get userIds after this id.
- def fetchBan(userId: UserId): GetGuildBan
Fetch a ban for a specific user.
- def fetchBans: GetGuildBans
Fetch all the bans for this guild.
- def fetchGuildMember(userId: UserId): GetGuildMember
Fetch a guild member by id.
- def fetchIntegrations: GetGuildIntegrations
Fetch the integrations for this guild.
- def fetchInvites: GetGuildInvites
Fetch the invites for this guild.
- def fetchPruneCount(days: Int, includeRoles: Seq[RoleId] = Nil): GetGuildPruneCount
Check how many members would be removed if a prune was started now.
Check how many members would be removed if a prune was started now.
- days
The number of days to prune for.
- def fetchRoles: GetGuildRoles
Fetch all the roles in this guild.
- def fetchSearchGuildMembers(query: String, limit: Int = 1): SearchGuildMembers
Search for guild members in the given guild, who's username or nickname starts with the query string.
Search for guild members in the given guild, who's username or nickname starts with the query string.
- query
Query to search for.
- limit
How many members to return at most.
- def fetchVoiceRegions: GetGuildVoiceRegions
Fetch the voice regions for this guild.
- def fetchWidgetSettings: GetGuildWidgetSettings
Fetch the guild embed for this guild.
- def getClass(): Class[_ <: AnyVal]
- Definition Classes
- AnyVal → Any
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def listActiveThreads: ListActiveGuildThreads
Lists all the active threads in this guild.
Lists all the active threads in this guild. Threads are ordered in descending order by their id.
- def modify(name: util.JsonOption[String] = JsonUndefined, verificationLevel: util.JsonOption[VerificationLevel] = JsonUndefined, defaultMessageNotifications: util.JsonOption[NotificationLevel] = JsonUndefined, explicitContentFilter: util.JsonOption[FilterLevel] = JsonUndefined, afkChannelId: util.JsonOption[NormalVoiceGuildChannelId] = JsonUndefined, afkTimeout: util.JsonOption[Int] = JsonUndefined, icon: util.JsonOption[ImageData] = JsonUndefined, ownerId: util.JsonOption[UserId] = JsonUndefined, splash: util.JsonOption[ImageData] = JsonUndefined, discoverySplash: util.JsonOption[ImageData] = JsonUndefined, banner: util.JsonOption[ImageData] = JsonUndefined, systemChannelId: util.JsonOption[TextGuildChannelId] = JsonUndefined, systemChannelFlags: util.JsonOption[SystemChannelFlags] = JsonUndefined, preferredLocale: util.JsonOption[String] = JsonUndefined, features: util.JsonOption[Seq[String]] = JsonUndefined, description: util.JsonOption[String] = JsonUndefined, premiumProgressBarEnabled: util.JsonOption[Boolean] = JsonUndefined): ModifyGuild
Modify this guild.
Modify this guild.
- name
The new name of the guild
- verificationLevel
The new verification level to use for the guild.
- defaultMessageNotifications
The new notification level to use for the guild.
- afkChannelId
The new afk channel of the guild.
- afkTimeout
The new afk timeout in seconds for the guild.
- icon
The new icon to use for the guild. Must be 1024x1024 png/jpeg/gif. Can be animated if the guild has the
ANIMATED_ICONfeature.- ownerId
Transfer ownership of this guild. Must be the owner.
- splash
The new splash for the guild. Must be 16:9 png/jpeg. Only available if the guild has the
INVITE_SPLASHfeature.- discoverySplash
Thew new discovery slash for the guild's discovery splash. Only available if the guild has the
DISCOVERABLEfeature.- banner
The new banner for the guild. Must be 16:9 png/jpeg. Only available if the guild has the
BANNERfeature.- systemChannelId
The new channel which system messages will be sent to.
- systemChannelFlags
The new flags for the system channel.
- preferredLocale
The new preferred locale for the guild.
- features
The new enabled features for the guild.
- description
The new description for the guild if it is discoverable.
- premiumProgressBarEnabled
If the boosting progress bar should be shown.
- def modifyChannelPositions(newPositions: Seq[ModifyGuildChannelPositionsData]): ModifyGuildChannelPositions
Modify the positions of several channels.
Modify the positions of several channels.
- newPositions
A sequence indicating the channels to move, and where
- def modifyChannelPositions(newPositions: SnowflakeMap[GuildChannel, Int]): ModifyGuildChannelPositions
Modify the positions of several channels.
Modify the positions of several channels.
- newPositions
A map between the channelId and the new positions.
- def modifyRolePositions(newPositions: SnowflakeMap[Role, Int]): ModifyGuildRolePositions
Modify the positions of several roles
Modify the positions of several roles
- newPositions
A map from the role id to their new position.
- def modifyWidgetSettings(embed: GuildWidgetSettings): ModifyGuildWidget
Modify a guild embed for this guild.
- def removeIntegration(id: IntegrationId): DeleteGuildIntegration
Delete an integration.
Delete an integration.
- id
The integration id.
- def toString(): String
- Definition Classes
- Any
- def unban(userId: UserId): RemoveGuildBan
Unban a user.
Unban a user.
- userId
The user to unban.