Table of Contents

Interface IStageChannel

Namespace
Discord
Assembly
Discord.Net.Core.dll

Represents a generic Stage Channel.

public interface IStageChannel : IVoiceChannel, ITextChannel, IMessageChannel, IMentionable, INestedChannel, IIntegrationChannel, IGuildChannel, IDeletable, IAudioChannel, IChannel, ISnowflakeEntity, IEntity<ulong>
Inherited Members
Extension Methods

Properties

IsDiscoverableDisabled

Gets whether or not stage discovery is disabled.

bool? IsDiscoverableDisabled { get; }

Property Value

bool?

IsLive

Gets whether or not the stage is live.

bool IsLive { get; }

Property Value

bool

PrivacyLevel

Gets the StagePrivacyLevel of the current stage.

StagePrivacyLevel? PrivacyLevel { get; }

Property Value

StagePrivacyLevel?

Remarks

If the stage isn't live then this property will be set to null.

Methods

BecomeSpeakerAsync(RequestOptions)

Makes the current user become a speaker within a stage.

Task BecomeSpeakerAsync(RequestOptions options = null)

Parameters

options RequestOptions

The options to be used when sending the request.

Returns

Task

A task that represents the asynchronous speaker modify operation.

ModifyInstanceAsync(Action<StageInstanceProperties>, RequestOptions)

Modifies the current stage instance.

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

Parameters

func Action<StageInstanceProperties>

The properties to modify the stage instance with.

options RequestOptions

The options to be used when sending the request.

Returns

Task

A task that represents the asynchronous modify operation.

MoveToSpeakerAsync(IGuildUser, RequestOptions)

Makes a user a speaker within a stage.

Task MoveToSpeakerAsync(IGuildUser user, RequestOptions options = null)

Parameters

user IGuildUser

The user to make the speaker.

options RequestOptions

The options to be used when sending the request.

Returns

Task

A task that represents the asynchronous move operation.

RemoveFromSpeakerAsync(IGuildUser, RequestOptions)

Removes a user from speaking.

Task RemoveFromSpeakerAsync(IGuildUser user, RequestOptions options = null)

Parameters

user IGuildUser

The user to remove from speaking.

options RequestOptions

The options to be used when sending the request.

Returns

Task

A task that represents the asynchronous remove operation.

RequestToSpeakAsync(RequestOptions)

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

Task RequestToSpeakAsync(RequestOptions options = null)

Parameters

options RequestOptions

The options to be used when sending the request.

Returns

Task

A task that represents the asynchronous request to speak operation.

StartStageAsync(string, StagePrivacyLevel, RequestOptions)

Starts the stage, creating a stage instance.

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

Parameters

topic string

The topic for the stage/

privacyLevel StagePrivacyLevel

The privacy level of the stage.

options RequestOptions

The options to be used when sending the request.

Returns

Task

A task that represents the asynchronous start operation.

StopSpeakingAsync(RequestOptions)

Makes the current user a listener.

Task StopSpeakingAsync(RequestOptions options = null)

Parameters

options RequestOptions

The options to be used when sending the request.

Returns

Task

A task that represents the asynchronous stop operation.

StopStageAsync(RequestOptions)

Stops the stage, deleting the stage instance.

Task StopStageAsync(RequestOptions options = null)

Parameters

options RequestOptions

The options to be used when sending the request.

Returns

Task

A task that represents the asynchronous stop operation.