Class SocketStageChannel

Represents a stage channel received over the gateway.

Inheritance
Object
SocketEntity<UInt64>
SocketChannel
SocketGuildChannel
SocketTextChannel
SocketVoiceChannel
SocketStageChannel
Inherited Members
Namespace: Discord.WebSocket
Assembly: Discord.Net.WebSocket.dll
Syntax
public class SocketStageChannel : SocketVoiceChannel, IEntity<ulong>, ITextChannel, ISocketMessageChannel, ISocketAudioChannel, IStageChannel, IVoiceChannel, IMessageChannel, INestedChannel, IGuildChannel, IDeletable, IAudioChannel, IChannel, ISnowflakeEntity, IEntity<ulong>, IMentionable

Properties

| Improve this Doc View Source

IsDiscoverableDisabled

Declaration
public bool? IsDiscoverableDisabled { get; }
Property Value
Type Description
Nullable<Boolean>
| Improve this Doc View Source

IsLive

Declaration
public bool IsLive { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsSpeaker

Returns true if the current user is a speaker within the stage, otherwise false.

Declaration
public bool IsSpeaker { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsTextInVoice

Gets whether or not the guild has Text-In-Voice enabled and the voice channel is a TiV channel.

Declaration
public override bool IsTextInVoice { get; }
Property Value
Type Description
Boolean
Overrides
Remarks

This field is always false for stage channels.

| Improve this Doc View Source

PrivacyLevel

Declaration
public StagePrivacyLevel? PrivacyLevel { get; }
Property Value
Type Description
Nullable<StagePrivacyLevel>
| Improve this Doc View Source

Speakers

Gets a collection of users who are speakers within the stage.

Declaration
public IReadOnlyCollection<SocketGuildUser> Speakers { get; }
Property Value
Type Description
IReadOnlyCollection<SocketGuildUser>

Methods

| Improve this Doc View Source

BecomeSpeakerAsync(RequestOptions)

Declaration
public Task BecomeSpeakerAsync(RequestOptions options = null)
Parameters
Type Name Description
RequestOptions options
Returns
Type Description
Task
| Improve this Doc View Source

ModifyInstanceAsync(Action<StageInstanceProperties>, RequestOptions)

Declaration
public async Task ModifyInstanceAsync(Action<StageInstanceProperties> func, RequestOptions options = null)
Parameters
Type Name Description
Action<StageInstanceProperties> func
RequestOptions options
Returns
Type Description
Task
| Improve this Doc View Source

MoveToSpeakerAsync(IGuildUser, RequestOptions)

Declaration
public Task MoveToSpeakerAsync(IGuildUser user, RequestOptions options = null)
Parameters
Type Name Description
IGuildUser user
RequestOptions options
Returns
Type Description
Task
| Improve this Doc View Source

RemoveFromSpeakerAsync(IGuildUser, RequestOptions)

Declaration
public Task RemoveFromSpeakerAsync(IGuildUser user, RequestOptions options = null)
Parameters
Type Name Description
IGuildUser user
RequestOptions options
Returns
Type Description
Task
| Improve this Doc View Source

RequestToSpeakAsync(RequestOptions)

Declaration
public Task RequestToSpeakAsync(RequestOptions options = null)
Parameters
Type Name Description
RequestOptions options
Returns
Type Description
Task
| Improve this Doc View Source

StartStageAsync(String, StagePrivacyLevel, RequestOptions)

Declaration
public async Task StartStageAsync(string topic, StagePrivacyLevel privacyLevel = default(StagePrivacyLevel), RequestOptions options = null)
Parameters
Type Name Description
String topic
StagePrivacyLevel privacyLevel
RequestOptions options
Returns
Type Description
Task
| Improve this Doc View Source

StopSpeakingAsync(RequestOptions)

Declaration
public Task StopSpeakingAsync(RequestOptions options = null)
Parameters
Type Name Description
RequestOptions options
Returns
Type Description
Task
| Improve this Doc View Source

StopStageAsync(RequestOptions)

Declaration
public async Task StopStageAsync(RequestOptions options = null)
Parameters
Type Name Description
RequestOptions options
Returns
Type Description
Task

Implements