ClientCompoundStageEndpoints

Methods

__new__()

Compound components do not support instancing.

Sub-typing is supported, but the attributes are only proxied. Sub-types have no meaning by themselves.

Raises

RuntimeError

stage_create(channel, ...)

Edits the given stage channel.

Will trigger a stage_create event.

The endpoint has a long rate limit, so please use .stage_edit to edit just the stage's topic.

This method is a coroutine.

ParameterTypeOptionalKeyword onlyDefaultDescription
channel

Channel, int

The channel to create the stage at.

stage_template

None, Stage

None

Stage entity to use as a template.

reason

None, str

None

Shows up at the guild's audit logs.

**keyword_parameters

Keyword parameters

Additional keyword parameters to create the role with.

privacy_level

PrivacyLevel, int

The new privacy level of the stage. Defaults to guild only.

scheduled_event

int, ScheduledEvent

Alternative for scheduled_event_id.

scheduled_event_id

int, ScheduledEvent

The scheduled event's identifier that started the stage.

send_start_notification

bool

Whether @everyone should be notified when the stage is started.

You must have mention everyone permission.

topic

None, str

The topic of the stage.

Returns

stage : Stage

The created stage instance.

Raises

TypeError

  • If channel was not given as Channel neither as int.
  • If a parameter's type is incorrect.

ValueError

  • If a parameter's value is incorrect.

ConnectionError

No internet connection.

DiscordException

If any exception was received from the Discord API.

stage_delete(stage, ...)

Deletes the given stage channel.

Will trigger a stage_delete event.

This method is a coroutine.

ParameterTypeOptionalKeyword onlyDefaultDescription
stage

Stage, Channel, int

The stage to delete. Can be given as it's channel's identifier.

reason

None, str

None

Shows up at the guild's audit logs.

Raises

TypeError

If stage was not given as Stage, Channel neither as int.

ConnectionError

No internet connection.

DiscordException

If any exception was received from the Discord API.

stage_edit(stage, ...)

Edits the given stage channel.

Will trigger a stage_edit event.

This method is a coroutine.

ParameterTypeOptionalKeyword onlyDefaultDescription
stage

Stage, Channel, int

The stage to edit. Can be given as it's channel's identifier.

stage_template

None, Stage

None

Stage entity to use as a template.

reason

None, str

None

Shows up at the guild's audit logs.

**keyword_parameters

Keyword parameters

Additional keyword parameters to create the role with.

privacy_level

PrivacyLevel, int

The new privacy level of the stage.

topic

None, str

The new topic of the stage.

Raises

TypeError

  • If channel was not given as Channel neither as int.
  • If a parameter's type is incorrect.

ValueError

  • If a parameter's value is incorrect.

ConnectionError

No internet connection.

DiscordException

If any exception was received from the Discord API.

stage_get(channel)

Gets the stage of the given stage channel.

This method is a coroutine.

ParameterTypeDescription
channel

Channel, int

The stage's channel's identifier.

Raises

TypeError

If channel was not given as Channel neither as int.

ConnectionError

No internet connection.

DiscordException

If any exception was received from the Discord API.