Guild Parameters¶
Note
The following classes come from the scurrypy.params.guild module.
EditGuildParams
¶
Bases: TypedDict
Represents fields for editing a guild.
name: str
instance-attribute
¶
Guild name.
afk_channel_id: int
instance-attribute
¶
Channel ID for AFK channel.
icon: ImageDataPart
instance-attribute
¶
Data URI scheme for guild icon.
Note
Can be animated if guild has ANIMATED_ICON feature.
splash: ImageDataPart
instance-attribute
¶
Data URI scheme for guild splash if guild has INVITE_SPLASH feature.
discovery_splash: ImageDataPart
instance-attribute
¶
Data URI scheme for guild discovery if guild has DISCOVERABLE feature.
banner: ImageDataPart
instance-attribute
¶
Data URI scheme for guild banner if guild has BANNER feature.
Note
Can be animated if guild has ANIMATED_BANNER feature.
system_channel_id: int
instance-attribute
¶
Channel ID for receiving guild notices (e.g., boosts, user join).
rules_channel_id: int
instance-attribute
¶
Channel ID for where guilds display rules.
public_updates_channel_id: int
instance-attribute
¶
Channel ID for receiving notices from Discord.
features: list[str]
instance-attribute
¶
Enabled guild features. See GuildFeatures.
description: str
instance-attribute
¶
Description for the guild.
premium_progress_bar_enabled: bool
instance-attribute
¶
Whether the guild's boost progress bar should be shown.
safety_alerts_channel_id: int
instance-attribute
¶
Channel ID for receiving safety alerts from Discord.
EditGuildRoleParams
¶
Bases: TypedDict
Represents fields for editing a guild role.
name: Optional[str]
instance-attribute
¶
Name of the role.
colors: Optional[GuildRoleColorsPart]
instance-attribute
¶
Colors of the role.
hoist: Optional[bool]
instance-attribute
¶
Whether the role is displayed separately on the sidebar.
icon: Optional[ImageDataPart]
instance-attribute
¶
Icon of the role (if guild has ROLE_ICONS feature).
permissions: int
instance-attribute
¶
Permission bit set. [INT_LIMIT]
unicode_emoji: Optional[str]
instance-attribute
¶
Unicode emoji of the role (if guilde has ROLE_ICONS feature).
mentionable: Optional[bool]
instance-attribute
¶
Whether the role should be mentionable.
EditGuildWelcomeScreenParams
¶
Bases: TypedDict
Represents fields for editing a guild welcome screen.
EditOnboardingParams
¶
Bases: TypedDict
Represents fields for editing a guild onboarding flow.
prompts: list[OnboardingPromptPart]
instance-attribute
¶
Prompts shown during onboarding.
default_channel_ids: list[int]
instance-attribute
¶
Channel IDs that members get opted into automatically.
enabled: bool
instance-attribute
¶
Whether onboarding is enabled in the guild.
mode: int
instance-attribute
¶
Current mode of onboarding. See OnboardingModes.