Class SocketStageChannel
Represents a stage channel received over the gateway.
Assembly: Discord.Net.WebSocket.dll​
View Source​
public class SocketStageChannel : SocketVoiceChannel, ISocketAudioChannel, IStageChannel, IVoiceChannel, INestedChannel, IGuildChannel, IDeletable, IAudioChannel, IChannel, ISnowflakeEntity, IEntity<ulong>, IMentionable
Properties​
Topic​
Gets the topic of the Stage instance.
View Source​
public string Topic { get; }
PrivacyLevel​
Gets the Discord.StagePrivacyLevel of the current stage.
View Source​
public StagePrivacyLevel? PrivacyLevel { get; }
IsDiscoverableDisabled​
Gets whether or not stage discovery is disabled.
View Source​
public bool? IsDiscoverableDisabled { get; }
IsLive​
Gets whether or not the stage is live.
View Source​
public bool IsLive { get; }
IsSpeaker​
Returns true if the current user is a speaker within the stage, otherwise false.
View Source​
public bool IsSpeaker { get; }
Speakers​
Gets a collection of users who are speakers within the stage.
View Source​
public IReadOnlyCollection<SocketGuildUser> Speakers { get; }
Methods​
StartStageAsync(String, StagePrivacyLevel, RequestOptions)​
Starts the stage, creating a stage instance.
View Source​
public async 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​
public async 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​
public async 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​
public 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​
public 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​
public 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​
public 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​
public 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. |