Interface IStageChannel

Represents a generic Stage Channel.

Assembly: Discord.Net.Core.dll

View Source

Declaration

public interface IStageChannel : IVoiceChannel, INestedChannel, IGuildChannel, IDeletable, IAudioChannel, IChannel, ISnowflakeEntity, IEntity<ulong>, IMentionable

Properties

Topic

Gets the topic of the Stage instance.

View Source

Declaration

string Topic { get; }

PrivacyLevel

Gets the Discord.StagePrivacyLevel of the current stage.

View Source

Declaration

StagePrivacyLevel? PrivacyLevel { get; }

IsDiscoverableDisabled

Gets whether or not stage discovery is disabled.

View Source

Declaration

bool? IsDiscoverableDisabled { get; }

IsLive

Gets whether or not the stage is live.

View Source

Declaration

bool IsLive { get; }

Methods

StartStageAsync(String, StagePrivacyLevel, RequestOptions)

Starts the stage, creating a stage instance.

View Source

Declaration

Task StartStageAsync(string topic, StagePrivacyLevel privacyLevel = StagePrivacyLevel.GuildOnly, RequestOptions options = null)

Returns

System.Threading.Tasks.Task: A task that represents the asynchronous start operation.

Parameters

Type	Name	Description
System.String	topic	The topic for the stage/
Discord.StagePrivacyLevel	privacyLevel	The privacy level of the stage.
Discord.RequestOptions	options	The options to be used when sending the request.

ModifyInstanceAsync(Action<StageInstanceProperties>, RequestOptions)

Modifies the current stage instance.

View Source

Declaration

Task ModifyInstanceAsync(Action<StageInstanceProperties> func, RequestOptions options = null)

Returns

System.Threading.Tasks.Task: A task that represents the asynchronous modify operation.

Parameters

Type	Name	Description
System.Action<Discord.StageInstanceProperties>	func	The properties to modify the stage instance with.
Discord.RequestOptions	options	The options to be used when sending the request.

StopStageAsync(RequestOptions)

Stops the stage, deleting the stage instance.

View Source

Declaration

Task StopStageAsync(RequestOptions options = null)

Returns

System.Threading.Tasks.Task: A task that represents the asynchronous stop operation.

Parameters

Type	Name	Description
Discord.RequestOptions	options	The options to be used when sending the request.

RequestToSpeakAsync(RequestOptions)

Indicates that the bot would like to speak within a stage channel.

View Source

Declaration

Task RequestToSpeakAsync(RequestOptions options = null)

Returns

System.Threading.Tasks.Task: A task that represents the asynchronous request to speak operation.

Parameters

Type	Name	Description
Discord.RequestOptions	options	The options to be used when sending the request.

BecomeSpeakerAsync(RequestOptions)

Makes the current user become a speaker within a stage.

View Source

Declaration

Task BecomeSpeakerAsync(RequestOptions options = null)

Returns

System.Threading.Tasks.Task: A task that represents the asynchronous speaker modify operation.

Parameters

Type	Name	Description
Discord.RequestOptions	options	The options to be used when sending the request.

StopSpeakingAsync(RequestOptions)

Makes the current user a listener.

View Source

Declaration

Task StopSpeakingAsync(RequestOptions options = null)

Returns

System.Threading.Tasks.Task: A task that represents the asynchronous stop operation.

Parameters

Type	Name	Description
Discord.RequestOptions	options	The options to be used when sending the request.

MoveToSpeakerAsync(IGuildUser, RequestOptions)

Makes a user a speaker within a stage.

View Source

Declaration

Task MoveToSpeakerAsync(IGuildUser user, RequestOptions options = null)

Returns

System.Threading.Tasks.Task: A task that represents the asynchronous move operation.

Parameters

Type	Name	Description
Discord.IGuildUser	user	The user to make the speaker.
Discord.RequestOptions	options	The options to be used when sending the request.

RemoveFromSpeakerAsync(IGuildUser, RequestOptions)

Removes a user from speaking.

View Source

Declaration

Task RemoveFromSpeakerAsync(IGuildUser user, RequestOptions options = null)

Returns

System.Threading.Tasks.Task: A task that represents the asynchronous remove operation.

Parameters

Type	Name	Description
Discord.IGuildUser	user	The user to remove from speaking.
Discord.RequestOptions	options	The options to be used when sending the request.