The ClientState object that allows you to access current client memory information like actors, territories, etc.
@@ -197,7 +197,7 @@ Improve this Doc - View Source + View SourceThe CommandManager object that allows you to add and remove custom chat commands.
@@ -227,7 +227,7 @@ Improve this Doc - View Source + View SourceA DataManager instance which allows you to access game data needed by the main dalamud features.
@@ -257,7 +257,7 @@ Improve this Doc - View Source + View SourceThe Framework object that allows you to interact with the client.
@@ -287,7 +287,7 @@ Improve this Doc - View Source + View SourceA SigScanner instance targeting the main module of the FFXIV process.
@@ -317,7 +317,7 @@ Improve this Doc - View Source + View SourceA UiBuilder instance which allows you to draw UI into the game via ImGui draw calls.
@@ -349,7 +349,7 @@ Improve this Doc - View Source + View SourceThe current configuration.
+Send a message to all subscribed plugins.
+public void SendMessage(ExpandoObject message)| Type | +Name | +Description | +
|---|---|---|
| System.Dynamic.ExpandoObject | +message | +The message to send. + |
+
Subscribe to an IPC message by a plugin.
+public void Subscribe(string pluginName, Action<ExpandoObject> action)| Type | +Name | +Description | +
|---|---|---|
| System.String | +pluginName | +The InternalName of the plugin to subscribe to. + |
+
| System.Action<System.Dynamic.ExpandoObject> | +action | +The action to take when a message was received. + |
+
Unsubscribe from messages from a plugin.
+public void Unsubscribe(string pluginName)| Type | +Name | +Description | +
|---|---|---|
| System.String | +pluginName | +The InternalName of the plugin to unsubscribe from. |
Gets the height of this attachment.
-The height of this attachment if it is a picture; otherwise null.
Gets the ID of this attachment.
-A snowflake ID associated with this attachment.
-Gets a proxied URL of this attachment.
-A string containing the proxied URL of this attachment.
-Gets the file size of this attachment.
-The size of this attachment in bytes.
-Gets the URL of this attachment.
-A string containing the URL of this attachment.
-Gets the width of this attachment.
-The width of this attachment if it is a picture; otherwise null.
public struct Cacheable<TEntity, TId>
+
where TEntity : IEntity<TId> where TId : IEquatable<TId>Gets the IDiscordClient that the command is executed with.
-Gets the IMessageChannel that the command is executed in.
-Gets the IDiscordClient that the command is executed with.
-Gets the IGuild that the command is executed in.
-Gets the IUserMessage that the command is interpreted from.
-Gets the IUser who executed the command.
-Gets the author field of this embed.
-The author field of the embed, or null if none is set.
Gets the color of this embed.
-The color of the embed present on the side of the embed, or null if none is set.
Gets the description of this embed.
-The description field of the embed.
-Gets the fields of the embed.
-An array of the fields of the embed.
-Gets the footer field of this embed.
-The author field of the embed, or null if none is set.
Gets the image of this embed.
-The image of the embed, or null if none is set.
Gets the provider of this embed.
-The source of the embed, or null if none is set.
Gets the thumbnail featured in this embed.
-The thumbnail featured in the embed, or null if none is set.
Gets the timestamp of this embed.
-A System.DateTimeOffset based on the timestamp present at the bottom left of the embed, or
-null if none is set.
Gets the title of this embed.
-The title of the embed.
-Gets the type of this embed.
-The type of the embed.
-Gets the title URL of this embed.
-A string containing the URL set in a title of the embed.
-Gets the video of this embed.
-The video of the embed, or null if none is set.
Gets the display name or Unicode representation of this emote.
-A string representing the display name or the Unicode representation (e.g. 🤔) of this emote.
Gets when the snowflake was created.
-A System.DateTimeOffset representing when the entity was first created.
-Gets the display name or Unicode representation of this emote.
-A string representing the display name or the Unicode representation (e.g. 🤔) of this emote.
Gets the details on what the player is currently doing.
-A string describing what the player is doing.
-Gets the flags that are relevant to this activity.
-The value of flags for this activity.
-This value is determined by bitwise OR-ing ActivityProperties values together.
-Gets the name of the activity.
-A string containing the name of the activity that the user is doing.
-Gets the type of the activity.
-The type of activity.
-public interface IEntity<TId>
+
where TId : IEquatable<TId>public static T? ToNullable<T>(this Optional<T> val)
+
where T : structGets the token type of the logged-in user.
-Gets the recommended shard count as suggested by Discord.
-The options to be used when sending the request.
-A task that represents the asynchronous get operation. The task result contains an System.Int32 -that represents the number of shards that should be used with this account.
-Gets the current state of connection.
-Creates a guild for the logged-in user who is in less than 10 active guilds.
-The name of the new guild.
-The voice region to create the guild with.
-The icon of the guild.
-The options to be used when sending the request.
-A task that represents the asynchronous creation operation. The task result contains the created guild.
-This method creates a new guild on behalf of the logged-in user.
-- Due to Discord's limitation, this method will only work for users that are in less than 10 guilds. -
| RequestOptions | options | -The options to be used when sending the request. - |
+
A task that represents the asynchronous get operation. The task result contains the application -information.
-This method reflects your application information you submitted when creating a Discord application via -the Developer Portal.
-Gets a generic channel.
-The snowflake identifier of the channel (e.g. 381889909113225237).
The CacheMode that determines whether the object should be fetched from cache.
-The options to be used when sending the request.
-A task that represents the asynchronous get operation. The task result contains the channel associated
-with the snowflake identifier; null when the channel cannot be found.
null when the channel cannot be foun
Gets the connections that the user has set up.
-null when the channel cannot be foun
The options to be used when sending the request.
-null when the channel cannot be foun
A task that represents the asynchronous get operation. The task result contains a read-only collection of connections.
-null when the channel cannot be foun
Gets a collection of direct message channels opened in this session.
-null when the channel cannot be foun
The CacheMode that determines whether the object should be fetched from cache.
-The options to be used when sending the request.
-null when the channel cannot be foun
A task that represents the asynchronous get operation. The task result contains a read-only collection -of direct-message channels that the user currently partakes in.
-This method returns a collection of currently opened direct message channels.
-- This method will not return previously opened DM channels outside of the current session! If you - have just started the client, this may return an empty collection. -
Gets a collection of group channels opened in this session.
-The CacheMode that determines whether the object should be fetched from cache.
-The options to be used when sending the request.
-A task that represents the asynchronous get operation. The task result contains a read-only collection -of group channels that the user currently partakes in.
-This method returns a collection of currently opened group channels.
-- This method will not return previously opened group channels outside of the current session! If you - have just started the client, this may return an empty collection. -
Gets a guild.
-The guild snowflake identifier.
-The CacheMode that determines whether the object should be fetched from cache.
-The options to be used when sending the request.
-A task that represents the asynchronous get operation. The task result contains the guild associated
-with the snowflake identifier; null when the guild cannot be found.
null when the guild cannot be found.
Gets a collection of guilds that the user is currently in.
-null when the guild cannot be found.
The CacheMode that determines whether the object should be fetched from cache.
-The options to be used when sending the request.
-null when the guild cannot be found.
A task that represents the asynchronous get operation. The task result contains a read-only collection -of guilds that the current user is in.
-Gets an invite.
-The invitation identifier.
-The options to be used when sending the request.
-A task that represents the asynchronous get operation. The task result contains the invite information.
-Gets a collection of private channels opened in this session.
-The CacheMode that determines whether the object should be fetched from cache.
-The options to be used when sending the request.
-A task that represents the asynchronous get operation. The task result contains a read-only collection -of private channels that the user currently partakes in.
-This method will retrieve all private channels (including direct-message, group channel and such) that -are currently opened in this session.
-- This method will not return previously opened private channels outside of the current session! If - you have just started the client, this may return an empty collection. -
Gets a user.
-The name of the user (e.g. Still).
The discriminator value of the user (e.g. 2876).
The options to be used when sending the request.
-A task that represents the asynchronous get operation. The task result contains the user associated with
-the name and the discriminator; null if the user is not found.
null if the user is not found.
Gets a user.
-null if the user is not found.
The snowflake identifier of the user (e.g. 168693960628371456).
The CacheMode that determines whether the object should be fetched from cache.
-The options to be used when sending the request.
-null if the user is not found.
A task that represents the asynchronous get operation. The task result contains the user associated with
-the snowflake identifier; null if the user is not found.
null if the user is not found.
Gets a voice region.
-null if the user is not found.
The identifier of the voice region (e.g. eu-central ).
The options to be used when sending the request.
-null if the user is not found.
A task that represents the asynchronous get operation. The task result contains the voice region
-associated with the identifier; null if the voice region is not found.
null if the voice region is not fou
Gets a collection of the available voice regions.
-null if the voice region is not fou
The options to be used when sending the request.
-null if the voice region is not fou
A task that represents the asynchronous get operation. The task result contains a read-only collection -with all of the available voice regions in this session.
-Gets a webhook available.
-The identifier of the webhook.
-The options to be used when sending the request.
-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.
null if the webhook is not found.
Starts the connection between Discord and the client..
-null if the webhook is not found.
A task that represents the asynchronous start operation.
-This method will initialize the connection between the client and Discord.
-- This method will immediately return after it is called, as it will initialize the connection on - another thread. -
null if the webhook is not found.
Stops the connection between Discord and the client.
-null if the webhook is not found.
A task that represents the asynchronous stop operation.
-Creates a guild for the logged-in user who is in less than 10 active guilds.
-The name of the new guild.
-The voice region to create the guild with.
-The icon of the guild.
-The options to be used when sending the request.
-A task that represents the asynchronous creation operation. The task result contains the created guild.
-This method creates a new guild on behalf of the logged-in user.
-- Due to Discord's limitation, this method will only work for users that are in less than 10 guilds. -
Gets a Discord application information for the logged-in user.
-The options to be used when sending the request.
-A task that represents the asynchronous get operation. The task result contains the application -information.
-This method reflects your application information you submitted when creating a Discord application via -the Developer Portal.
-Gets a generic channel.
-The snowflake identifier of the channel (e.g. 381889909113225237).
The CacheMode that determines whether the object should be fetched from cache.
-The options to be used when sending the request.
-A task that represents the asynchronous get operation. The task result contains the channel associated
-with the snowflake identifier; null when the channel cannot be found.
null when the channel cannot be foun
Gets the connections that the user has set up.
-null when the channel cannot be foun
The options to be used when sending the request.
-null when the channel cannot be foun
A task that represents the asynchronous get operation. The task result contains a read-only collection of connections.
-null when the channel cannot be foun
Gets a collection of direct message channels opened in this session.
-null when the channel cannot be foun
The CacheMode that determines whether the object should be fetched from cache.
-The options to be used when sending the request.
-null when the channel cannot be foun
A task that represents the asynchronous get operation. The task result contains a read-only collection -of direct-message channels that the user currently partakes in.
-This method returns a collection of currently opened direct message channels.
-- This method will not return previously opened DM channels outside of the current session! If you - have just started the client, this may return an empty collection. -
Gets a collection of group channels opened in this session.
-The CacheMode that determines whether the object should be fetched from cache.
-The options to be used when sending the request.
-A task that represents the asynchronous get operation. The task result contains a read-only collection -of group channels that the user currently partakes in.
-This method returns a collection of currently opened group channels.
-- This method will not return previously opened group channels outside of the current session! If you - have just started the client, this may return an empty collection. -
Gets a guild.
-The guild snowflake identifier.
-The CacheMode that determines whether the object should be fetched from cache.
-The options to be used when sending the request.
-A task that represents the asynchronous get operation. The task result contains the guild associated
-with the snowflake identifier; null when the guild cannot be found.
null when the guild cannot be found.
Gets a collection of guilds that the user is currently in.
-null when the guild cannot be found.
The CacheMode that determines whether the object should be fetched from cache.
-The options to be used when sending the request.
-null when the guild cannot be found.
A task that represents the asynchronous get operation. The task result contains a read-only collection -of guilds that the current user is in.
-Gets a collection of private channels opened in this session.
-The CacheMode that determines whether the object should be fetched from cache.
-The options to be used when sending the request.
-A task that represents the asynchronous get operation. The task result contains a read-only collection -of private channels that the user currently partakes in.
-This method will retrieve all private channels (including direct-message, group channel and such) that -are currently opened in this session.
-- This method will not return previously opened private channels outside of the current session! If - you have just started the client, this may return an empty collection. -
Gets a user.
-The snowflake identifier of the user (e.g. 168693960628371456).
The CacheMode that determines whether the object should be fetched from cache.
-The options to be used when sending the request.
-A task that represents the asynchronous get operation. The task result contains the user associated with
-the snowflake identifier; null if the user is not found.
null if the user is not found.
Gets a voice region.
-null if the user is not found.
The identifier of the voice region (e.g. eu-central ).
The options to be used when sending the request.
-null if the user is not found.
A task that represents the asynchronous get operation. The task result contains the voice region
-associated with the identifier; null if the voice region is not found.
null if the voice region is not fou
Gets a collection of the available voice regions.
-null if the voice region is not fou
The options to be used when sending the request.
-null if the voice region is not fou
A task that represents the asynchronous get operation. The task result contains a read-only collection -with all of the available voice regions in this session.
-Gets a webhook available.
-The identifier of the webhook.
-The options to be used when sending the request.
-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.
Gets when the snowflake was created.
-A System.DateTimeOffset representing when the entity was first created.
-Gets the description of the application.
-Gets the icon URL of the application.
-Gets the name of the application.
-Gets the partial user object containing info on the owner of the application.
-Gets the RPC origins of the application.
-Gets the action which occurred to create this entry.
-The type of action for this audit log entry.
-Gets when the snowflake was created.
-A System.DateTimeOffset representing when the entity was first created.
-Gets the data for this entry.
-An IAuditLogData for this audit log entry; null if no data is available.
Gets the reason behind the change.
-A string containing the reason for the change; null if none is provided.
Gets the user responsible for causing the changes.
-A user object.
-Gets the reason why the user is banned if specified.
-A string containing the reason behind the ban; null if none is specified.
Gets the banned user.
-A user that was banned.
-Gets a user in this channel.
-The snowflake identifier of the user (e.g. 168693960628371456).
The CacheMode that determines whether the object should be fetched from cache.
-The options to be used when sending the request.
-A task that represents the asynchronous get operation. The task result contains a user object that
-represents the found user; null if none is found.
null if none is found.
Gets a collection of users that are able to view the channel or are currently in this channel.
-null if none is found.
The CacheMode that determines whether the object should be fetched from cache.
-The options to be used when sending the request.
-null if none is found.
Paged collection of users.
-- The returned collection is an asynchronous enumerable object; one must call -FlattenAsync<T>(IAsyncEnumerable<IEnumerable<T>>) to access the individual messages as a -collection. -
1000, the request will be split into 3 individual requests; thus returning 53individual asynchronous
-responses, hence the need of flattening.
-Updates this object's properties with its current state.
-Gets a user in this channel.
-The snowflake identifier of the user (e.g. 168693960628371456).
The CacheMode that determines whether the object should be fetched from cache.
-The options to be used when sending the request.
-A task that represents the asynchronous get operation. The task result contains a user object that
-represents the found user; null if none is found.
null if none is found.
Gets a collection of users that are able to view the channel or are currently in this channel.
-null if none is found.
The CacheMode that determines whether the object should be fetched from cache.
-The options to be used when sending the request.
-null if none is found.
Paged collection of users.
-- The returned collection is an asynchronous enumerable object; one must call -FlattenAsync<T>(IAsyncEnumerable<IEnumerable<T>>) to access the individual messages as a -collection. -
1000, the request will be split into 3 individual requests; thus returning 53individual asynchronous
-responses, hence the need of flattening.
-Gets the name of this channel.
-A string containing the name of this channel.
-Gets the ID of the connection account.
-A System.String representing the unique identifier value of this connection.
-Gets a System.Collections.Generic.IReadOnlyCollection<T> of integration IDs.
-An System.Collections.Generic.IReadOnlyCollection<T> containing System.UInt64 -representations of unique identifier values of integrations.
-Gets whether the connection is revoked.
-A value which if true indicates that this connection has been revoked, otherwise false.
-Gets the username of the connection account.
-A string containing the name of this connection.
-Gets the service of the connection (twitch, youtube).
-A string containing the name of this type of connection.
-Closes this private channel, removing it from your channel list.
-The options to be used when sending the request.
-A task that represents the asynchronous close operation.
-Deletes a message based on the provided message in this channel.
-The message that would be removed.
-The options to be used when sending the request.
-A task that represents the asynchronous removal operation.
-Deletes a message.
-The snowflake identifier of the message that would be removed.
-The options to be used when sending the request.
-A task that represents the asynchronous removal operation.
-Continuously broadcasts the "user is typing" message to all users in this channel until the returned -object is disposed.
-The options to be used when sending the request.
-A disposable object that, upon its disposal, will stop the client from broadcasting its typing state in -this channel.
-Gets a message from this message channel.
-The snowflake identifier of the message.
-The options to be used when sending the request.
-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.
This method follows the same behavior as described in GetMessageAsync(UInt64, CacheMode, RequestOptions). -Please visit its documentation for more details on this method.
-Gets a collection of messages in this channel.
-The starting message to get the messages from.
-The direction of the messages to be gotten from.
-The numbers of message to be gotten from.
-The options to be used when sending the request.
-Paged collection of messages.
-This method follows the same behavior as described in GetMessagesAsync(IMessage, Direction, Int32, CacheMode, RequestOptions). -Please visit its documentation for more details on this method.
-Gets the last N messages from this message channel.
-The numbers of message to be gotten from.
-The options to be used when sending the request.
-Paged collection of messages.
-This method follows the same behavior as described in GetMessagesAsync(Int32, CacheMode, RequestOptions). -Please visit its documentation for more details on this method.
-Gets a collection of messages in this channel.
-The ID of the starting message to get the messages from.
-The direction of the messages to be gotten from.
-The numbers of message to be gotten from.
-The options to be used when sending the request.
-Paged collection of messages.
-This method follows the same behavior as described in GetMessagesAsync(UInt64, Direction, Int32, CacheMode, RequestOptions). -Please visit its documentation for more details on this method.
-Gets a collection of pinned messages in this channel.
-The options to be used when sending the request.
-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.
-This method follows the same behavior as described in GetPinnedMessagesAsync(RequestOptions). -Please visit its documentation for more details on this method.
-Sends a file to this message channel with an optional caption.
-The System.IO.Stream of the file to be sent.
-The name of the attachment.
-The message to be sent.
-Whether the message should be read aloud by Discord or not.
-The options to be used when sending the request.
-A task that represents an asynchronous send operation for delivering the message. The task result -contains the sent message.
-This method follows the same behavior as described in SendFileAsync(Stream, String, String, Boolean, Embed, RequestOptions, Boolean). -Please visit its documentation for more details on this method.
-| System.String | filePath | -The file path of the file. - |
+ |
| System.String | text | -The message to be sent. - |
+ |
| System.Boolean | isTTS | -Whether the message should be read aloud by Discord or not. - |
+ |
| Embed | embed | -- | +|
| RequestOptions | options | -The options to be used when sending the request. - |
+ |
| System.Boolean | @@ -989,17 +909,10 @@ Please visit its documentation for more details on this method.|||
| System.Threading.Tasks.Task<RestUserMessage> | -A task that represents an asynchronous send operation for delivering the message. The task result -contains the sent message. - |
+
This method follows the same behavior as described in -SendFileAsync(String, String, Boolean, Embed, RequestOptions, Boolean). Please visit -its documentation for more details on this method.
-| System.String | text | -The message to be sent. - |
+ |
| System.Boolean | isTTS | -Determines whether the message should be read aloud by Discord or not. - |
+ |
| Embed | embed | -- | +|
| RequestOptions | options | -The options to be used when sending the request. - |
+
A task that represents an asynchronous send operation for delivering the message. The task result -contains the sent message.
-This method follows the same behavior as described in SendMessageAsync(String, Boolean, Embed, RequestOptions). -Please visit its documentation for more details on this method.
-| RequestOptions | options | -The options to be used when sending the request. - |
+
A task that represents the asynchronous operation that triggers the broadcast.
-Updates this object's properties with its current state.
-Gets a user in this channel.
-The snowflake identifier of the user (e.g. 168693960628371456).
The CacheMode that determines whether the object should be fetched from cache.
-The options to be used when sending the request.
-A task that represents the asynchronous get operation. The task result contains a user object that
-represents the found user; null if none is found.
null if none is found.
Gets a collection of users that are able to view the channel or are currently in this channel.
-null if none is found.
The CacheMode that determines whether the object should be fetched from cache.
-The options to be used when sending the request.
-null if none is found.
Paged collection of users.
-- The returned collection is an asynchronous enumerable object; one must call -FlattenAsync<T>(IAsyncEnumerable<IEnumerable<T>>) to access the individual messages as a -collection. -
1000, the request will be split into 3 individual requests; thus returning 53individual asynchronous
-responses, hence the need of flattening.
-Gets the name of this channel.
-A string containing the name of this channel.
-Gets the recipient of all messages in this channel.
-A user object that represents the other user in this channel.
-Gets a message from this message channel.
-The snowflake identifier of the message.
-The CacheMode that determines whether the object should be fetched from cache.
-The options to be used when sending the request.
-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.
null if no message is found with the specifi
Gets a collection of messages in this channel.
-null if no message is found with the specifi
The starting message to get the messages from.
-The direction of the messages to be gotten from.
-The numbers of message to be gotten from.
-The CacheMode that determines whether the object should be fetched from -cache.
-The options to be used when sending the request.
-Paged collection of messages.
-- The returned collection is an asynchronous enumerable object; one must call -FlattenAsync<T>(IAsyncEnumerable<IEnumerable<T>>) to access the individual messages as a -collection. -
- Do not fetch too many messages at once! This may cause unwanted preemptive rate limit or even actual - rate limit, causing your bot to freeze! -
limit around
-the message fromMessage depending on the dir. The library will
-attempt to split up the requests according to your limit and
-MaxMessagesPerBatch. In other words, should the user request 500 messages,
-and the MaxMessagesPerBatch constant is 100, the request will
-be split into 5 individual requests; thus returning 5 individual asynchronous responses, hence the need
-of flattening.
-Gets the last N messages from this message channel.
-The numbers of message to be gotten from.
-The CacheMode that determines whether the object should be fetched from -cache.
-The options to be used when sending the request.
-Paged collection of messages.
-- The returned collection is an asynchronous enumerable object; one must call -FlattenAsync<T>(IAsyncEnumerable<IEnumerable<T>>) to access the individual messages as a -collection. -
- Do not fetch too many messages at once! This may cause unwanted preemptive rate limit or even actual - rate limit, causing your bot to freeze! -
limit. The
-library will attempt to split up the requests according to your limit and
-MaxMessagesPerBatch. In other words, should the user request 500 messages,
-and the MaxMessagesPerBatch constant is 100, the request will
-be split into 5 individual requests; thus returning 5 individual asynchronous responses, hence the need
-of flattening.
-Gets a collection of messages in this channel.
-The ID of the starting message to get the messages from.
-The direction of the messages to be gotten from.
-The numbers of message to be gotten from.
-The CacheMode that determines whether the object should be fetched from -cache.
-The options to be used when sending the request.
-Paged collection of messages.
-- The returned collection is an asynchronous enumerable object; one must call -FlattenAsync<T>(IAsyncEnumerable<IEnumerable<T>>) to access the individual messages as a -collection. -
- Do not fetch too many messages at once! This may cause unwanted preemptive rate limit or even actual - rate limit, causing your bot to freeze! -
limit around
-the message fromMessageId depending on the dir. The library will
-attempt to split up the requests according to your limit and
-MaxMessagesPerBatch. In other words, should the user request 500 messages,
-and the MaxMessagesPerBatch constant is 100, the request will
-be split into 5 individual requests; thus returning 5 individual asynchronous responses, hence the need
-of flattening.
-Gets a collection of pinned messages in this channel.
-The options to be used when sending the request.
-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.
-Sends a file to this message channel with an optional caption.
-The System.IO.Stream of the file to be sent.
-The name of the attachment.
-The message to be sent.
-Whether the message should be read aloud by Discord or not.
-The options to be used when sending the request.
-Whether the message attachment should be hidden as a spoiler.
-A task that represents an asynchronous send operation for delivering the message. The task result -contains the sent message.
-This method sends a file as if you are uploading an attachment directly from your Discord client.
- -Sends a file to this message channel with an optional caption.
-The file path of the file.
-The message to be sent.
-Whether the message should be read aloud by Discord or not.
-The options to be used when sending the request.
-Whether the message attachment should be hidden as a spoiler.
-A task that represents an asynchronous send operation for delivering the message. The task result -contains the sent message.
-This method sends a file as if you are uploading an attachment directly from your Discord client.
- -Sends a message to this message channel.
-The message to be sent.
-Determines whether the message should be read aloud by Discord or not.
-The options to be used when sending the request.
-A task that represents an asynchronous send operation for delivering the message. The task result -contains the sent message.
-Gets the users that can access this channel.
-A read-only collection of users that can access this channel.
-Users that can access this channel.
-Gets the name of this channel.
-A string containing the name of this channel.
-Deletes a message based on the provided message in this channel.
-The message that would be removed.
-The options to be used when sending the request.
-A task that represents the asynchronous removal operation.
-Deletes a message.
-The snowflake identifier of the message that would be removed.
-The options to be used when sending the request.
-A task that represents the asynchronous removal operation.
-Continuously broadcasts the "user is typing" message to all users in this channel until the returned -object is disposed.
-The options to be used when sending the request.
-A disposable object that, upon its disposal, will stop the client from broadcasting its typing state in -this channel.
-Gets a message from this message channel.
-The snowflake identifier of the message.
-The options to be used when sending the request.
-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.
This method follows the same behavior as described in GetMessageAsync(UInt64, CacheMode, RequestOptions). -Please visit its documentation for more details on this method.
-Gets a collection of messages in this channel.
-The starting message to get the messages from.
-The direction of the messages to be gotten from.
-The numbers of message to be gotten from.
-The options to be used when sending the request.
-Paged collection of messages.
-This method follows the same behavior as described in GetMessagesAsync(IMessage, Direction, Int32, CacheMode, RequestOptions). -Please visit its documentation for more details on this method.
-Gets the last N messages from this message channel.
-The numbers of message to be gotten from.
-The options to be used when sending the request.
-Paged collection of messages.
-This method follows the same behavior as described in GetMessagesAsync(Int32, CacheMode, RequestOptions). -Please visit its documentation for more details on this method.
-Gets a collection of messages in this channel.
-The ID of the starting message to get the messages from.
-The direction of the messages to be gotten from.
-The numbers of message to be gotten from.
-The options to be used when sending the request.
-Paged collection of messages.
-This method follows the same behavior as described in GetMessagesAsync(UInt64, Direction, Int32, CacheMode, RequestOptions). -Please visit its documentation for more details on this method.
-Gets a collection of pinned messages in this channel.
-The options to be used when sending the request.
-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.
-This method follows the same behavior as described in GetPinnedMessagesAsync(RequestOptions). -Please visit its documentation for more details on this method.
-Leaves this group.
-The options to be used when sending the request.
-A task that represents the asynchronous leave operation.
-Sends a file to this message channel with an optional caption.
-The System.IO.Stream of the file to be sent.
-The name of the attachment.
-The message to be sent.
-Whether the message should be read aloud by Discord or not.
-The options to be used when sending the request.
-A task that represents an asynchronous send operation for delivering the message. The task result -contains the sent message.
-This method follows the same behavior as described in SendFileAsync(Stream, String, String, Boolean, Embed, RequestOptions, Boolean). -Please visit its documentation for more details on this method.
-| System.String | filePath | -The file path of the file. - |
+ |
| System.String | text | -The message to be sent. - |
+ |
| System.Boolean | isTTS | -Whether the message should be read aloud by Discord or not. - |
+ |
| Embed | embed | -- | +|
| RequestOptions | options | -The options to be used when sending the request. - |
+ |
| System.Boolean | @@ -990,17 +908,10 @@ Please visit its documentation for more details on this method.|||
| System.Threading.Tasks.Task<RestUserMessage> | -A task that represents an asynchronous send operation for delivering the message. The task result -contains the sent message. - |
+
This method follows the same behavior as described in -SendFileAsync(String, String, Boolean, Embed, RequestOptions, Boolean). Please visit -its documentation for more details on this method.
-| System.String | text | -The message to be sent. - |
+ |
| System.Boolean | isTTS | -Determines whether the message should be read aloud by Discord or not. - |
+ |
| Embed | embed | -- | +|
| RequestOptions | options | -The options to be used when sending the request. - |
+
A task that represents an asynchronous send operation for delivering the message. The task result -contains the sent message.
-This method follows the same behavior as described in SendMessageAsync(String, Boolean, Embed, RequestOptions). -Please visit its documentation for more details on this method.
-| RequestOptions | options | -The options to be used when sending the request. - |
+
A task that represents the asynchronous operation that triggers the broadcast.
-Updates this object's properties with its current state.
-Connects to this audio channel.
-Determines whether the client should deaf itself upon connection.
-Determines whether the client should mute itself upon connection.
-Determines whether the audio client is an external one or not.
-A task representing the asynchronous connection operation. The task result contains the -IAudioClient responsible for the connection.
-Gets a value that indicates whether this user is deafened by the guild.
-true if the user is deafened (i.e. not permitted to listen to or speak to others) by the guild;
-otherwise false.
false.
Gets a value that indicates whether this user is muted (i.e. not permitted to speak via voice) by the -guild.
-true if this user is muted by the guild; otherwise false.
Gets a value that indicates whether this user has marked themselves as deafened.
-true if this user has deafened themselves (i.e. not permitted to listen to or speak to others); otherwise false.
Gets a value that indicates whether this user has marked themselves as muted (i.e. not permitted to -speak via voice).
-true if this user has muted themselves; otherwise false.
Gets a value that indicates if this user is streaming in a voice channel.
-true if the user is streaming; otherwise false.
Gets a value that indicates whether the user is muted by the current user.
-true if the guild is temporarily blocking audio to/from this user; otherwise false.
Gets the voice channel this user is currently in.
-A generic voice channel object representing the voice channel that the user is currently in; null
-if none.
Gets the unique identifier for this user's voice session.
-Gets the ID of the AFK voice channel for this guild.
-A System.UInt64 representing the snowflake identifier of the AFK voice channel; null if
-none is set.
Gets the amount of time (in seconds) a user must be inactive in a voice channel for until they are -automatically moved to the AFK voice channel.
-An System.Int32 representing the amount of time in seconds for a user to be marked as inactive -and moved into the AFK voice channel.
-Gets the application ID of the guild creator if it is bot-created.
-A System.UInt64 representing the snowflake identifier of the application ID that created this guild, or null if it was not bot-created.
Gets the identifier for this guilds banner image.
-An identifier for the banner image; null if none is set.
Gets the URL of this guild's banner image.
-A URL pointing to the guild's banner image; null if none is set.
Gets when the snowflake was created.
-A System.DateTimeOffset representing when the entity was first created.
-Gets the default message notifications for users who haven't explicitly set their notification settings.
-Gets the description for the guild.
-The description for the guild; null if none is set.
Gets the ID of the widget embed channel of this guild.
-A System.UInt64 representing the snowflake identifier of the embedded channel found within the
-widget settings of this guild; null if none is set.
null if none is set.
Gets a collection of all custom emotes for this guild.
-null if none is set.
A read-only collection of all custom emotes for this guild.
-null if none is set.
Gets the level of content filtering applied to user's content in a Guild.
-null if none is set.
The level of explicit content filtering.
-null if none is set.
Gets a collection of all extra features added to this guild.
-null if none is set.
A read-only collection of enabled features in this guild.
-null if none is set.
Gets the ID of this guild's icon.
-null if none is set.
An identifier for the splash image; null if none is set.
null if none is set.
Gets the URL of this guild's icon.
-null if none is set.
A URL pointing to the guild's icon; null if none is set.
null if none is set.
Gets a value that indicates whether this guild is embeddable (i.e. can use widget).
-null if none is set.
true if this guild can be embedded via widgets; otherwise false.
null if none is set.
Gets the level of Multi-Factor Authentication requirements a user must fulfill before being allowed to -perform administrative actions in this guild.
-The level of MFA requirement.
-Gets the name of this guild.
-A string containing the name of this guild.
-Gets the ID of the user that owns this guild.
-A System.UInt64 representing the snowflake identifier of the user that owns this guild.
-Gets the preferred culture of this guild.
-The preferred culture information of this guild.
-Gets the preferred locale of this guild in IETF BCP 47 -language tag format.
-The preferred locale of the guild in IETF BCP 47 -language tag format.
-Gets the number of premium subscribers of this guild.
-The number of premium subscribers of this guild.
-This is the number of users who have boosted this guild.
-Gets the tier of guild boosting in this guild.
-The tier of guild boosting in this guild.
-Gets the ID of this guild's splash image.
-An identifier for the splash image; null if none is set.
Gets the URL of this guild's splash image.
-A URL pointing to the guild's splash image; null if none is set.
Gets the flags for the types of system channel messages that are disabled.
-The flags for the types of system channel messages that are disabled.
-Gets the ID of the channel where randomized welcome messages are sent.
-A System.UInt64 representing the snowflake identifier of the system channel where randomized
-welcome messages are sent; null if none is set.
null if none is set.
Gets the code for this guild's vanity invite URL.
-null if none is set.
A string containing the vanity invite code for this guild; null if none is set.
null if none is set.
Gets the level of requirements a user must fulfill before being allowed to post messages in this guild.
-null if none is set.
The level of requirements.
-null if none is set.
Gets the ID of the region hosting this guild's voice channels.
-null if none is set.
A string containing the identifier for the voice region that this guild uses (e.g. eu-central).
null if none is set.
Bans the user from this guild and optionally prunes their recent messages.
-null if none is set.
The user to ban.
-The number of days to remove messages from this user for, and this number must be between [0, 7].
-The reason of the ban to be written in the audit log.
-The options to be used when sending the request.
-null if none is set.
A task that represents the asynchronous add operation for the ban.
-| Type | -Condition | -|
|---|---|---|
| System.ArgumentException | -
|
+
null if none is set.
Bans the user from this guild and optionally prunes their recent messages.
-null if none is set.
The snowflake ID of the user to ban.
-The number of days to remove messages from this user for, and this number must be between [0, 7].
-The reason of the ban to be written in the audit log.
-The options to be used when sending the request.
-null if none is set.
A task that represents the asynchronous add operation for the ban.
-| Type | -Condition | -|
|---|---|---|
| System.ArgumentException | -
|
+
null if none is set.
Creates a new GuildEmote in this guild.
-null if none is set.
The name of the guild emote.
-The image of the new emote.
-The roles to limit the emote usage to.
-The options to be used when sending the request.
-null if none is set.
A task that represents the asynchronous creation operation. The task result contains the created emote.
-Deletes this object and all its children.
-The options to be used when sending the request.
-Deletes an existing GuildEmote from this guild.
-The emote to delete.
-The options to be used when sending the request.
-A task that represents the asynchronous removal operation.
-null if none is set.
Gets a specific emote from this guild.
-null if none is set.
The snowflake identifier for the guild emote.
-The options to be used when sending the request.
-null if none is set.
A task that represents the asynchronous get operation. The task result contains the emote found with the
-specified id; null if none is found.
Leaves this guild.
-The options to be used when sending the request.
-A task that represents the asynchronous leave operation.
-This method will make the currently logged-in user leave the guild.
-- If the user is the owner of this guild, use DeleteAsync(RequestOptions) instead. -
Modifies this guild.
-The delegate containing the properties to modify the guild with.
-The options to be used when sending the request.
-A task that represents the asynchronous modification operation.
-Modifies this guild's embed channel.
-The delegate containing the properties to modify the guild widget with.
-The options to be used when sending the request.
-A task that represents the asynchronous modification operation.
-Modifies an existing GuildEmote in this guild.
-The emote to be modified.
-The delegate containing the properties to modify the emote with.
-The options to be used when sending the request.
-A task that represents the asynchronous modification operation. The task result contains the modified -emote.
-Unbans the user if they are currently banned.
-The user to be unbanned.
-The options to be used when sending the request.
-A task that represents the asynchronous removal operation for the ban.
-Unbans the user if they are currently banned.
-The snowflake identifier of the user to be unbanned.
-The options to be used when sending the request.
-A task that represents the asynchronous removal operation for the ban.
-Bulk-modifies the order of channels in this guild.
-The properties used to modify the channel positions with.
-The options to be used when sending the request.
-A task that represents the asynchronous reorder operation.
-Bulk-modifies the order of roles in this guild.
-The properties used to modify the role positions with.
-The options to be used when sending the request.
-A task that represents the asynchronous reorder operation.
-Updates this object's properties with its current state.
-Adds a user to this guild.
-The snowflake identifier of the user.
-The OAuth2 access token for the user, requested with the guilds.join scope.
-The delegate containing the properties to be applied to the user upon being added to the guild.
-The options to be used when sending the request.
-A guild user associated with the specified userId; null if the user is already in the guild.
This method requires you have an OAuth2 access token for the user, requested with the guilds.join scope, and that the bot have the MANAGE_INVITES permission in the guild.
-Gets the IAudioClient currently associated with this guild.
-An IAudioClient currently associated with this guild.
-Determines if this guild is currently connected and ready to be used.
-true if this guild is currently connected and ready to be used; otherwise false.
- This property only applies to a WebSocket-based client. -
Creates a new channel category in this guild.
-The new name for the category.
-The delegate containing the properties to be applied to the channel upon its creation.
-The options to be used when sending the request.
-A task that represents the asynchronous creation operation. The task result contains the newly created -category channel.
-Creates a new role with the provided name.
-The new name for the role.
-The guild permission that the role should possess.
-The color of the role.
-Whether the role is separated from others on the sidebar.
-The options to be used when sending the request.
-A task that represents the asynchronous creation operation. The task result contains the newly created -role.
-Creates a new role with the provided name.
-The new name for the role.
-The guild permission that the role should possess.
-The color of the role.
-Whether the role is separated from others on the sidebar.
-Whether the role can be mentioned.
-The options to be used when sending the request.
-A task that represents the asynchronous creation operation. The task result contains the newly created -role.
-Creates a new text channel in this guild.
-The new name for the text channel.
-The delegate containing the properties to be applied to the channel upon its creation.
-The options to be used when sending the request.
-A task that represents the asynchronous creation operation. The task result contains the newly created -text channel.
-Creates a new voice channel in this guild.
-The new name for the voice channel.
-The delegate containing the properties to be applied to the channel upon its creation.
-The options to be used when sending the request.
-A task that represents the asynchronous creation operation. The task result contains the newly created -voice channel.
-Downloads all users for this guild if the current list is incomplete.
-A task that represents the asynchronous download operation.
-Gets the built-in role containing all users in this guild.
-A role object that represents an @everyone role in this guild.
Gets the AFK voice channel in this guild.
-The CacheMode that determines whether the object should be fetched from cache.
-The options to be used when sending the request.
-A task that represents the asynchronous get operation. The task result contains the voice channel that the
-AFK users will be moved to after they have idled for too long; null if none is set.
null
Gets a ban object for a banned user.
-null
The banned user.
-The options to be used when sending the request.
-null
A task that represents the asynchronous get operation. The task result contains a ban object, which
-contains the user information and the reason for the ban; null if the ban entry cannot be found.
null if t
Gets a ban object for a banned user.
-null if t
The snowflake identifier for the banned user.
-The options to be used when sending the request.
-null if t
A task that represents the asynchronous get operation. The task result contains a ban object, which
-contains the user information and the reason for the ban; null if the ban entry cannot be found.
null if t
Gets a collection of all users banned in this guild.
-null if t
The options to be used when sending the request.
-null if t
A task that represents the asynchronous get operation. The task result contains a read-only collection of -ban objects that this guild currently possesses, with each object containing the user banned and reason -behind the ban.
-Gets a collection of all category channels in this guild.
-The CacheMode that determines whether the object should be fetched from cache.
-The options to be used when sending the request.
-A task that represents the asynchronous get operation. The task result contains a read-only collection of -category channels found within this guild.
-Gets a channel in this guild.
-The snowflake identifier for the channel.
-The CacheMode that determines whether the object should be fetched from cache.
-The options to be used when sending the request.
-A task that represents the asynchronous get operation. The task result contains the generic channel
-associated with the specified id; null if none is found.
IGuild.GetChannelsAsync(CacheMode, RequestOptions)
- Gets a collection of all channels in this guild.
-
+
Declaration
@@ -5184,14 +4925,12 @@ associated with the specified CacheMode
mode
- The CacheMode that determines whether the object should be fetched from cache.
-
RequestOptions
options
- The options to be used when sending the request.
-
@@ -5206,9 +4945,7 @@ associated with the specified System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IGuildChannel>>
- A task that represents the asynchronous get operation. The task result contains a read-only collection of
-generic channels found within this guild.
-IGuild.GetCurrentUserAsync(CacheMode, RequestOptions)
- Gets the current user for this guild.
-
+
Declaration
@@ -5241,14 +4977,12 @@ generic channels found within this guild.
CacheMode
mode
- The CacheMode that determines whether the object should be fetched from cache.
-
RequestOptions
options
- The options to be used when sending the request.
-
@@ -5263,9 +4997,7 @@ generic channels found within this guild.
System.Threading.Tasks.Task<IGuildUser>
- A task that represents the asynchronous get operation. The task result contains the currently logged-in
-user within this guild.
-
@@ -5278,8 +5010,7 @@ user within this guild.
IGuild.GetDefaultChannelAsync(CacheMode, RequestOptions)
- Gets the first viewable text channel in this guild.
-
+
Declaration
@@ -5298,14 +5029,12 @@ user within this guild.
CacheMode
mode
- The CacheMode that determines whether the object should be fetched from cache.
-
RequestOptions
options
- The options to be used when sending the request.
-
@@ -5320,9 +5049,7 @@ user within this guild.
System.Threading.Tasks.Task<ITextChannel>
- A task that represents the asynchronous get operation. The task result contains the first viewable text
-channel in this guild; null if none is found.
-
@@ -5335,8 +5062,7 @@ channel in this guild; null if none is found.
IGuild.GetEmbedChannelAsync(CacheMode, RequestOptions)
- Gets the embed channel (i.e. the channel set in the guild's widget settings) in this guild.
-
+
Declaration
@@ -5355,14 +5081,12 @@ channel in this guild; null if none is found.
CacheMode
mode
- The CacheMode that determines whether the object should be fetched from cache.
-
RequestOptions
options
- The options to be used when sending the request.
-
@@ -5377,9 +5101,7 @@ channel in this guild; null if none is found.
System.Threading.Tasks.Task<IGuildChannel>
- A task that represents the asynchronous get operation. The task result contains the embed channel set
-within the server's widget settings; null if none is set.
-
@@ -5439,8 +5161,7 @@ within the server's widget settings; null if none is set.
IGuild.GetInvitesAsync(RequestOptions)
- Gets a collection of all invites in this guild.
-
+
Declaration
@@ -5459,8 +5180,7 @@ within the server's widget settings; null if none is set.
RequestOptions
options
- The options to be used when sending the request.
-
@@ -5475,9 +5195,7 @@ within the server's widget settings; null if none is set.
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IInviteMetadata>>
- A task that represents the asynchronous get operation. The task result contains a read-only collection of
-invite metadata, each representing information for an invite found within this guild.
-
@@ -5490,8 +5208,7 @@ invite metadata, each representing information for an invite found within this g
IGuild.GetOwnerAsync(CacheMode, RequestOptions)
- Gets the owner of this guild.
-
+
Declaration
@@ -5510,14 +5227,12 @@ invite metadata, each representing information for an invite found within this g
CacheMode
mode
- The CacheMode that determines whether the object should be fetched from cache.
-
RequestOptions
options
- The options to be used when sending the request.
-
@@ -5532,8 +5247,7 @@ invite metadata, each representing information for an invite found within this g
System.Threading.Tasks.Task<IGuildUser>
- A task that represents the asynchronous get operation. The task result contains the owner of this guild.
-
@@ -5546,8 +5260,7 @@ invite metadata, each representing information for an invite found within this g
IGuild.GetRole(UInt64)
- Gets a role in this guild.
-
+
Declaration
@@ -5566,8 +5279,7 @@ invite metadata, each representing information for an invite found within this g
System.UInt64
id
- The snowflake identifier for the role.
-
@@ -5582,8 +5294,7 @@ invite metadata, each representing information for an invite found within this g
IRole
- A role that is associated with the specified id; null if none is found.
-
@@ -5596,8 +5307,7 @@ invite metadata, each representing information for an invite found within this g
IGuild.GetSystemChannelAsync(CacheMode, RequestOptions)
- Gets the system channel where randomized welcome messages are sent in this guild.
-
+
Declaration
@@ -5616,14 +5326,12 @@ invite metadata, each representing information for an invite found within this g
CacheMode
mode
- The CacheMode that determines whether the object should be fetched from cache.
-
RequestOptions
options
- The options to be used when sending the request.
-
@@ -5638,9 +5346,7 @@ invite metadata, each representing information for an invite found within this g
System.Threading.Tasks.Task<ITextChannel>
- A task that represents the asynchronous get operation. The task result contains the text channel where
-randomized welcome messages will be sent to; null if none is set.
-
@@ -5653,8 +5359,7 @@ randomized welcome messages will be sent to; null if none is set.
IGuild.GetTextChannelAsync(UInt64, CacheMode, RequestOptions)
- Gets a text channel in this guild.
-
+
Declaration
@@ -5673,20 +5378,17 @@ randomized welcome messages will be sent to; null if none is set.
System.UInt64
id
- The snowflake identifier for the text channel.
-
CacheMode
mode
- The CacheMode that determines whether the object should be fetched from cache.
-
RequestOptions
options
- The options to be used when sending the request.
-
@@ -5701,9 +5403,7 @@ randomized welcome messages will be sent to; null if none is set.
System.Threading.Tasks.Task<ITextChannel>
- A task that represents the asynchronous get operation. The task result contains the text channel
-associated with the specified id; null if none is found.
-
@@ -5716,8 +5416,7 @@ associated with the specified
IGuild.GetTextChannelsAsync(CacheMode, RequestOptions)
- Gets a collection of all text channels in this guild.
-
+
Declaration
@@ -5736,14 +5435,12 @@ associated with the specified CacheMode
mode
- The CacheMode that determines whether the object should be fetched from cache.
-
RequestOptions
options
- The options to be used when sending the request.
-
@@ -5758,9 +5455,7 @@ associated with the specified System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<ITextChannel>>
- A task that represents the asynchronous get operation. The task result contains a read-only collection of
-message channels found within this guild.
-IGuild.GetUserAsync(UInt64, CacheMode, RequestOptions)
- Gets a user from this guild.
-
+
Declaration
@@ -5793,20 +5487,17 @@ message channels found within this guild.
System.UInt64
id
- The snowflake identifier of the user.
-
CacheMode
mode
- The CacheMode that determines whether the object should be fetched from cache.
-
RequestOptions
options
- The options to be used when sending the request.
-
@@ -5821,19 +5512,10 @@ message channels found within this guild.
System.Threading.Tasks.Task<IGuildUser>
- A task that represents the asynchronous get operation. The task result contains the guild user
-associated with the specified id; null if none is found.
-
- Remarks
- This method retrieves a user found within this guild.
-note
- This may return null in the WebSocket implementation due to incomplete user collection in
- large guilds.
-
-
|
Improve this Doc
@@ -5843,8 +5525,7 @@ associated with the specified
IGuild.GetUsersAsync(CacheMode, RequestOptions)
- Gets a collection of all users in this guild.
-
+
Declaration
@@ -5863,14 +5544,12 @@ associated with the specified CacheMode
mode
- The CacheMode that determines whether the object should be fetched from cache.
-
RequestOptions
options
- The options to be used when sending the request.
-
@@ -5885,19 +5564,10 @@ associated with the specified System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IGuildUser>>
- A task that represents the asynchronous get operation. The task result contains a collection of guild
-users found within this guild.
-Remarks
- This method retrieves all users found within this guild.
-note
- This may return an incomplete collection in the WebSocket implementation due to how Discord does not
- send a complete user list for large guilds.
-
-
|
Improve this Doc
@@ -5907,8 +5577,7 @@ users found within this guild.
IGuild.GetVanityInviteAsync(RequestOptions)
- Gets the vanity invite URL of this guild.
-
+
Declaration
@@ -5927,8 +5596,7 @@ users found within this guild.
RequestOptions
options
- The options to be used when sending the request.
-
@@ -5943,9 +5611,7 @@ users found within this guild.
System.Threading.Tasks.Task<IInviteMetadata>
- A task that represents the asynchronous get operation. The task result contains the partial metadata of
-the vanity invite found within this guild; null if none is found.
-
@@ -5958,8 +5624,7 @@ the vanity invite found within this guild; null if none is found.
IGuild.GetVoiceChannelAsync(UInt64, CacheMode, RequestOptions)
- Gets a voice channel in this guild.
-
+
Declaration
@@ -5978,20 +5643,17 @@ the vanity invite found within this guild; null if none is found.
System.UInt64
id
- The snowflake identifier for the voice channel.
-
CacheMode
mode
- The CacheMode that determines whether the object should be fetched from cache.
-
RequestOptions
options
- The options to be used when sending the request.
-
@@ -6006,9 +5668,7 @@ the vanity invite found within this guild; null if none is found.
System.Threading.Tasks.Task<IVoiceChannel>
- A task that represents the asynchronous get operation. The task result contains the voice channel associated
-with the specified id; null if none is found.
-
@@ -6021,8 +5681,7 @@ with the specified id
IGuild.GetVoiceChannelsAsync(CacheMode, RequestOptions)
- Gets a collection of all voice channels in this guild.
-
+
Declaration
@@ -6041,14 +5700,12 @@ with the specified id
CacheMode
mode
- The CacheMode that determines whether the object should be fetched from cache.
-
RequestOptions
options
- The options to be used when sending the request.
-
@@ -6063,9 +5720,7 @@ with the specified id
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IVoiceChannel>>
- A task that represents the asynchronous get operation. The task result contains a read-only collection of
-voice channels found within this guild.
-
@@ -6078,8 +5733,7 @@ voice channels found within this guild.
IGuild.GetVoiceRegionsAsync(RequestOptions)
- Gets a collection of all the voice regions this guild can access.
-
+
Declaration
@@ -6098,8 +5752,7 @@ voice channels found within this guild.
RequestOptions
options
- The options to be used when sending the request.
-
@@ -6114,9 +5767,7 @@ voice channels found within this guild.
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IVoiceRegion>>
- A task that represents the asynchronous get operation. The task result contains a read-only collection of
-voice regions the guild can access.
-
@@ -6129,8 +5780,7 @@ voice regions the guild can access.
IGuild.GetWebhookAsync(UInt64, RequestOptions)
- Gets a webhook found within this guild.
-
+
Declaration
@@ -6149,14 +5799,12 @@ voice regions the guild can access.
System.UInt64
id
- The identifier for the webhook.
-
RequestOptions
options
- The options to be used when sending the request.
-
@@ -6171,9 +5819,7 @@ voice regions the guild can access.
System.Threading.Tasks.Task<IWebhook>
- A task that represents the asynchronous get operation. The task result contains the webhook with the
-specified id; null if none is found.
-
@@ -6186,8 +5832,7 @@ specified id;
IGuild.GetWebhooksAsync(RequestOptions)
- Gets a collection of all webhook from this guild.
-
+
Declaration
@@ -6206,8 +5851,7 @@ specified id;
RequestOptions
options
- The options to be used when sending the request.
-id;
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IWebhook>>
- A task that represents the asynchronous get operation. The task result contains a read-only collection
-of webhooks found within the guild.
-
@@ -6237,8 +5879,7 @@ of webhooks found within the guild.
IGuild.Roles
- Gets a collection of all roles in this guild.
-
+
Declaration
@@ -6255,8 +5896,7 @@ of webhooks found within the guild.
System.Collections.Generic.IReadOnlyCollection<IRole>
- A read-only collection of roles found within this guild.
-
diff --git a/docs/api/Discord.Rest.RestGuildChannel.html b/docs/api/Discord.Rest.RestGuildChannel.html
index 42a982338..8780e0e73 100644
--- a/docs/api/Discord.Rest.RestGuildChannel.html
+++ b/docs/api/Discord.Rest.RestGuildChannel.html
@@ -142,8 +142,7 @@
GuildId
- Gets the guild ID associated with this channel.
-
+
Declaration
@@ -160,9 +159,7 @@
System.UInt64
- An System.UInt64 representing the guild snowflake identifier for the guild that this channel
-belongs to.
-
@@ -175,8 +172,7 @@ belongs to.
Name
- Gets the name of this channel.
-
+
Declaration
@@ -193,8 +189,7 @@ belongs to.
System.String
- A string containing the name of this channel.
-
@@ -207,8 +202,7 @@ belongs to.
PermissionOverwrites
- Gets a collection of permission overwrites for this channel.
-
+
Declaration
@@ -225,8 +219,7 @@ belongs to.
System.Collections.Generic.IReadOnlyCollection<Overwrite>
- A collection of overwrites associated with this channel.
-
@@ -239,8 +232,7 @@ belongs to.
Position
- Gets the position of this channel.
-
+
Declaration
@@ -257,9 +249,7 @@ belongs to.
System.Int32
- An System.Int32 representing the position of this channel in the guild's channel list relative to
-others of the same type.
-
@@ -398,8 +388,7 @@ others of the same type.
DeleteAsync(RequestOptions)
- Deletes this object and all its children.
-
+
Declaration
@@ -418,8 +407,7 @@ others of the same type.
RequestOptions
options
- The options to be used when sending the request.
-
@@ -547,8 +535,7 @@ others of the same type.
ModifyAsync(Action<GuildChannelProperties>, RequestOptions)
- Modifies this guild channel.
-
+
Declaration
@@ -567,14 +554,12 @@ others of the same type.
System.Action<GuildChannelProperties>
func
- The delegate containing the properties to modify the channel with.
-
RequestOptions
options
- The options to be used when sending the request.
-
@@ -589,15 +574,10 @@ others of the same type.
System.Threading.Tasks.Task
- A task that represents the asynchronous modification operation.
-
- Remarks
- This method modifies the current guild channel with the specified properties. To see an example of this
-method and what properties are available, please refer to GuildChannelProperties.
-
|
Improve this Doc
@@ -753,8 +733,7 @@ method and what properties are available, please refer to
UpdateAsync(RequestOptions)
- Updates this object's properties with its current state.
-
+
Declaration
@@ -805,8 +784,7 @@ method and what properties are available, please refer to
IChannel.GetUserAsync(UInt64, CacheMode, RequestOptions)
- Gets a user in this channel.
-
+
Declaration
@@ -825,20 +803,17 @@ method and what properties are available, please refer to System.UInt64
id
- The snowflake identifier of the user (e.g. 168693960628371456).
-
CacheMode
mode
- The CacheMode that determines whether the object should be fetched from cache.
-
RequestOptions
options
- The options to be used when sending the request.
-
@@ -853,9 +828,7 @@ method and what properties are available, please refer to System.Threading.Tasks.Task<IUser>
- A task that represents the asynchronous get operation. The task result contains a user object that
-represents the found user; null if none is found.
-null if none is found.
IChannel.GetUsersAsync(CacheMode, RequestOptions)
- Gets a collection of users that are able to view the channel or are currently in this channel.
-
+
Declaration
@@ -888,14 +860,12 @@ represents the found user; null if none is found.
CacheMode
mode
- The CacheMode that determines whether the object should be fetched from cache.
-
RequestOptions
options
- The options to be used when sending the request.
-
@@ -910,23 +880,10 @@ represents the found user; null if none is found.
System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<IUser>>
- Paged collection of users.
-
- Remarks
- important
- The returned collection is an asynchronous enumerable object; one must call
-FlattenAsync<T>(IAsyncEnumerable<IEnumerable<T>>) to access the individual messages as a
-collection.
-
-This method will attempt to fetch all users that is able to view this channel or is currently in this channel.
-The library will attempt to split up the requests according to and MaxUsersPerBatch.
-In other words, if there are 3000 users, and the MaxUsersPerBatch constant
-is 1000, the request will be split into 3 individual requests; thus returning 53individual asynchronous
-responses, hence the need of flattening.
-
|
Improve this Doc
@@ -936,8 +893,7 @@ responses, hence the need of flattening.
IGuildChannel.AddPermissionOverwriteAsync(IRole, OverwritePermissions, RequestOptions)
- Adds or updates the permission overwrite for the given role.
-
+
Declaration
@@ -956,20 +912,17 @@ responses, hence the need of flattening.
IRole
role
- The role to add the overwrite to.
-
OverwritePermissions
permissions
- The overwrite to add to the role.
-
RequestOptions
options
- The options to be used when sending the request.
-
@@ -984,9 +937,7 @@ responses, hence the need of flattening.
System.Threading.Tasks.Task
- A task representing the asynchronous permission operation for adding the specified permissions to the
-channel.
-
@@ -999,8 +950,7 @@ channel.
IGuildChannel.AddPermissionOverwriteAsync(IUser, OverwritePermissions, RequestOptions)
- Adds or updates the permission overwrite for the given user.
-
+
Declaration
@@ -1019,20 +969,17 @@ channel.
IUser
user
- The user to add the overwrite to.
-
OverwritePermissions
permissions
- The overwrite to add to the user.
-
RequestOptions
options
- The options to be used when sending the request.
-
@@ -1047,8 +994,7 @@ channel.
System.Threading.Tasks.Task
- A task representing the asynchronous permission operation for adding the specified permissions to the channel.
-
@@ -1061,8 +1007,7 @@ channel.
IGuildChannel.GetPermissionOverwrite(IRole)
- Gets the permission overwrite for a specific role.
-
+
Declaration
@@ -1081,8 +1026,7 @@ channel.
IRole
role
- The role to get the overwrite from.
-
@@ -1097,8 +1041,7 @@ channel.
System.Nullable<OverwritePermissions>
- An overwrite object for the targeted role; null if none is set.
-
@@ -1111,8 +1054,7 @@ channel.
IGuildChannel.GetPermissionOverwrite(IUser)
- Gets the permission overwrite for a specific user.
-
+
Declaration
@@ -1131,8 +1073,7 @@ channel.
IUser
user
- The user to get the overwrite from.
-
@@ -1147,8 +1088,7 @@ channel.
System.Nullable<OverwritePermissions>
- An overwrite object for the targeted user; null if none is set.
-
@@ -1161,8 +1101,7 @@ channel.
IGuildChannel.GetUserAsync(UInt64, CacheMode, RequestOptions)
- Gets a user in this channel.
-
+
Declaration
@@ -1181,20 +1120,17 @@ channel.
System.UInt64
id
- The snowflake identifier of the user.
-
CacheMode
mode
- The CacheMode that determines whether the object should be fetched from cache.
-
RequestOptions
options
- The options to be used when sending the request.
-
@@ -1209,9 +1145,7 @@ channel.
System.Threading.Tasks.Task<IGuildUser>
- A task representing the asynchronous get operation. The task result contains a guild user object that
-represents the user;