Stage Instances

This section documents evewything wewated to stage instances, which contain infowmation about cuwwentwy wive stages.

Discowd Modews

StageInstance

Attwibutes
M-Methods
class disnake.StageInstance[source]

Wepwesents a stage instance of a stage channyew in a guiwd.

Nyew in vewsion 2.0.

x == y

Checks if two stage instances awe equaw.

x != y

Checks if two stage instances awe nyot equaw.

hash(x)

Wetuwns the stage instance’s hash.

id

The stage i-i-instance’s ID.

Type:

int

guild

The guiwd that the stage instance is wunnying in.

Type:

Guild

channel_id

T-T-The ID o-o-of t-t-the channyew that the stage instance is w-w-wunnying in.

Type:

int

topic

The topic of the stage instance.

Type:

str

privacy_level

The pwivacy wevew of the stage instance.

Type:

StagePrivacyLevel

guild_scheduled_event_id

The ID of the stage instance’s associated s-scheduwed event, if appwicabwe. See awso guild_scheduled_event.

Type:

Optionyaw[int]

property created_at[source]

Wetuwns the stage instance’s c-c-cweation time in UTC.

Nyew in vewsion 2.10.

Type:

datetime.datetime

channel

The channyew that stage instance is wunnying in.

Type:

Optionyaw[StageChannel]

property discoverable_disabled[source]

Whethew d-discuvwabiwity fow the stage instance is disabwed.

Depwecated since vewsion 2.5: Stages c-c-can nyo wongew be discuvwabwe.

Type:

bool

is_public()[source]

Whethew the stage instance is pubwic.

Depwecated since vewsion 2.5: Stages can nyo wongew be pubwic.

Wetuwn type:

bool

property guild_scheduled_event[source]

T-The stage instance’s scheduwed event.

This is o-o-onwy set i-if this stage instance has an associated scheduwed event, and wequiwes that event to be c-c-cached (which wequiwes the guild_scheduled_events intent).

Type:

Optionyaw[GuildScheduledEvent]

await edit(*, topic=..., privacy_level=..., reason=None)[source]

This function is a cowoutinye.

Edits t-the stage instance.

You must have the manage_channels pewmission t-t-to use t-t-this.

Changed in vewsion 2.6: Waises TypeError instead of InvalidArgument.

Pawametews:

  • topic (str) – The stage instance’s nyew topic.

  • pwivacy_wevew (StagePrivacyLevel) – The stage instance’s nyew pwivacy wevew.

  • weason (Optionyaw[str]) – The weason the stage instance was edited. Shows up on the audit wog.

Waises:

  • TypeEwwow – If the privacy_level pawametew is nyot the pwopew type.

  • Fowbidden – You do nyot have p-p-pewmissions to edit the stage instance.

  • HTTPException – Editing a stage instance faiwed.

await delete(*, reason=None)[source]

This function is a cowoutinye.

D-D-Dewetes the stage instance.

You must have the manage_channels pewmission to use this.

Pawametews:

weason (Optionyaw[str]) – The weason the stage i-i-instance was deweted. Shows up on the audit wog.

Waises:

  • Fowbidden – You do nyot have pewmissions to dewete the stage instance.

  • HTTPException – Deweting the stage instance faiwed.

Enyumewations

StagePwivacyWevew

class disnake.StagePrivacyLevel[source]

Wepwesents a stage instance’s pwivacy wevew.

Nyew in vewsion 2.0.

public

The stage instance can be joinyed by extewnyaw usews.

Depwecated since vewsion 2.5: Pubwic stages awe nyo wongew suppowted by discowd.

closed

The s-stage instance can onwy be joinyed by membews of the guiwd.

guild_only

Awias fow closed

Events