Discord.Net.Rest
Represents a vanity invite.
The unique code for the invite link.
The total amount of vanity invite uses.
Gets the snowflake ID of the application.
Gets the ID of the embed's image asset.
Gets the application's description.
Gets the ID of the application's icon.
Gets the name of the application.
Unknown OAuth token type.
Unknown OAuth token type.
Unknown OAuth token type.
must not be equal to zero.
-and-
must be greater than zero.
must not be .
-and-
must not be or empty.
Message content is too long, length must be less or equal to .
Message content is too long, length must be less or equal to .
This operation may only be called with a token.
Message content is too long, length must be less or equal to .
This operation may only be called with a token.
This operation may only be called with a token.
Message content is too long, length must be less or equal to .
Message content is too long, length must be less or equal to .
This operation may only be called with a token.
Message content is too long, length must be less or equal to .
and must not be equal to zero.
-and-
must be between 0 to 7.
must not be .
and must not be equal to zero.
must not be equal to zero.
must not be equal to zero.
must not be .
must not be equal to zero.
and must not be equal to zero.
must not be .
cannot be blank.
must not be .
may not be equal to zero.
may not be equal to zero.
may not be equal to zero.
may not be equal to zero.
-and-
and must be greater than zero.
-and-
must be lesser than 86400.
must not be .
Client is not logged in.
Unsupported param type.
The default RestClientProvider is not supported on this platform.
Cannot read from image.
Represents a REST-Based ratelimit info.
Gets the login state of the client.
Gets the logged-in user.
Creates a new REST-only Discord client.
Creating a guild is not supported with the base client.
Unexpected channel type.
Provides a client to send REST-based requests to Discord.
Gets the logged-in user.
Initializes a new with the provided configuration.
The configuration to be used with the client.
Represents a configuration class for .
Gets or sets the provider used to generate new REST connections.
Contains a piece of audit log data related to a ban.
Gets the user that was banned.
A user object representing the banned user.
Contains a piece of audit log data related to a adding a bot to a guild.
Gets the bot that was added.
A user object representing the bot.
Contains a piece of audit log data related to a channel creation.
Gets the snowflake ID of the created channel.
A representing the snowflake identifier for the created channel.
Gets the name of the created channel.
A string containing the name of the created channel.
Gets the type of the created channel.
The type of channel that was created.
Gets the current slow-mode delay of the created channel.
An representing the time in seconds required before the user can send another
message; 0 if disabled.
null if this is not mentioned in this entry.
Gets the value that indicates whether the created channel is NSFW.
true if the created channel has the NSFW flag enabled; otherwise false.
null if this is not mentioned in this entry.
Gets the bit-rate that the clients in the created voice channel are requested to use.
An representing the bit-rate (bps) that the created voice channel defines and requests the
client(s) to use.
null if this is not mentioned in this entry.
Gets a collection of permission overwrites that was assigned to the created channel.
A collection of permission , containing the permission overwrites that were
assigned to the created channel.
Contains a piece of audit log data related to a channel deletion.
Gets the snowflake ID of the deleted channel.
A representing the snowflake identifier for the deleted channel.
Gets the name of the deleted channel.
A string containing the name of the deleted channel.
Gets the type of the deleted channel.
The type of channel that was deleted.
Gets the slow-mode delay of the deleted channel.
An representing the time in seconds required before the user can send another
message; 0 if disabled.
null if this is not mentioned in this entry.
Gets the value that indicates whether the deleted channel was NSFW.
true if this channel had the NSFW flag enabled; otherwise false.
null if this is not mentioned in this entry.
Gets the bit-rate of this channel if applicable.
An representing the bit-rate set of the voice channel.
null if this is not mentioned in this entry.
Gets a collection of permission overwrites that was assigned to the deleted channel.
A collection of permission .
Represents information for a channel.
Gets the name of this channel.
A string containing the name of this channel.
Gets the topic of this channel.
A string containing the topic of this channel, if any.
Gets the current slow-mode delay of this channel.
An representing the time in seconds required before the user can send another
message; 0 if disabled.
null if this is not mentioned in this entry.
Gets the value that indicates whether this channel is NSFW.
true if this channel has the NSFW flag enabled; otherwise false.
null if this is not mentioned in this entry.
Gets the bit-rate of this channel if applicable.
An representing the bit-rate set for the voice channel;
null if this is not mentioned in this entry.
Gets the type of this channel.
The channel type of this channel; null if not applicable.
Contains a piece of audit log data related to a channel update.
Gets the snowflake ID of the updated channel.
A representing the snowflake identifier for the updated channel.
Gets the channel information before the changes.
An information object containing the original channel information before the changes were made.
Gets the channel information after the changes.
An information object containing the channel information after the changes were made.
Contains a piece of audit log data related to an emoji creation.
Gets the snowflake ID of the created emoji.
A representing the snowflake identifier for the created emoji.
Gets the name of the created emoji.
A string containing the name of the created emoji.
Contains a piece of audit log data related to an emoji deletion.
Gets the snowflake ID of the deleted emoji.
A representing the snowflake identifier for the deleted emoji.
Gets the name of the deleted emoji.
A string containing the name of the deleted emoji.
Contains a piece of audit log data related to an emoji update.
Gets the snowflake ID of the updated emoji.
A representing the snowflake identifier of the updated emoji.
Gets the new name of the updated emoji.
A string containing the new name of the updated emoji.
Gets the old name of the updated emoji.
A string containing the old name of the updated emoji.
Represents information for a guild.
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 representing the amount of time in seconds for a user to be marked as inactive
and moved into the AFK voice channel.
null if this is not mentioned in this entry.
Gets the default message notifications for users who haven't explicitly set their notification settings.
The default message notifications setting of this guild.
null if this is not mentioned in this entry.
Gets the ID of the AFK voice channel for this guild.
A representing the snowflake identifier of the AFK voice channel; null if
none is set.
Gets the name of this guild.
A string containing the name of this guild.
Gets the ID of the region hosting this guild's voice channels.
Gets the ID of this guild's icon.
A string containing the identifier for the splash image; null if none is set.
Gets the level of requirements a user must fulfill before being allowed to post messages in this guild.
The level of requirements.
null if this is not mentioned in this entry.
Gets the owner of this guild.
A user object representing the owner of this guild.
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.
null if this is not mentioned in this entry.
Gets the level of content filtering applied to user's content in a Guild.
The level of explicit content filtering.
Gets the ID of the channel where system messages are sent.
A representing the snowflake identifier of the channel where system
messages are sent; null if none is set.
Gets the ID of the widget embed channel of this guild.
A representing the snowflake identifier of the embedded channel found within the
widget settings of this guild; null if none is set.
Gets a value that indicates whether this guild is embeddable (i.e. can use widget).
true if this guild can be embedded via widgets; otherwise false.
null if this is not mentioned in this entry.
Contains a piece of audit log data related to a guild update.
Gets the guild information before the changes.
An information object containing the original guild information before the changes were made.
Gets the guild information after the changes.
An information object containing the guild information after the changes were made.
Contains a piece of audit log data related to an invite creation.
Gets the time (in seconds) until the invite expires.
An representing the time in seconds until this invite expires.
Gets the unique identifier for this invite.
A string containing the invite code (e.g. FTqNnyS).
Gets a value that determines whether the invite is a temporary one.
true if users accepting this invite will be removed from the guild when they log off; otherwise
false.
Gets the user that created this invite if available.
A user that created this invite or .
Gets the ID of the channel this invite is linked to.
A representing the channel snowflake identifier that the invite points to.
Gets the number of times this invite has been used.
An representing the number of times this invite was used.
Gets the max number of uses this invite may have.
An representing the number of uses this invite may be accepted until it is removed
from the guild; null if none is set.
Contains a piece of audit log data related to an invite removal.
Gets the time (in seconds) until the invite expires.
An representing the time in seconds until this invite expires.
Gets the unique identifier for this invite.
A string containing the invite code (e.g. FTqNnyS).
Gets a value that indicates whether the invite is a temporary one.
true if users accepting this invite will be removed from the guild when they log off; otherwise
false.
Gets the user that created this invite if available.
A user that created this invite or .
Gets the ID of the channel this invite is linked to.
A representing the channel snowflake identifier that the invite points to.
Gets the number of times this invite has been used.
An representing the number of times this invite has been used.
Gets the max number of uses this invite may have.
An representing the number of uses this invite may be accepted until it is removed
from the guild; null if none is set.
Represents information for an invite.
Gets the time (in seconds) until the invite expires.
An representing the time in seconds until this invite expires; null if this
invite never expires or not specified.
Gets the unique identifier for this invite.
A string containing the invite code (e.g. FTqNnyS).
Gets a value that indicates whether the invite is a temporary one.
true if users accepting this invite will be removed from the guild when they log off,
false if not; null if not specified.
Gets the ID of the channel this invite is linked to.
A representing the channel snowflake identifier that the invite points to;
null if not specified.
Gets the max number of uses this invite may have.
An representing the number of uses this invite may be accepted until it is removed
from the guild; null if none is specified.
Contains a piece of audit log data relating to an invite update.
Gets the invite information before the changes.
An information object containing the original invite information before the changes were made.
Gets the invite information after the changes.
An information object containing the invite information after the changes were made.
Contains a piece of audit log data related to a kick.
Gets the user that was kicked.
A user object representing the kicked user.
Contains a piece of audit log data related to disconnecting members from voice channels.
Gets the number of members that were disconnected.
An representing the number of members that were disconnected from a voice channel.
Represents information for a member.
Gets the nickname of the updated member.
A string representing the nickname of the updated member; null if none is set.
Gets a value that indicates whether the updated member is deafened by the guild.
true if the updated member is deafened (i.e. not permitted to listen to or speak to others) by the guild;
otherwise false.
null if this is not mentioned in this entry.
Gets a value that indicates whether the updated member is muted (i.e. not permitted to speak via voice) by the
guild.
true if the updated member is muted by the guild; otherwise false.
null if this is not mentioned in this entry.
Contains a piece of audit log data related to moving members between voice channels.
Gets the ID of the channel that the members were moved to.
A representing the snowflake identifier for the channel that the members were moved to.
Gets the number of members that were moved.
An representing the number of members that were moved to another voice channel.
Contains a piece of audit log data related to a change in a guild member's roles.
Gets a collection of role changes that were performed on the member.
A read-only collection of , containing the roles that were changed on
the member.
Gets the user that the roles changes were performed on.
A user object representing the user that the role changes were performed on.
An information object representing a change in one of a guild member's roles.
Gets the name of the role that was changed.
A string containing the name of the role that was changed.
Gets the ID of the role that was changed.
A representing the snowflake identifier of the role that was changed.
Gets a value that indicates whether the role was added to the user.
true if the role was added to the user; otherwise false.
Contains a piece of audit log data related to a change in a guild member.
Gets the user that the changes were performed on.
A user object representing the user who the changes were performed on.
Gets the member information before the changes.
An information object containing the original member information before the changes were made.
Gets the member information after the changes.
An information object containing the member information after the changes were made.
Contains a piece of audit log data related to message deletion(s).
Gets the ID of the channel that the messages were deleted from.
A representing the snowflake identifier for the channel that the messages were
deleted from.
Gets the number of messages that were deleted.
An representing the number of messages that were deleted from the channel.
Contains a piece of audit log data related to message deletion(s).
Gets the number of messages that were deleted.
An representing the number of messages that were deleted from the channel.
Gets the ID of the channel that the messages were deleted from.
A representing the snowflake identifier for the channel that the messages were
deleted from.
Gets the user of the messages that were deleted.
A user object representing the user that created the deleted messages.
Contains a piece of audit log data related to a pinned message.
Gets the ID of the messages that was pinned.
A representing the snowflake identifier for the messages that was pinned.
Gets the ID of the channel that the message was pinned from.
A representing the snowflake identifier for the channel that the message was pinned from.
Gets the user of the message that was pinned if available.
A user object representing the user that created the pinned message or .
Contains a piece of audit log data related to an unpinned message.
Gets the ID of the messages that was unpinned.
A representing the snowflake identifier for the messages that was unpinned.
Gets the ID of the channel that the message was unpinned from.
A representing the snowflake identifier for the channel that the message was unpinned from.
Gets the user of the message that was unpinned if available.
A user object representing the user that created the unpinned message or .
Contains a piece of audit log data for a permissions overwrite creation.
Gets the ID of the channel that the overwrite was created from.
A representing the snowflake identifier for the channel that the overwrite was
created from.
Gets the permission overwrite object that was created.
An object representing the overwrite that was created.
Contains a piece of audit log data related to the deletion of a permission overwrite.
Gets the ID of the channel that the overwrite was deleted from.
A representing the snowflake identifier for the channel that the overwrite was
deleted from.
Gets the permission overwrite object that was deleted.
An object representing the overwrite that was deleted.
Contains a piece of audit log data related to the update of a permission overwrite.
Gets the ID of the channel that the overwrite was updated from.
A representing the snowflake identifier for the channel that the overwrite was
updated from.
Gets the overwrite permissions before the changes.
An overwrite permissions object representing the overwrite permissions that the overwrite had before
the changes were made.
Gets the overwrite permissions after the changes.
An overwrite permissions object representing the overwrite permissions that the overwrite had after the
changes.
Gets the ID of the overwrite that was updated.
A representing the snowflake identifier of the overwrite that was updated.
Gets the target of the updated permission overwrite.
The target of the updated permission overwrite.
Contains a piece of audit log data related to a guild prune.
Gets the threshold for a guild member to not be kicked.
An representing the amount of days that a member must have been seen in the server,
to avoid being kicked. (i.e. If a user has not been seen for more than , they will be
kicked from the server)
Gets the number of members that were kicked during the purge.
An representing the number of members that were removed from this guild for having
not been seen within .
Contains a piece of audit log data related to a role creation.
Gets the ID of the role that was created.
A representing the snowflake identifier to the role that was created.
Gets the role information that was created.
An information object representing the properties of the role that was created.
Contains a piece of audit log data relating to a role deletion.
Gets the ID of the role that was deleted.
A representing the snowflake identifier to the role that was deleted.
Gets the role information that was deleted.
An information object representing the properties of the role that was deleted.
Represents information for a role edit.
Gets the color of this role.
A color object representing the color assigned to this role; null if this role does not have a
color.
Gets a value that indicates whether this role is mentionable.
true if other members can mention this role in a text channel; otherwise false;
null if this is not mentioned in this entry.
Gets a value that indicates whether this role is hoisted (i.e. its members will appear in a separate
section on the user list).
true if this role's members will appear in a separate section in the user list; otherwise
false; null if this is not mentioned in this entry.
Gets the name of this role.
A string containing the name of this role.
Gets the permissions assigned to this role.
A guild permissions object representing the permissions that have been assigned to this role; null
if no permissions have been assigned.
Contains a piece of audit log data related to a role update.
Gets the ID of the role that was changed.
A representing the snowflake identifier of the role that was changed.
Gets the role information before the changes.
A role information object containing the role information before the changes were made.
Gets the role information after the changes.
A role information object containing the role information after the changes were made.
Contains a piece of audit log data related to an unban.
Gets the user that was unbanned.
A user object representing the user that was unbanned.
Contains a piece of audit log data related to a webhook creation.
Gets the webhook that was created if it still exists.
A webhook object representing the webhook that was created if it still exists, otherwise returns null.
Gets the webhook id.
The webhook identifier.
Gets the type of webhook that was created.
The type of webhook that was created.
Gets the name of the webhook.
A string containing the name of the webhook.
Gets the ID of the channel that the webhook could send to.
A representing the snowflake identifier of the channel that the webhook could send
to.
Contains a piece of audit log data related to a webhook deletion.
Gets the ID of the webhook that was deleted.
A representing the snowflake identifier of the webhook that was deleted.
Gets the ID of the channel that the webhook could send to.
A representing the snowflake identifier of the channel that the webhook could send
to.
Gets the type of the webhook that was deleted.
The type of webhook that was deleted.
Gets the name of the webhook that was deleted.
A string containing the name of the webhook that was deleted.
Gets the hash value of the webhook's avatar.
A string containing the hash of the webhook's avatar.
Represents information for a webhook.
Gets the name of this webhook.
A string containing the name of this webhook.
Gets the ID of the channel that this webhook sends to.
A representing the snowflake identifier of the channel that this webhook can send
to.
Gets the hash value of this webhook's avatar.
A string containing the hash of this webhook's avatar.
Contains a piece of audit log data related to a webhook update.
Gets the webhook that was updated.
A webhook object representing the webhook that was updated.
Gets the webhook information before the changes.
A webhook information object representing the webhook before the changes were made.
Gets the webhook information after the changes.
A webhook information object representing the webhook after the changes were made.
Represents a REST-based audit log entry.
may not be equal to zero.
-and-
and must be greater than zero.
-and-
must be lesser than 86400.
may not be equal to zero.
-and-
and must be greater than zero.
-and-
must be lesser than 86400.
may not be equal to zero.
-and-
and must be greater than zero.
-and-
must be lesser than 86400.
Message content is too long, length must be less or equal to .
is a zero-length string, contains only white space, or contains one or more
invalid characters as defined by .
is null.
The specified path, file name, or both exceed the system-defined maximum length. For example, on
Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260
characters.
The specified path is invalid, (for example, it is on an unmapped drive).
specified a directory.-or- The caller does not have the required permission.
The file specified in was not found.
is in an invalid format.
An I/O error occurred while opening the file.
Message content is too long, length must be less or equal to .
Message content is too long, length must be less or equal to .
Resolving permissions requires the parent guild to be downloaded.
Resolving permissions requires the parent guild to be downloaded.
This channel does not have a parent channel.
Represents a REST-based channel that can send and receive messages.
Sends a message to this message channel.
This method follows the same behavior as described in .
Please visit its documentation for more details on this method.
The message to be sent.
Determines whether the message should be read aloud by Discord or not.
The to be sent.
The options to be used when sending the request.
Specifies if notifications are sent for mentioned users and roles in the message .
If null, all mentioned roles and users will be notified.
The message references to be included. Used to reply to specific messages.
The message components to be included with this message. Used for interactions
A collection of stickers to send with the message.
A task that represents an asynchronous send operation for delivering the message. The task result
contains the sent message.
Sends a file to this message channel with an optional caption.
This method follows the same behavior as described in
. Please visit
its documentation for more details on this method.
The file path of the file.
The message to be sent.
Whether the message should be read aloud by Discord or not.
The to be sent.
The options to be used when sending the request.
Whether the message attachment should be hidden as a spoiler.
Specifies if notifications are sent for mentioned users and roles in the message .
If null, all mentioned roles and users will be notified.
The message references to be included. Used to reply to specific messages.
The message components to be included with this message. Used for interactions
A collection of stickers to send with the message.
A task that represents an asynchronous send operation for delivering the message. The task result
contains the sent message.
Sends a file to this message channel with an optional caption.
This method follows the same behavior as described in .
Please visit its documentation for more details on this method.
The 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 to be sent.
The options to be used when sending the request.
Whether the message attachment should be hidden as a spoiler.
Specifies if notifications are sent for mentioned users and roles in the message .
If null, all mentioned roles and users will be notified.
The message references to be included. Used to reply to specific messages.
The message components to be included with this message. Used for interactions
A collection of stickers to send with the message.
A task that represents an asynchronous send operation for delivering the message. The task result
contains the sent message.
Gets a message from this message channel.
This method follows the same behavior as described in .
Please visit its documentation for more details on this method.
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.
Gets the last N messages from this message channel.
This method follows the same behavior as described in .
Please visit its documentation for more details on this method.
The numbers of message to be gotten from.
The options to be used when sending the request.
Paged collection of messages.
Gets a collection of messages in this channel.
This method follows the same behavior as described in .
Please visit its documentation for more details on this method.
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.
Gets a collection of messages in this channel.
This method follows the same behavior as described in .
Please visit its documentation for more details on this method.
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.
Gets a collection of pinned messages in this channel.
This method follows the same behavior as described in .
Please visit its documentation for more details on this method.
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.
Represents a REST-based channel that is private to select recipients.
Users that can access this channel.
Represents a REST-based category channel.
This method is not supported with category channels.
This method is not supported with category channels.
Represents a generic REST-based channel.
Unexpected channel type.
Unexpected channel type.
Represents a REST-based direct-message channel.
Gets the current logged-in user.
Gets the recipient of the channel.
Gets a collection that is the current logged-in user and the recipient.
Gets a user in this channel from the provided .
The snowflake identifier of the user.
A object that is a recipient of this channel; otherwise null.
Message content is too long, length must be less or equal to .
is a zero-length string, contains only white space, or contains one or more
invalid characters as defined by .
is null.
The specified path, file name, or both exceed the system-defined maximum length. For example, on
Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260
characters.
The specified path is invalid, (for example, it is on an unmapped drive).
specified a directory.-or- The caller does not have the required permission.
The file specified in was not found.
is in an invalid format.
An I/O error occurred while opening the file.
Message content is too long, length must be less or equal to .
Message content is too long, length must be less or equal to .
Gets a string that represents the Username#Discriminator of the recipient.
A string that resolves to the Recipient of this channel.
Represents a REST-based group-message channel.
Message content is too long, length must be less or equal to .
is a zero-length string, contains only white space, or contains one or more
invalid characters as defined by .
is null.
The specified path, file name, or both exceed the system-defined maximum length. For example, on
Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260
characters.
The specified path is invalid, (for example, it is on an unmapped drive).
specified a directory.-or- The caller does not have the required permission.
The file specified in was not found.
is in an invalid format.
An I/O error occurred while opening the file.
Message content is too long, length must be less or equal to .
Message content is too long, length must be less or equal to .
Connecting to a group channel is not supported.
Represents a private REST-based group channel.
Gets the permission overwrite for a specific user.
The user to get the overwrite from.
An overwrite object for the targeted user; null if none is set.
Gets the permission overwrite for a specific role.
The role to get the overwrite from.
An overwrite object for the targeted role; null if none is set.
Adds or updates the permission overwrite for the given user.
The user to add the overwrite to.
The overwrite to add to the user.
The options to be used when sending the request.
A task representing the asynchronous permission operation for adding the specified permissions to the channel.
Adds or updates the permission overwrite for the given role.
The role to add the overwrite to.
The overwrite to add to the role.
The options to be used when sending the request.
A task representing the asynchronous permission operation for adding the specified permissions to the channel.
Removes the permission overwrite for the given user, if one exists.
The user to remove the overwrite from.
The options to be used when sending the request.
A task representing the asynchronous operation for removing the specified permissions from the channel.
Removes the permission overwrite for the given role, if one exists.
The role to remove the overwrite from.
The options to be used when sending the request.
A task representing the asynchronous operation for removing the specified permissions from the channel.
Gets the name of this channel.
A string that is the name of this channel.
Represents a REST-based news channel in a guild that has the same properties as a .
Represents a REST-based stage channel in a guild.
Represents a REST-based channel in a guild that can send and receive messages.
Gets a user in this channel.
The snowflake identifier of the user.
The options to be used when sending the request.
Resolving permissions requires the parent guild to be downloaded.
A task representing the asynchronous get operation. The task result contains a guild user object that
represents the user; null if none is found.
Gets a collection of users that are able to view the channel.
The options to be used when sending the request.
Resolving permissions requires the parent guild to be downloaded.
A paged collection containing a collection of guild users that can access this channel. Flattening the
paginated response into a collection of users with
is required if you wish to access the users.
Message content is too long, length must be less or equal to .
is a zero-length string, contains only white space, or contains one or more
invalid characters as defined by .
is null.
The specified path, file name, or both exceed the system-defined maximum length. For example, on
Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260
characters.
The specified path is invalid, (for example, it is on an unmapped drive).
specified a directory.-or- The caller does not have the required permission.
The file specified in was not found.
is in an invalid format.
An I/O error occurred while opening the file.
Message content is too long, length must be less or equal to .
Message content is too long, length must be less or equal to .
Creates a webhook in this text channel.
The name of the webhook.
The avatar of the webhook.
The options to be used when sending the request.
A task that represents the asynchronous creation operation. The task result contains the newly created
webhook.
Gets a webhook available in this text channel.
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 the webhooks available in this text channel.
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 webhooks that is available in this channel.
Gets the parent (category) channel of this channel.
The options to be used when sending the request.
A task that represents the asynchronous get operation. The task result contains the category channel
representing the parent of this channel; null if none is set.
Creates a thread within this .
When is the thread type will be based off of the
channel its created in. When called on a , it creates a .
When called on a , it creates a . 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.
The name of the thread.
The type of the thread.
Note: This parameter is not used if the parameter is not specified.
The duration on which this thread archives after.
Note: Options and
are only available for guilds that are boosted. You can check in the to see if the
guild has the THREE_DAY_THREAD_ARCHIVE and SEVEN_DAY_THREAD_ARCHIVE.
The message which to start the thread from.
The options to be used when sending the request.
A task that represents the asynchronous create operation. The task result contains a
Represents a thread channel recieved over REST.
Gets the parent text channel id.
Gets a user within this thread.
The id of the user to fetch.
The options to be used when sending the request.
A task representing the asyncronous get operation. The task returns a
if found, otherwise .
Gets a collection of users within this thread.
The options to be used when sending the request.
A task representing the asyncronous get operation. The task returns a
of 's.
This method is not supported in threads.
This method is not supported in threads.
This method is not supported in threads.
This method is not supported in threads.
This method is not supported in threads.
This method is not supported in threads.
This method is not supported in threads.
This method is not supported in threads.
This method is not supported in threads.
This method is not supported in threads.
This method is not supported in threads.
This method is not supported in threads.
This method is not supported in threads.
This method is not supported in threads.
This method is not supported in threads.
Represents a REST-based voice channel in a guild.
Gets the parent (category) channel of this channel.
The options to be used when sending the request.
A task that represents the asynchronous get operation. The task result contains the category channel
representing the parent of this channel; null if none is set.
Connecting to a REST-based channel is not supported.
is null.
is null.
is null.
is null.
is null.
is null.
is null.
Represents a REST-based ban object.
Gets the banned user.
A generic object that was banned.
Gets the name of the banned user.
A string containing the name of the user that was banned.
Represents a REST-based guild/server.
Gets the built-in role containing all users in this guild.
Gets a collection of all roles in this guild.
Updates this object's properties with its current state.
If true, and
will be updated as well.
The options to be used when sending the request.
If is true, and
will be updated as well.
is .
is .
is .
Deletes all slash commands in the current guild.
The options to be used when sending the request.
A task that represents the asynchronous delete operation.
Gets a collection of slash commands created by the current user in this guild.
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
slash commands created by the current user.
Gets a slash command in the current guild.
The unique identifier of the slash command.
The options to be used when sending the request.
A task that represents the asynchronous get operation. The task result contains a
slash command created by the current user.
Gets a collection of all users banned in this guild.
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
ban objects that this guild currently possesses, with each object containing the user banned and reason
behind the ban.
Gets a ban object for a banned user.
The banned user.
The options to be used when sending the request.
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; if the ban entry cannot be found.
Gets a ban object for a banned user.
The snowflake identifier for the banned user.
The options to be used when sending the request.
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; if the ban entry cannot be found.
Gets a collection of all channels in this guild.
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
generic channels found within this guild.
Gets a channel in this guild.
The snowflake identifier for the channel.
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 ; if none is found.
Gets a text channel in this guild.
The snowflake identifier for the text channel.
The options to be used when sending the request.
A task that represents the asynchronous get operation. The task result contains the text channel
associated with the specified ; if none is found.
Gets a collection of all text channels in this guild.
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
message channels found within this guild.
Gets a thread channel in this guild.
The snowflake identifier for the thread channel.
The options to be used when sending the request.
A task that represents the asynchronous get operation. The task result contains the thread channel associated
with the specified ; if none is found.
Gets a collection of all thread in this guild.
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
threads found within this guild.
Gets a voice channel in this guild.
The snowflake identifier for the voice channel.
The options to be used when sending the request.
A task that represents the asynchronous get operation. The task result contains the voice channel associated
with the specified ; if none is found.
Gets a collection of all voice channels in this guild.
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
voice channels found within this guild.
Gets a stage channel in this guild
The snowflake identifier for the stage channel.
The options to be used when sending the request.
A task that represents the asynchronous get operation. The task result contains the stage channel associated
with the specified ; if none is found.
Gets a collection of all stage channels in this guild.
The 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
stage channels found within this guild.
Gets a collection of all category channels in this guild.
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 the AFK voice channel in this guild.
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; if none is set.
Gets the first viewable text channel in this guild.
The options to be used when sending the request.
A task that represents the asynchronous get operation. The task result contains the first viewable text
channel in this guild; if none is found.
Gets the widget channel (i.e. the channel set in the guild's widget settings) in this guild.
The options to be used when sending the request.
A task that represents the asynchronous get operation. The task result contains the widget channel set
within the server's widget settings; if none is set.
Gets the text channel where guild notices such as welcome messages and boost events are posted.
The options to be used when sending the request.
A task that represents the asynchronous get operation. The task result contains the text channel
where guild notices such as welcome messages and boost events are poste; if none is found.
Gets the text channel where Community guilds can display rules and/or guidelines.
The options to be used when sending the request.
A task that represents the asynchronous get operation. The task result contains the text channel
where Community guilds can display rules and/or guidelines; if none is set.
Gets the text channel channel where admins and moderators of Community guilds receive notices from Discord.
The options to be used when sending the request.
A task that represents the asynchronous get operation. The task result contains the text channel channel where
admins and moderators of Community guilds receive notices from Discord; if none is set.
Creates a new text channel in this guild.
The following example creates a new text channel under an existing category named Wumpus with a set topic.
var categories = await guild.GetCategoriesAsync();
var targetCategory = categories.FirstOrDefault(x => x.Name == "wumpus");
if (targetCategory == null) return;
await Context.Guild.CreateTextChannelAsync(name, x =>
{
x.CategoryId = targetCategory.Id;
x.Topic = $"This channel was created at {DateTimeOffset.UtcNow} by {user}.";
});
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 voice channel with the provided name.
The name of the new channel.
The delegate containing the properties to be applied to the channel upon its creation.
The options to be used when sending the request.
is .
The created voice channel.
Creates a new stage channel in this guild.
The new name for the stage 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
stage channel.
Creates a category channel with the provided name.
The name of the new channel.
The delegate containing the properties to be applied to the channel upon its creation.
The options to be used when sending the request.
is .
The created category channel.
Gets a collection of all the voice regions this guild can access.
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
voice regions the guild can access.
Gets a collection of all invites in this guild.
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
invite metadata, each representing information for an invite found within this guild.
Gets the vanity invite URL of this guild.
The options to be used when sending the request.
A partial metadata of the vanity invite found within this guild.
Gets a role in this guild.
The snowflake identifier for the role.
A role that is associated with the specified ; if none is found.
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.
Whether the role can be mentioned.
A task that represents the asynchronous creation operation. The task result contains the newly created
role.
Gets a collection of all users in this guild.
This method retrieves all users found within this guild.
The options to be used when sending the request.
A task that represents the asynchronous get operation. The task result contains a collection of guild
users found within this guild.
Gets a user from this guild.
This method retrieves a user found within this guild.
The snowflake identifier of the user.
The options to be used when sending the request.
A task that represents the asynchronous get operation. The task result contains the guild user
associated with the specified ; if none is found.
Gets the current user for this guild.
The options to be used when sending the request.
A task that represents the asynchronous get operation. The task result contains the currently logged-in
user within this guild.
Gets the owner of this guild.
The options to be used when sending the request.
A task that represents the asynchronous get operation. The task result contains the owner of this guild.
Prunes inactive users.
This method removes all users that have not logged on in the provided number of .
If is true, this method will only return the number of users that
would be removed without kicking the users.
The number of days required for the users to be kicked.
Whether this prune action is a simulation.
The options to be used when sending the request.
A task that represents the asynchronous prune operation. The task result contains the number of users to
be or has been removed from this guild.
Gets a collection of users in this guild that the name or nickname starts with the
provided at .
The can not be higher than .
The partial name or nickname to search.
The maximum number of users to be gotten.
The options to be used when sending the request.
A task that represents the asynchronous get operation. The task result contains a collection of guild
users that the name or nickname starts with the provided at .
Gets the specified number of audit log entries for this guild.
The number of audit log entries to fetch.
The options to be used when sending the request.
The audit log entry ID to get entries before.
The type of actions to filter.
The user ID to filter entries for.
A task that represents the asynchronous get operation. The task result contains a read-only collection
of the requested audit log entries.
Gets a webhook found within this guild.
The identifier for the webhook.
The options to be used when sending the request.
A task that represents the asynchronous get operation. The task result contains the webhook with the
specified ; if none is found.
Gets a collection of all webhook from this guild.
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 webhooks found within the guild.
Gets this guilds slash commands commands
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 application commands found within the guild.
Gets an application command within this guild with the specified id.
The id of the application command to get.
The options to be used when sending the request.
A ValueTask that represents the asynchronous get operation. The task result contains a
if found, otherwise .
Creates an application command within this guild.
The properties to use when creating the command.
The options to be used when sending the request.
A task that represents the asynchronous creation operation. The task result contains the command that was created.
Overwrites the application commands within this guild.
A collection of properties to use when creating the commands.
The options to be used when sending the request.
A task that represents the asynchronous creation operation. The task result contains a collection of commands that was created.
Returns the name of the guild.
The name of the guild.
is .
Moves the user to the voice channel.
The user to move.
the channel where the user gets moved to.
A task that represents the asynchronous operation for moving a user.
Creates a new sticker in this guild.
The name of the sticker.
The description of the sticker.
The tags of the sticker.
The image of the new emote.
The options to be used when sending the request.
A task that represents the asynchronous creation operation. The task result contains the created sticker.
Creates a new sticker in this guild
The name of the sticker.
The description of the sticker.
The tags of the sticker.
The path of the file to upload.
The options to be used when sending the request.
A task that represents the asynchronous creation operation. The task result contains the created sticker.
Creates a new sticker in this guild
The name of the sticker.
The description of the sticker.
The tags of the sticker.
The stream containing the file data.
The name of the file with the extension, ex: image.png
The options to be used when sending the request.
A task that represents the asynchronous creation operation. The task result contains the created sticker.
Gets a specific sticker within this guild.
The id of the sticker to get.
The options to be used when sending the request.
A task that represents the asynchronous get operation. The task result contains the sticker found with the
specified ; if none is found.
Gets a collection of all stickers within this guild.
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 stickers found within the guild.
Deletes a sticker within this guild.
The sticker to delete.
The options to be used when sending the request.
A task that represents the asynchronous removal operation.
Disconnects the user from its current voice channel
The user to disconnect.
A task that represents the asynchronous operation for disconnecting a user.
Downloading users is not supported for a REST-based guild.
Represents a REST-based voice region.
Represents a Rest-based implementation of the .
The options of this command.
Represents a Rest-based implementation of .
Represents a Rest-based implementation of .
A collection of 's for this command.
A collection of 's for this command.
Represents a Rest-based global application command.
Modifies this .
The delegate containing the properties to modify the command with.
The options to be used when sending the request.
The modified command.
Represents a Rest-based guild application command.
The guild Id where this command originates.
Modifies this .
The delegate containing the properties to modify the command with.
The options to be used when sending the request.
The modified command
Gets this commands permissions inside of the current guild.
The options to be used when sending the request.
A task that represents the asynchronous get operation. The task result contains a
object defining the permissions of the current slash command.
Modifies the current command permissions for this guild command.
The permissions to overwrite.
The options to be used when sending the request.
A task that represents the asynchronous modification operation. The task result contains a
object containing the modified permissions.
Gets the guild that this slash command resides in.
if you want the approximate member and presence counts for the guild, otherwise .
The options to be used when sending the request.
A task that represents the asynchronous get operation. The task result contains a
.
Gets the URL of the invite.
A string that resolves to the Url of the invite.
Represents additional information regarding the REST-based invite object.
Represents a Rest-based custom sticker within a guild.
Gets the users id who uploaded the sticker.
In order to get the author id, the bot needs the MANAGE_EMOJIS_AND_STICKERS permission.
Gets the guild that this custom sticker is in.
Note: This property can be if the sticker wasnt fetched from a guild.
Regex used to check if some text is formatted as inline code.
Regex used to check if some text is formatted as a code block.
Only the author of a message may modify the message.
Message content is too long, length must be less or equal to .
Represents a REST-based follow up message sent by a bot responding to a slash command.
Deletes this object and all of it's childern.
A task that represents the asynchronous delete operation.
Modifies this interaction followup message.
This method modifies this message with the specified properties. To see an example of this
method and what properties are available, please refer to .
The following example replaces the content of the message with Hello World!.
await msg.ModifyAsync(x => x.Content = "Hello World!");
A delegate containing the properties to modify the message with.
The options to be used when sending the request.
A task that represents the asynchronous modification operation.
The token used to modify/delete this message expired.
/// Somthing went wrong during the request.
Represents the initial REST-based response to a slash command.
Deletes this object and all of it's childern.
A task that represents the asynchronous delete operation.
Modifies this interaction response
This method modifies this message with the specified properties. To see an example of this
method and what properties are available, please refer to .
The following example replaces the content of the message with Hello World!.
await msg.ModifyAsync(x => x.Content = "Hello World!");
A delegate containing the properties to modify the message with.
The options to be used when sending the request.
A task that represents the asynchronous modification operation.
The token used to modify/delete this message expired.
/// Somthing went wrong during the request.
Represents a REST-based message.
Gets the Author of the message.
Gets a collection of the 's on the message.
Gets a collection of the 's on the message.
Gets a collection of the mentioned users in the message.
Gets the of the message.
A string that is the of the message.
Represents a REST reaction object.
Gets the number of reactions added.
Gets whether the reactions is added by the user.
Represents a REST-based system message.
Represents a REST-based message sent by a user.
This operation may only be called on a channel.
Represents a partial sticker received in a message.
Resolves this sticker item by fetching the from the API.
A task representing the download operation, the result of the task is a sticker object.
Represents a REST-based entity that contains information about a Discord application created via the developer portal.
Unable to update this object from a different application token.
Gets the name of the application.
Name of the application.
Represents a REST-based role.
Gets if this role is the @everyone role of the guild or not.
Gets the name of the role.
A string that is the name of the role.
Gets the name of the connection.
Name of the connection.
Represents a REST-based group user.
Represents a REST-based guild user.
Resolving permissions requires the parent guild to be downloaded.
Resolving permissions requires the parent guild to be downloaded.
Represents the logged-in REST-based user.
Unable to update this object using a different token.
Unable to modify this object using a different token.
Represents a thread user received over the REST api.
Gets the this user is in.
Gets the timestamp for when this user joined this thread.
Gets the guild this user is in.
Gets the guild user for this thread user.
A task representing the asynchronous get operation. The task returns a
that represents the current thread user.
Represents a REST-based user.
Creates a direct message channel to this user.
The options to be used when sending the request.
A task that represents the asynchronous get operation. The task result contains a rest DM channel where the user is the recipient.
Gets the Username#Discriminator of the user.
A string that resolves to Username#Discriminator of the user.
Adds a user to the specified 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.
The Discord client object.
The snowflake identifier of the 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.
Returns the filename of this attachment.
A string containing the filename of this attachment.