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
(channel, ...)
stage_createEdits 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.
Parameter | Type | Optional | Keyword only | Default | Description |
---|---|---|---|---|---|
channel |
| The channel to create the stage at. | |||
stage_template |
|
| Stage entity to use as a template. | ||
reason |
|
| Shows up at the guild's audit logs. | ||
**keyword_parameters | Keyword parameters | Additional keyword parameters to create the role with. | |||
privacy_level |
| The new privacy level of the stage. Defaults to guild only. | |||
scheduled_event |
| Alternative for | |||
scheduled_event_id |
| The scheduled event's identifier that started the stage. | |||
send_start_notification |
| Whether @everyone should be notified when the stage is started.
| |||
topic |
| The topic of the stage. |
Returns
stage : Stage
The created stage instance.
Raises
TypeError
- If
channel
was not given asChannel
neither asint
. - 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, ...)
stage_deleteDeletes the given stage channel.
Will trigger a stage_delete
event.
This method is a coroutine.
Parameter | Type | Optional | Keyword only | Default | Description |
---|---|---|---|---|---|
stage | The stage to delete. Can be given as it's channel's identifier. | ||||
reason |
|
| Shows up at the guild's audit logs. |
Raises
TypeError
ConnectionError
No internet connection.
DiscordException
If any exception was received from the Discord API.
(stage, ...)
stage_editEdits the given stage channel.
Will trigger a stage_edit
event.
This method is a coroutine.
Parameter | Type | Optional | Keyword only | Default | Description |
---|---|---|---|---|---|
stage | The stage to edit. Can be given as it's channel's identifier. | ||||
stage_template |
|
| Stage entity to use as a template. | ||
reason |
|
| Shows up at the guild's audit logs. | ||
**keyword_parameters | Keyword parameters | Additional keyword parameters to create the role with. | |||
privacy_level |
| The new privacy level of the stage. | |||
topic |
| The new topic of the stage. |
Raises
TypeError
- If
channel
was not given asChannel
neither asint
. - 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.
(channel)
stage_getGets the stage of the given stage channel.
This method is a coroutine.
Parameter | Type | Description |
---|---|---|
channel |
| 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.