Stage

class discord_limits.paths.StagePaths(client)
Parameters:

client (discord_limits.DiscordClient) – The DiscordClient instance to use.

async create_stage_instance(*, reason=None, **payload)

Create a stage instance.

Parameters:
  • reason (str, optional) – A reason for this action that will be displayed in the audit log, by default None

  • payload (Any) – The params for the JSON payload.

Returns:

A stage instance object.

Return type:

ClientResponse

async get_stage_instance(channel_id)

Get a stage instance.

Parameters:

channel_id (int) – The ID of the channel to get the stage instance for.

Returns:

A stage instance object.

Return type:

ClientResponse

async edit_stage_instance(channel_id, *, reason=None, **payload)

Edit a stage instance.

Parameters:
  • channel_id (int) – The ID of the channel to edit the stage instance for.

  • reason (str, optional) – A reason for this action that will be displayed in the audit log, by default None

  • payload (Any) – The params for the JSON payload.

Returns:

A stage instance object.

Return type:

ClientResponse

async delete_stage_instance(channel_id, reason=None)

Delete a stage instance.

Parameters:
  • channel_id (int) – The ID of the channel to delete the stage instance for.

  • reason (str, optional) – A reason for this action that will be displayed in the audit log, by default None

Returns:

The response from Discord.

Return type:

ClientResponse