public class RestVoiceChannel : RestTextChannel, IEntity<ulong>, IUpdateable, IRestMessageChannel, ITextChannel, IVoiceChannel, IMessageChannel, INestedChannel, IGuildChannel, IDeletable, IMentionable, IRestAudioChannel, IAudioChannel, IChannel, ISnowflakeEntity, IEntity<ulong>

Properties

| Improve this Doc View Source

Bitrate

Declaration

public int Bitrate { get; }

Property Value

Type	Description
Int32

| 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 virtual bool IsTextInVoice { get; }

Property Value

Type	Description
Boolean

| Improve this Doc View Source

RTCRegion

Declaration

public string RTCRegion { get; }

Property Value

Type	Description
String

| Improve this Doc View Source

UserLimit

Declaration

public int? UserLimit { get; }

Property Value

Type	Description
Nullable<Int32>

Methods

| Improve this Doc View Source

CreateThreadAsync(String, ThreadType, ThreadArchiveDuration, IMessage, Nullable<Boolean>, Nullable<Int32>, RequestOptions)

Creates a thread within this ITextChannel.

Declaration

public override Task<RestThreadChannel> CreateThreadAsync(string name, ThreadType type = default(ThreadType), ThreadArchiveDuration autoArchiveDuration = default(ThreadArchiveDuration), IMessage message = null, bool? invitable = null, int? slowmode = null, RequestOptions options = null)

Parameters

Type	Name	Description
String	name	The name of the thread.
ThreadType	type	The type of the thread. Note: This parameter is not used if the `message` parameter is not specified.
ThreadArchiveDuration	autoArchiveDuration	The duration on which this thread archives after. Note: Options OneWeek and ThreeDays are only available for guilds that are boosted. You can check in the Features to see if the guild has the THREE_DAY_THREAD_ARCHIVE and SEVEN_DAY_THREAD_ARCHIVE.
IMessage	message	The message which to start the thread from.
Nullable<Boolean>	invitable
Nullable<Int32>	slowmode
RequestOptions	options	The options to be used when sending the request.

Returns

Type	Description
Task<RestThreadChannel>	A task that represents the asynchronous create operation. The task result contains a IThreadChannel

Overrides

RestTextChannel.CreateThreadAsync(String, ThreadType, ThreadArchiveDuration, IMessage, Nullable<Boolean>, Nullable<Int32>, RequestOptions)

Remarks

When message is null the thread type will be based off of the channel its created in. When called on a ITextChannel, it creates a PublicThread. When called on a INewsChannel, it creates a NewsThread. The id of the created thread will be the same as the id of the message, and as such a message can only have a single thread created from it.

| Improve this Doc View Source

CreateWebhookAsync(String, Stream, RequestOptions)

Creates a webhook in this text channel.

Declaration

public override Task<RestWebhook> CreateWebhookAsync(string name, Stream avatar = null, RequestOptions options = null)

Parameters

Type	Name	Description
String	name	The name of the webhook.
Stream	avatar	The avatar of the webhook.
RequestOptions	options	The options to be used when sending the request.

Returns

Type	Description
Task<RestWebhook>	A task that represents the asynchronous creation operation. The task result contains the newly created webhook.

Overrides

RestTextChannel.CreateWebhookAsync(String, Stream, RequestOptions)

| Improve this Doc View Source

DeleteMessageAsync(IMessage, RequestOptions)

Declaration

public override Task DeleteMessageAsync(IMessage message, RequestOptions options = null)

Parameters

Type	Name	Description
IMessage	message
RequestOptions	options

Returns

Type	Description
Task

Overrides

RestTextChannel.DeleteMessageAsync(IMessage, RequestOptions)

| Improve this Doc View Source

DeleteMessageAsync(UInt64, RequestOptions)

Declaration

public override Task DeleteMessageAsync(ulong messageId, RequestOptions options = null)

Parameters

Type	Name	Description
UInt64	messageId
RequestOptions	options

Returns

Type	Description
Task

Overrides

RestTextChannel.DeleteMessageAsync(UInt64, RequestOptions)

| Improve this Doc View Source

DeleteMessagesAsync(IEnumerable<IMessage>, RequestOptions)

Declaration

public override Task DeleteMessagesAsync(IEnumerable<IMessage> messages, RequestOptions options = null)

Parameters

Type	Name	Description
IEnumerable<IMessage>	messages
RequestOptions	options

Returns

Type	Description
Task

Overrides

RestTextChannel.DeleteMessagesAsync(IEnumerable<IMessage>, RequestOptions)

| Improve this Doc View Source

DeleteMessagesAsync(IEnumerable<UInt64>, RequestOptions)

Declaration

public override Task DeleteMessagesAsync(IEnumerable<ulong> messageIds, RequestOptions options = null)

Parameters

Type	Name	Description
IEnumerable<UInt64>	messageIds
RequestOptions	options

Returns

Type	Description
Task

Overrides

RestTextChannel.DeleteMessagesAsync(IEnumerable<UInt64>, RequestOptions)

| Improve this Doc View Source

EnterTypingState(RequestOptions)

Declaration

public override IDisposable EnterTypingState(RequestOptions options = null)

Parameters

Type	Name	Description
RequestOptions	options

Returns

Type	Description
IDisposable

Overrides

RestTextChannel.EnterTypingState(RequestOptions)

| Improve this Doc View Source

GetMessageAsync(UInt64, RequestOptions)

Gets a message from this message channel.

Declaration

public override Task<RestMessage> GetMessageAsync(ulong id, RequestOptions options = null)

Parameters

Type	Name	Description
UInt64	id	The snowflake identifier of the message.
RequestOptions	options	The options to be used when sending the request.

Returns

Type	Description
Task<RestMessage>	A task that represents an asynchronous get operation for retrieving the message. The task result contains the retrieved message; `null` if no message is found with the specified identifier.

Overrides

RestTextChannel.GetMessageAsync(UInt64, RequestOptions)

Remarks

This method follows the same behavior as described in . Please visit its documentation for more details on this method.

| Improve this Doc View Source

GetMessagesAsync(IMessage, Direction, Int32, RequestOptions)

Gets a collection of messages in this channel.

Declaration

public override IAsyncEnumerable<IReadOnlyCollection<RestMessage>> GetMessagesAsync(IMessage fromMessage, Direction dir, int limit = 100, RequestOptions options = null)

Parameters

Type	Name	Description
IMessage	fromMessage	The starting message to get the messages from.
Direction	dir	The direction of the messages to be gotten from.
Int32	limit	The numbers of message to be gotten from.
RequestOptions	options	The options to be used when sending the request.

Returns

Type	Description
IAsyncEnumerable<IReadOnlyCollection<RestMessage>>	Paged collection of messages.

Overrides

RestTextChannel.GetMessagesAsync(IMessage, Direction, Int32, RequestOptions)

Remarks

This method follows the same behavior as described in . Please visit its documentation for more details on this method.

| Improve this Doc View Source

GetMessagesAsync(Int32, RequestOptions)

Gets the last N messages from this message channel.

Declaration

public override IAsyncEnumerable<IReadOnlyCollection<RestMessage>> GetMessagesAsync(int limit = 100, RequestOptions options = null)

Parameters

Type	Name	Description
Int32	limit	The numbers of message to be gotten from.
RequestOptions	options	The options to be used when sending the request.

Returns

Type	Description
IAsyncEnumerable<IReadOnlyCollection<RestMessage>>	Paged collection of messages.

Overrides

RestTextChannel.GetMessagesAsync(Int32, RequestOptions)

Remarks

This method follows the same behavior as described in . Please visit its documentation for more details on this method.

| Improve this Doc View Source

GetMessagesAsync(UInt64, Direction, Int32, RequestOptions)

Gets a collection of messages in this channel.

Declaration

public override IAsyncEnumerable<IReadOnlyCollection<RestMessage>> GetMessagesAsync(ulong fromMessageId, Direction dir, int limit = 100, RequestOptions options = null)

Parameters

Type	Name	Description
UInt64	fromMessageId	The ID of the starting message to get the messages from.
Direction	dir	The direction of the messages to be gotten from.
Int32	limit	The numbers of message to be gotten from.
RequestOptions	options	The options to be used when sending the request.

Returns

Type	Description
IAsyncEnumerable<IReadOnlyCollection<RestMessage>>	Paged collection of messages.

Overrides

RestTextChannel.GetMessagesAsync(UInt64, Direction, Int32, RequestOptions)

Remarks

This method follows the same behavior as described in . Please visit its documentation for more details on this method.

| Improve this Doc View Source

GetPinnedMessagesAsync(RequestOptions)

Gets a collection of pinned messages in this channel.

Declaration

public override Task<IReadOnlyCollection<RestMessage>> GetPinnedMessagesAsync(RequestOptions options = null)

Parameters

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

Returns

Type	Description
Task<IReadOnlyCollection<RestMessage>>	A task that represents the asynchronous get operation for retrieving pinned messages in this channel. The task result contains a collection of messages found in the pinned messages.

Overrides

RestTextChannel.GetPinnedMessagesAsync(RequestOptions)

Remarks

This method follows the same behavior as described in GetPinnedMessagesAsync(RequestOptions). Please visit its documentation for more details on this method.

| Improve this Doc View Source

GetWebhookAsync(UInt64, RequestOptions)

Gets a webhook available in this text channel.

Declaration

public override Task<RestWebhook> GetWebhookAsync(ulong id, RequestOptions options = null)

Parameters

Type	Name	Description
UInt64	id	The identifier of the webhook.
RequestOptions	options	The options to be used when sending the request.

Returns

Type	Description
Task<RestWebhook>	A task that represents the asynchronous get operation. The task result contains a webhook associated with the identifier; `null` if the webhook is not found.

Overrides

RestTextChannel.GetWebhookAsync(UInt64, RequestOptions)

| Improve this Doc View Source

GetWebhooksAsync(RequestOptions)

Gets the webhooks available in this text channel.

Declaration

public override Task<IReadOnlyCollection<RestWebhook>> GetWebhooksAsync(RequestOptions options = null)

Parameters

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

Returns

Type	Description
Task<IReadOnlyCollection<RestWebhook>>	A task that represents the asynchronous get operation. The task result contains a read-only collection of webhooks that is available in this channel.

Overrides

RestTextChannel.GetWebhooksAsync(RequestOptions)

| Improve this Doc View Source

ModifyAsync(Action<TextChannelProperties>, RequestOptions)

Declaration

public override Task ModifyAsync(Action<TextChannelProperties> func, RequestOptions options = null)

Parameters

Type	Name	Description
Action<TextChannelProperties>	func
RequestOptions	options

Returns

Type	Description
Task

Overrides

RestTextChannel.ModifyAsync(Action<TextChannelProperties>, RequestOptions)

| Improve this Doc View Source

ModifyAsync(Action<VoiceChannelProperties>, RequestOptions)

Declaration

public async Task ModifyAsync(Action<VoiceChannelProperties> func, RequestOptions options = null)

Parameters

Type	Name	Description
Action<VoiceChannelProperties>	func
RequestOptions	options

Returns

Type	Description
Task

| Improve this Doc View Source

ModifyMessageAsync(UInt64, Action<MessageProperties>, RequestOptions)

Declaration

public override Task<IUserMessage> ModifyMessageAsync(ulong messageId, Action<MessageProperties> func, RequestOptions options = null)

Parameters

Type	Name	Description
UInt64	messageId
Action<MessageProperties>	func
RequestOptions	options

Returns

Type	Description
Task<IUserMessage>

Overrides

RestTextChannel.ModifyMessageAsync(UInt64, Action<MessageProperties>, RequestOptions)

| Improve this Doc View Source

SendFileAsync(FileAttachment, String, Boolean, Embed, RequestOptions, AllowedMentions, MessageReference, MessageComponent, ISticker[], Embed[], MessageFlags)

Declaration

public override Task<RestUserMessage> SendFileAsync(FileAttachment attachment, string text, bool isTTS = false, Embed embed = null, RequestOptions options = null, AllowedMentions allowedMentions = null, MessageReference messageReference = null, MessageComponent components = null, ISticker[] stickers = null, Embed[] embeds = null, MessageFlags flags = default(MessageFlags))

Parameters

Type	Name	Description
FileAttachment	attachment
String	text
Boolean	isTTS
Embed	embed
RequestOptions	options
AllowedMentions	allowedMentions
MessageReference	messageReference
MessageComponent	components
ISticker[]	stickers
Embed[]	embeds
MessageFlags	flags

Returns

Type	Description
Task<RestUserMessage>

Overrides

RestTextChannel.SendFileAsync(FileAttachment, String, Boolean, Embed, RequestOptions, AllowedMentions, MessageReference, MessageComponent, ISticker[], Embed[], MessageFlags)

| Improve this Doc View Source

SendFileAsync(Stream, String, String, Boolean, Embed, RequestOptions, Boolean, AllowedMentions, MessageReference, MessageComponent, ISticker[], Embed[], MessageFlags)

Declaration

public override Task<RestUserMessage> SendFileAsync(Stream stream, string filename, string text, bool isTTS = false, Embed embed = null, RequestOptions options = null, bool isSpoiler = false, AllowedMentions allowedMentions = null, MessageReference messageReference = null, MessageComponent components = null, ISticker[] stickers = null, Embed[] embeds = null, MessageFlags flags = default(MessageFlags))

Parameters

Type	Name	Description
Stream	stream
String	filename
String	text
Boolean	isTTS
Embed	embed
RequestOptions	options
Boolean	isSpoiler
AllowedMentions	allowedMentions
MessageReference	messageReference
MessageComponent	components
ISticker[]	stickers
Embed[]	embeds
MessageFlags	flags

Returns

Type	Description
Task<RestUserMessage>

Overrides

RestTextChannel.SendFileAsync(Stream, String, String, Boolean, Embed, RequestOptions, Boolean, AllowedMentions, MessageReference, MessageComponent, ISticker[], Embed[], MessageFlags)

| Improve this Doc View Source

SendFileAsync(String, String, Boolean, Embed, RequestOptions, Boolean, AllowedMentions, MessageReference, MessageComponent, ISticker[], Embed[], MessageFlags)

Declaration

public override Task<RestUserMessage> SendFileAsync(string filePath, string text, bool isTTS = false, Embed embed = null, RequestOptions options = null, bool isSpoiler = false, AllowedMentions allowedMentions = null, MessageReference messageReference = null, MessageComponent components = null, ISticker[] stickers = null, Embed[] embeds = null, MessageFlags flags = default(MessageFlags))

Parameters

Type	Name	Description
String	filePath
String	text
Boolean	isTTS
Embed	embed
RequestOptions	options
Boolean	isSpoiler
AllowedMentions	allowedMentions
MessageReference	messageReference
MessageComponent	components
ISticker[]	stickers
Embed[]	embeds
MessageFlags	flags

Returns

Type	Description
Task<RestUserMessage>

Overrides

RestTextChannel.SendFileAsync(String, String, Boolean, Embed, RequestOptions, Boolean, AllowedMentions, MessageReference, MessageComponent, ISticker[], Embed[], MessageFlags)

| Improve this Doc View Source

SendFilesAsync(IEnumerable<FileAttachment>, String, Boolean, Embed, RequestOptions, AllowedMentions, MessageReference, MessageComponent, ISticker[], Embed[], MessageFlags)

Declaration

public override Task<RestUserMessage> SendFilesAsync(IEnumerable<FileAttachment> attachments, string text, bool isTTS = false, Embed embed = null, RequestOptions options = null, AllowedMentions allowedMentions = null, MessageReference messageReference = null, MessageComponent components = null, ISticker[] stickers = null, Embed[] embeds = null, MessageFlags flags = default(MessageFlags))

Parameters

Type	Name	Description
IEnumerable<FileAttachment>	attachments
String	text
Boolean	isTTS
Embed	embed
RequestOptions	options
AllowedMentions	allowedMentions
MessageReference	messageReference
MessageComponent	components
ISticker[]	stickers
Embed[]	embeds
MessageFlags	flags

Returns

Type	Description
Task<RestUserMessage>

Overrides

RestTextChannel.SendFilesAsync(IEnumerable<FileAttachment>, String, Boolean, Embed, RequestOptions, AllowedMentions, MessageReference, MessageComponent, ISticker[], Embed[], MessageFlags)

| Improve this Doc View Source

SendMessageAsync(String, Boolean, Embed, RequestOptions, AllowedMentions, MessageReference, MessageComponent, ISticker[], Embed[], MessageFlags)

Declaration

public override Task<RestUserMessage> SendMessageAsync(string text = null, bool isTTS = false, Embed embed = null, RequestOptions options = null, AllowedMentions allowedMentions = null, MessageReference messageReference = null, MessageComponent components = null, ISticker[] stickers = null, Embed[] embeds = null, MessageFlags flags = default(MessageFlags))

Parameters

Type	Name	Description
String	text
Boolean	isTTS
Embed	embed
RequestOptions	options
AllowedMentions	allowedMentions
MessageReference	messageReference
MessageComponent	components
ISticker[]	stickers
Embed[]	embeds
MessageFlags	flags

Returns

Type	Description
Task<RestUserMessage>

Overrides

RestTextChannel.SendMessageAsync(String, Boolean, Embed, RequestOptions, AllowedMentions, MessageReference, MessageComponent, ISticker[], Embed[], MessageFlags)

| Improve this Doc View Source

TriggerTypingAsync(RequestOptions)

Declaration

public override Task TriggerTypingAsync(RequestOptions options = null)

Parameters

Type	Name	Description
RequestOptions	options

Returns

Type	Description
Task

Overrides

RestTextChannel.TriggerTypingAsync(RequestOptions)

Implements