Stage Instances¶
This section documents everything related to stage instances, which contain information about currently live stages.
Discord Models¶
StageInstance¶
- class disnake.StageInstance[source]¶
Represents a stage instance of a stage channel in a guild.
New in version 2.0.
- x == y
Checks if two stage instances are equal.
- x != y
Checks if two stage instances are not equal.
- hash(x)
Returns the stage instance’s hash.
- privacy_level¶
The privacy level of the stage instance.
- Type:
- guild_scheduled_event_id¶
The ID of the stage instance’s associated scheduled event, if applicable. See also
guild_scheduled_event
.- Type:
Optional[
int
]
- property created_at[source]¶
Returns the stage instance’s creation time in UTC.
New in version 2.10.
- Type:
- channel¶
The channel that stage instance is running in.
- Type:
Optional[
StageChannel
]
- property discoverable_disabled[source]¶
Whether discoverability for the stage instance is disabled.
Deprecated since version 2.5: Stages can no longer be discoverable.
- Type:
- is_public()[source]¶
Whether the stage instance is public.
Deprecated since version 2.5: Stages can no longer be public.
- Return type:
- property guild_scheduled_event[source]¶
The stage instance’s scheduled event.
This is only set if this stage instance has an associated scheduled event, and requires that event to be cached (which requires the
guild_scheduled_events
intent).- Type:
Optional[
GuildScheduledEvent
]
- await edit(*, topic=..., privacy_level=..., reason=None)[source]¶
This function is a coroutine.
Edits the stage instance.
You must have the
manage_channels
permission to use this.Changed in version 2.6: Raises
TypeError
instead ofInvalidArgument
.- Parameters:
topic (
str
) – The stage instance’s new topic.privacy_level (
StagePrivacyLevel
) – The stage instance’s new privacy level.reason (Optional[
str
]) – The reason the stage instance was edited. Shows up on the audit log.
- Raises:
TypeError – If the
privacy_level
parameter is not the proper type.Forbidden – You do not have permissions to edit the stage instance.
HTTPException – Editing a stage instance failed.
- await delete(*, reason=None)[source]¶
This function is a coroutine.
Deletes the stage instance.
You must have the
manage_channels
permission to use this.- Parameters:
reason (Optional[
str
]) – The reason the stage instance was deleted. Shows up on the audit log.- Raises:
Forbidden – You do not have permissions to delete the stage instance.
HTTPException – Deleting the stage instance failed.
Enumerations¶
StagePrivacyLevel¶
- class disnake.StagePrivacyLevel[source]¶
Represents a stage instance’s privacy level.
New in version 2.0.
- public¶
The stage instance can be joined by external users.
Deprecated since version 2.5: Public stages are no longer supported by discord.
- closed¶
The stage instance can only be joined by members of the guild.