StageInstance

StageInstance ⇐ Base

Represents a Stage Instance in a guild.

Kind: global class
Extends: Base

• StageInstance ⇐ Base
  • new StageInstance([data], guildId, client)
  • .guild ⇒
  • .channel ⇒
  • .guildScheduledEvent ⇒ ScheduledEvent | null
  • .fetch(options) ⇒ Promise.<StageInstance>
  • .edit(options) ⇒ Promise
  • .delete(reason) ⇒ Promise.<void>
  • .setTopic(topic, reason) ⇒ Promise
  • .setPrivacyLevel(privacyLevel, reason) ⇒ Promise

new StageInstance([data], guildId, client)

Constructs a new instance of a Channel object.

Param	Type	Description
[data]	Object	The data for the Stage Instance.
guildId	string	The ID of the guild the Stage Instance belongs to.
client	Client	The client instance.

stageInstance.guild ⇒

Retrieves the guild associated with this guildId.

Kind: instance property of StageInstance
Returns: The guild object if found, otherwise null.

stageInstance.channel ⇒

Retrieves the channel associated with this object.

Kind: instance property of StageInstance
Returns: The channel object if found, otherwise null.

stageInstance.guildScheduledEvent ⇒ ScheduledEvent | null

Retrieves the scheduled event associated with the guild.

Kind: instance property of StageInstance
Returns: ScheduledEvent | null - The scheduled event object if found, otherwise null.

stageInstance.fetch(options) ⇒ Promise.<StageInstance>

Fetches the stage instance for the given channel ID using the provided options.

Kind: instance method of StageInstance
Returns: Promise.<StageInstance> - A promise that resolves with the fetched stage instance.

Param	Type	Description
options	Object	The options to pass to the fetch request.

stageInstance.edit(options) ⇒ Promise

Edits the stage instance with the given options.

Kind: instance method of StageInstance
Returns: Promise - A promise that resolves when the stage instance is successfully edited.

Param	Type	Description
options	Object	The options to edit the stage instance.

stageInstance.delete(reason) ⇒ Promise.<void>

Deletes the stage instance associated with the channel.

Kind: instance method of StageInstance
Returns: Promise.<void> - - A promise that resolves when the stage instance is deleted.

Param	Type	Description
reason	string	The reason for deleting the stage instance.

stageInstance.setTopic(topic, reason) ⇒ Promise

Sets the topic of the current object and provides a reason for the change.

Kind: instance method of StageInstance
Returns: Promise - - A promise that resolves when the topic is successfully set.

Param	Type	Description
topic	string	The new topic to set.
reason	string	The reason for changing the topic.

stageInstance.setPrivacyLevel(privacyLevel, reason) ⇒ Promise

Sets the privacy level for the current user.

Kind: instance method of StageInstance
Returns: Promise - - A promise that resolves when the privacy level is successfully set.

Param	Type	Description
privacyLevel	string	The privacy level to set.
reason	string	The reason for setting the privacy level.