Class StageGuildChannel

Namespace

NetCord

Assembly

NetCord.dll

Represents a stage channel within a guild.

public class StageGuildChannel : TextGuildChannel, IEquatable<Entity>, IJsonModel<JsonChannel>, IInteractionChannel, IVoiceGuildChannel, IGuildChannel, INamedChannel, IEntity, ISpanFormattable, IFormattable

Inheritance

object

Entity

ClientEntity

Channel

TextChannel

TextGuildChannel

StageGuildChannel

Implements

IEquatable<Entity>

IJsonModel<JsonChannel>

IInteractionChannel

IVoiceGuildChannel

IGuildChannel

INamedChannel

IEntity

ISpanFormattable

IFormattable

Inherited Members

TextGuildChannel.ModifyPermissionsAsync(PermissionOverwriteProperties, RestRequestProperties, CancellationToken)

TextGuildChannel.GetInvitesAsync(RestRequestProperties, CancellationToken)

TextGuildChannel.CreateInviteAsync(InviteProperties, RestRequestProperties, CancellationToken)

TextGuildChannel.DeletePermissionAsync(ulong, RestRequestProperties, CancellationToken)

TextGuildChannel.CreateGuildThreadAsync(ulong, GuildThreadFromMessageProperties, RestRequestProperties, CancellationToken)

TextGuildChannel.CreateGuildThreadAsync(GuildThreadProperties, RestRequestProperties, CancellationToken)

TextGuildChannel.GetPublicArchivedGuildThreadsAsync(PaginationProperties<DateTimeOffset>, RestRequestProperties)

TextGuildChannel.GetPrivateArchivedGuildThreadsAsync(PaginationProperties<DateTimeOffset>, RestRequestProperties)

TextGuildChannel.GetJoinedPrivateArchivedGuildThreadsAsync(PaginationProperties<ulong>, RestRequestProperties)

TextGuildChannel.CreateWebhookAsync(WebhookProperties, RestRequestProperties, CancellationToken)

TextGuildChannel.GetChannelWebhooksAsync(RestRequestProperties, CancellationToken)

TextGuildChannel.GuildId

TextGuildChannel.Position

TextGuildChannel.PermissionOverwrites

TextGuildChannel.Name

TextGuildChannel.Topic

TextGuildChannel.Nsfw

TextGuildChannel.Slowmode

TextGuildChannel.ParentId

TextGuildChannel.DefaultAutoArchiveDuration

TextGuildChannel.DefaultThreadSlowmode

TextChannel.CreateFromJson(JsonChannel, RestClient)

TextChannel.GetMessagesAsync(PaginationProperties<ulong>, RestRequestProperties)

TextChannel.GetMessagesAroundAsync(ulong, int?, RestRequestProperties, CancellationToken)

TextChannel.GetMessageAsync(ulong, RestRequestProperties, CancellationToken)

TextChannel.SendMessageAsync(MessageProperties, RestRequestProperties, CancellationToken)

TextChannel.AddMessageReactionAsync(ulong, ReactionEmojiProperties, RestRequestProperties, CancellationToken)

TextChannel.DeleteCurrentUserMessageReactionAsync(ulong, ReactionEmojiProperties, RestRequestProperties, CancellationToken)

TextChannel.DeleteUserMessageReactionAsync(ulong, ReactionEmojiProperties, ulong, RestRequestProperties, CancellationToken)

TextChannel.GetMessageReactionsAsync(ulong, ReactionEmojiProperties, MessageReactionsPaginationProperties, RestRequestProperties)

TextChannel.DeleteAllMessageReactionsAsync(ulong, RestRequestProperties, CancellationToken)

TextChannel.DeleteAllMessageReactionsForEmojiAsync(ulong, ReactionEmojiProperties, RestRequestProperties, CancellationToken)

TextChannel.ModifyMessageAsync(ulong, Action<MessageOptions>, RestRequestProperties, CancellationToken)

TextChannel.DeleteMessageAsync(ulong, RestRequestProperties, CancellationToken)

TextChannel.DeleteMessagesAsync(IEnumerable<ulong>, RestRequestProperties, CancellationToken)

TextChannel.TriggerTypingAsync(RestRequestProperties, CancellationToken)

TextChannel.EnterTypingScopeAsync(TypingScopeProperties, RestRequestProperties, CancellationToken)

TextChannel.EnterTypingScope(TypingScopeProperties, RestRequestProperties)

TextChannel.GetPinnedMessagesAsync(RestRequestProperties, CancellationToken)

TextChannel.PinMessageAsync(ulong, RestRequestProperties, CancellationToken)

TextChannel.UnpinMessageAsync(ulong, RestRequestProperties, CancellationToken)

TextChannel.GetMessagePollAnswerVotersAsync(ulong, int, PaginationProperties<ulong>, RestRequestProperties)

TextChannel.EndMessagePollAsync(ulong, RestRequestProperties, CancellationToken)

TextChannel.LastMessageId

TextChannel.LastPin

Channel.ToString()

Channel.TryFormat(Span<char>, out int, ReadOnlySpan<char>, IFormatProvider)

Channel.CreateGoogleCloudPlatformStorageBucketsAsync(IEnumerable<GoogleCloudPlatformStorageBucketProperties>, RestRequestProperties, CancellationToken)

Channel.Id

Channel.Flags

Entity.Equals(object)

Entity.Equals(Entity)

Entity.GetHashCode()

Entity.ToString(string, IFormatProvider)

Entity.CreatedAt

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

StageGuildChannel(JsonChannel, ulong, RestClient)

Represents a stage channel within a guild.

public StageGuildChannel(JsonChannel jsonModel, ulong guildId, RestClient client)

Parameters

jsonModel JsonChannel

guildId ulong

client RestClient

Properties

Bitrate

The voice channel's bitrate (in bits per second).

public int Bitrate { get; }

Property Value

int

RtcRegion

The voice channel's preferred region, if set. When null, Discord automatically determines this.

public string? RtcRegion { get; }

Property Value

string

UserLimit

The voice channel's user limit.

public int UserLimit { get; }

Property Value

int

VideoQualityMode

The voice channel's video optimization mode (for cameras).

public VideoQualityMode VideoQualityMode { get; }

Property Value

VideoQualityMode

Methods

DeleteAsync(RestRequestProperties?, CancellationToken)

Deletes a channel.

public Task<StageGuildChannel> DeleteAsync(RestRequestProperties? properties = null, CancellationToken cancellationToken = default)

Parameters

properties RestRequestProperties

Optional properties to customize the request, can be null.

cancellationToken CancellationToken

A token that can be used to cancel the operation before it completes.

Returns

Task<StageGuildChannel>

DeleteStageInstanceAsync(RestRequestProperties?, CancellationToken)

public Task DeleteStageInstanceAsync(RestRequestProperties? properties = null, CancellationToken cancellationToken = default)

Parameters

properties RestRequestProperties

cancellationToken CancellationToken

Returns

Task

GetAsync(RestRequestProperties?, CancellationToken)

Retrieves a channel by its ID.

public Task<StageGuildChannel> GetAsync(RestRequestProperties? properties = null, CancellationToken cancellationToken = default)

Parameters

properties RestRequestProperties

Optional properties to customize the request, can be null.

cancellationToken CancellationToken

A token that can be used to cancel the operation before it completes.

Returns

Task<StageGuildChannel>

GetStageInstanceAsync(RestRequestProperties?, CancellationToken)

public Task<StageInstance> GetStageInstanceAsync(RestRequestProperties? properties = null, CancellationToken cancellationToken = default)

Parameters

properties RestRequestProperties

cancellationToken CancellationToken

Returns

Task<StageInstance>

ModifyAsync(Action<GuildChannelOptions>, RestRequestProperties?, CancellationToken)

Modifies a guild channel's properties.

public Task<StageGuildChannel> ModifyAsync(Action<GuildChannelOptions> action, RestRequestProperties? properties = null, CancellationToken cancellationToken = default)

Parameters

action Action<GuildChannelOptions>

An action delegate used to configure the updated channel options.

properties RestRequestProperties

Optional properties to customize the request, can be null.

cancellationToken CancellationToken

A token that can be used to cancel the operation before it completes.

Returns

Task<StageGuildChannel>

ModifyStageInstanceAsync(Action<StageInstanceOptions>, RestRequestProperties?, CancellationToken)

public Task<StageInstance> ModifyStageInstanceAsync(Action<StageInstanceOptions> action, RestRequestProperties? properties = null, CancellationToken cancellationToken = default)

Parameters

action Action<StageInstanceOptions>

properties RestRequestProperties

cancellationToken CancellationToken

Returns

Task<StageInstance>