| @@ -2,9 +2,9 @@ | |||
| [](https://www.nuget.org/packages/Discord.Net) | |||
| [](https://www.myget.org/feed/Packages/discord-net) | |||
| [](https://dev.azure.com/discord-net/Discord.Net/_build/latest?definitionId=1&branchName=dev) | |||
| [](https://discord.gg/jkrBmQR) | |||
| [](https://discord.gg/jkrBmQR) | |||
| An unofficial .NET API Wrapper for the Discord client (http://discordapp.com). | |||
| An unofficial .NET API Wrapper for the Discord client (https://discord.com). | |||
| Check out the [documentation](https://discord.foxbot.me/) or join the [Discord API Chat](https://discord.gg/jkrBmQR). | |||
| @@ -4,10 +4,10 @@ field, and 2 normal fields using an @Discord.EmbedBuilder: | |||
| ```cs | |||
| var exampleAuthor = new EmbedAuthorBuilder() | |||
| .WithName("I am a bot") | |||
| .WithIconUrl("https://discordapp.com/assets/e05ead6e6ebc08df9291738d0aa6986d.png"); | |||
| .WithIconUrl("https://discord.com/assets/e05ead6e6ebc08df9291738d0aa6986d.png"); | |||
| var exampleFooter = new EmbedFooterBuilder() | |||
| .WithText("I am a nice footer") | |||
| .WithIconUrl("https://discordapp.com/assets/28174a34e77bb5e5310ced9f95cb480b.png"); | |||
| .WithIconUrl("https://discord.com/assets/28174a34e77bb5e5310ced9f95cb480b.png"); | |||
| var exampleField = new EmbedFieldBuilder() | |||
| .WithName("Title of Another Field") | |||
| .WithValue("I am an [example](https://example.com).") | |||
| @@ -22,4 +22,4 @@ var embed = new EmbedBuilder() | |||
| .WithAuthor(exampleAuthor) | |||
| .WithFooter(exampleFooter) | |||
| .Build(); | |||
| ``` | |||
| ``` | |||
| @@ -30,7 +30,7 @@ There are few possible reasons why this may occur. | |||
| [TokenType]: xref:Discord.TokenType | |||
| [827]: https://github.com/RogueException/Discord.Net/issues/827 | |||
| [958]: https://github.com/RogueException/Discord.Net/issues/958 | |||
| [Discord API Terms of Service]: https://discordapp.com/developers/docs/legal | |||
| [Discord API Terms of Service]: https://discord.com/developers/docs/legal | |||
| ## How do I do X, Y, Z when my bot connects/logs on? Why do I get a `NullReferenceException` upon calling any client methods after connect? | |||
| @@ -19,7 +19,7 @@ channels, and are often referred to as "servers". | |||
| * A **Channel** ([IChannel]) represents a generic channel. | |||
| - Example: #dotnet_discord-net | |||
| - See [Channel Types](#channel-types) | |||
| [IGuild]: xref:Discord.IGuild | |||
| [IChannel]: xref:Discord.IChannel | |||
| @@ -79,4 +79,4 @@ activity for listening to a song on Spotify. | |||
| [RichGame]: xref:Discord.RichGame | |||
| [StreamingGame]: xref:Discord.StreamingGame | |||
| [SpotifyGame]: xref:Discord.SpotifyGame | |||
| [Rich Presence Intro]: https://discordapp.com/developers/docs/rich-presence/best-practices | |||
| [Rich Presence Intro]: https://discord.com/developers/docs/rich-presence/best-practices | |||
| @@ -31,7 +31,7 @@ the Discord Applications Portal first. | |||
|  | |||
| [Discord Applications Portal]: https://discordapp.com/developers/applications/ | |||
| [Discord Applications Portal]: https://discord.com/developers/applications/ | |||
| ## Adding your bot to a server | |||
| @@ -165,11 +165,11 @@ or any other blocking method, such as reading from the console. | |||
| > the source code for your bot. | |||
| > | |||
| > In the following example, we retrieve the token from a pre-defined | |||
| > variable, which is **NOT** secure, especially if you plan on | |||
| > variable, which is **NOT** secure, especially if you plan on | |||
| > distributing the application in any shape or form. | |||
| > | |||
| > We recommend alternative storage such as | |||
| > [Environment Variables], an external configuration file, or a | |||
| > We recommend alternative storage such as | |||
| > [Environment Variables], an external configuration file, or a | |||
| > secrets manager for safe-handling of secrets. | |||
| > | |||
| > [Environment Variables]: https://en.wikipedia.org/wiki/Environment_variable | |||
| @@ -221,4 +221,4 @@ should be to separate... | |||
| 2. the modules (handle commands) | |||
| 3. the services (persistent storage, pure functions, data manipulation) | |||
| [CommandService]: xref:Discord.Commands.CommandService | |||
| [CommandService]: xref:Discord.Commands.CommandService | |||
| @@ -11,12 +11,12 @@ title: Home | |||
| [](https://www.nuget.org/packages/Discord.Net) | |||
| [](https://www.myget.org/feed/Packages/discord-net) | |||
| [](https://dev.azure.com/discord-net/Discord.Net/_build/latest?definitionId=1&branchName=dev) | |||
| [](https://discord.gg/jkrBmQR) | |||
| [](https://discord.gg/jkrBmQR) | |||
| ## What is Discord.Net? | |||
| Discord.Net is an asynchronous, multi-platform .NET Library used to | |||
| interface with the [Discord API](https://discordapp.com/). | |||
| interface with the [Discord API](https://discord.com/). | |||
| ## Where to begin? | |||
| @@ -14,10 +14,10 @@ namespace _04_webhook_client | |||
| public async Task MainAsync() | |||
| { | |||
| // The webhook url follows the format https://discordapp.com/api/webhooks/{id}/{token} | |||
| // The webhook url follows the format https://discord.com/api/webhooks/{id}/{token} | |||
| // Because anyone with the webhook URL can use your webhook | |||
| // you should NOT hard code the URL or ID + token into your application. | |||
| using (var client = new DiscordWebhookClient("https://discordapp.com/api/webhooks/123/abc123")) | |||
| // you should NOT hard code the URL or ID + token into your application. | |||
| using (var client = new DiscordWebhookClient("https://discord.com/api/webhooks/123/abc123")) | |||
| { | |||
| var embed = new EmbedBuilder | |||
| { | |||
| @@ -26,7 +26,7 @@ namespace _04_webhook_client | |||
| }; | |||
| // Webhooks are able to send multiple embeds per message | |||
| // As such, your embeds must be passed as a collection. | |||
| // As such, your embeds must be passed as a collection. | |||
| await client.SendMessageAsync(text: "Send a message to this webhook!", embeds: new[] { embed.Build() }); | |||
| } | |||
| } | |||
| @@ -1,4 +1,5 @@ | |||
| using System; | |||
| using System; | |||
| using System.Collections.Generic; | |||
| using System.Threading.Tasks; | |||
| namespace Discord.Audio | |||
| @@ -20,6 +21,9 @@ namespace Discord.Audio | |||
| /// <summary> Gets the estimated round-trip latency, in milliseconds, to the voice UDP server. </summary> | |||
| int UdpLatency { get; } | |||
| /// <summary>Gets the current audio streams.</summary> | |||
| IReadOnlyDictionary<ulong, AudioInStream> GetStreams(); | |||
| Task StopAsync(); | |||
| Task SetSpeakingAsync(bool value); | |||
| @@ -7,6 +7,17 @@ namespace Discord | |||
| /// </summary> | |||
| public static class CDN | |||
| { | |||
| /// <summary> | |||
| /// Returns a team icon URL. | |||
| /// </summary> | |||
| /// <param name="teamId">The team identifier.</param> | |||
| /// <param name="iconId">The icon identifier.</param> | |||
| /// <returns> | |||
| /// A URL pointing to the team's icon. | |||
| /// </returns> | |||
| public static string GetTeamIconUrl(ulong teamId, string iconId) | |||
| => iconId != null ? $"{DiscordConfig.CDNUrl}team-icons/{teamId}/{iconId}.jpg" : null; | |||
| /// <summary> | |||
| /// Returns an application icon URL. | |||
| /// </summary> | |||
| @@ -62,11 +73,21 @@ namespace Discord | |||
| /// <param name="guildId">The guild snowflake identifier.</param> | |||
| /// <param name="splashId">The splash icon identifier.</param> | |||
| /// <returns> | |||
| /// A URL pointing to the guild's icon. | |||
| /// A URL pointing to the guild's splash. | |||
| /// </returns> | |||
| public static string GetGuildSplashUrl(ulong guildId, string splashId) | |||
| => splashId != null ? $"{DiscordConfig.CDNUrl}splashes/{guildId}/{splashId}.jpg" : null; | |||
| /// <summary> | |||
| /// Returns a guild discovery splash URL. | |||
| /// </summary> | |||
| /// <param name="guildId">The guild snowflake identifier.</param> | |||
| /// <param name="discoverySplashId">The discovery splash icon identifier.</param> | |||
| /// <returns> | |||
| /// A URL pointing to the guild's discovery splash. | |||
| /// </returns> | |||
| public static string GetGuildDiscoverySplashUrl(ulong guildId, string discoverySplashId) | |||
| => discoverySplashId != null ? $"{DiscordConfig.CDNUrl}discovery-splashes/{guildId}/{discoverySplashId}.jpg" : null; | |||
| /// <summary> | |||
| /// Returns a channel icon URL. | |||
| /// </summary> | |||
| /// <param name="channelId">The channel snowflake identifier.</param> | |||
| @@ -13,7 +13,7 @@ namespace Discord | |||
| /// <returns> | |||
| /// An <see cref="int"/> representing the API version that Discord.Net uses to communicate with Discord. | |||
| /// <para>A list of available API version can be seen on the official | |||
| /// <see href="https://discordapp.com/developers/docs/reference#api-versioning">Discord API documentation</see> | |||
| /// <see href="https://discord.com/developers/docs/reference#api-versioning">Discord API documentation</see> | |||
| /// .</para> | |||
| /// </returns> | |||
| public const int APIVersion = 6; | |||
| @@ -50,7 +50,7 @@ namespace Discord | |||
| /// <returns> | |||
| /// The Discord API URL using <see cref="APIVersion"/>. | |||
| /// </returns> | |||
| public static readonly string APIUrl = $"https://discordapp.com/api/v{APIVersion}/"; | |||
| public static readonly string APIUrl = $"https://discord.com/api/v{APIVersion}/"; | |||
| /// <summary> | |||
| /// Returns the base Discord CDN URL. | |||
| /// </summary> | |||
| @@ -28,7 +28,7 @@ namespace Discord | |||
| /// </summary> | |||
| /// <remarks> | |||
| /// Setting this value to a category's snowflake identifier will change or set this channel's parent to the | |||
| /// specified channel; setting this value to <c>0</c> will detach this channel from its parent if one | |||
| /// specified channel; setting this value to <see langword="null"/> will detach this channel from its parent if one | |||
| /// is set. | |||
| /// </remarks> | |||
| public Optional<ulong?> CategoryId { get; set; } | |||
| @@ -0,0 +1,9 @@ | |||
| namespace Discord | |||
| { | |||
| /// <summary> | |||
| /// Represents a generic news channel in a guild that can send and receive messages. | |||
| /// </summary> | |||
| public interface INewsChannel : ITextChannel | |||
| { | |||
| } | |||
| } | |||
| @@ -0,0 +1,21 @@ | |||
| namespace Discord | |||
| { | |||
| /// <summary> | |||
| /// Provides properties that are used to modify the widget of an <see cref="IGuild" /> with the specified changes. | |||
| /// </summary> | |||
| public class GuildWidgetProperties | |||
| { | |||
| /// <summary> | |||
| /// Sets whether the widget should be enabled. | |||
| /// </summary> | |||
| public Optional<bool> Enabled { get; set; } | |||
| /// <summary> | |||
| /// Sets the channel that the invite should place its users in, if not <see langword="null" />. | |||
| /// </summary> | |||
| public Optional<IChannel> Channel { get; set; } | |||
| /// <summary> | |||
| /// Sets the channel that the invite should place its users in, if not <see langword="null" />. | |||
| /// </summary> | |||
| public Optional<ulong?> ChannelId { get; set; } | |||
| } | |||
| } | |||
| @@ -23,7 +23,7 @@ namespace Discord | |||
| /// automatically moved to the AFK voice channel. | |||
| /// </summary> | |||
| /// <returns> | |||
| /// An <see cref="int"/> representing the amount of time in seconds for a user to be marked as inactive | |||
| /// An <see langword="int"/> representing the amount of time in seconds for a user to be marked as inactive | |||
| /// and moved into the AFK voice channel. | |||
| /// </returns> | |||
| int AFKTimeout { get; } | |||
| @@ -31,10 +31,17 @@ namespace Discord | |||
| /// Gets a value that indicates whether this guild is embeddable (i.e. can use widget). | |||
| /// </summary> | |||
| /// <returns> | |||
| /// <c>true</c> if this guild can be embedded via widgets; otherwise <c>false</c>. | |||
| /// <see langword="true" /> if this guild has a widget enabled; otherwise <see langword="false" />. | |||
| /// </returns> | |||
| bool IsEmbeddable { get; } | |||
| /// <summary> | |||
| /// Gets a value that indicates whether this guild has the widget enabled. | |||
| /// </summary> | |||
| /// <returns> | |||
| /// <see langword="true" /> if this guild has a widget enabled; otherwise <see langword="false" />. | |||
| /// </returns> | |||
| bool IsWidgetEnabled { get; } | |||
| /// <summary> | |||
| /// Gets the default message notifications for users who haven't explicitly set their notification settings. | |||
| /// </summary> | |||
| DefaultMessageNotifications DefaultMessageNotifications { get; } | |||
| @@ -64,31 +71,45 @@ namespace Discord | |||
| /// Gets the ID of this guild's icon. | |||
| /// </summary> | |||
| /// <returns> | |||
| /// An identifier for the splash image; <c>null</c> if none is set. | |||
| /// An identifier for the splash image; <see langword="null" /> if none is set. | |||
| /// </returns> | |||
| string IconId { get; } | |||
| /// <summary> | |||
| /// Gets the URL of this guild's icon. | |||
| /// </summary> | |||
| /// <returns> | |||
| /// A URL pointing to the guild's icon; <c>null</c> if none is set. | |||
| /// A URL pointing to the guild's icon; <see langword="null" /> if none is set. | |||
| /// </returns> | |||
| string IconUrl { get; } | |||
| /// <summary> | |||
| /// Gets the ID of this guild's splash image. | |||
| /// </summary> | |||
| /// <returns> | |||
| /// An identifier for the splash image; <c>null</c> if none is set. | |||
| /// An identifier for the splash image; <see langword="null" /> if none is set. | |||
| /// </returns> | |||
| string SplashId { get; } | |||
| /// <summary> | |||
| /// Gets the URL of this guild's splash image. | |||
| /// </summary> | |||
| /// <returns> | |||
| /// A URL pointing to the guild's splash image; <c>null</c> if none is set. | |||
| /// A URL pointing to the guild's splash image; <see langword="null" /> if none is set. | |||
| /// </returns> | |||
| string SplashUrl { get; } | |||
| /// <summary> | |||
| /// Gets the ID of this guild's discovery splash image. | |||
| /// </summary> | |||
| /// <returns> | |||
| /// An identifier for the discovery splash image; <see langword="null" /> if none is set. | |||
| /// </returns> | |||
| string DiscoverySplashId { get; } | |||
| /// <summary> | |||
| /// Gets the URL of this guild's discovery splash image. | |||
| /// </summary> | |||
| /// <returns> | |||
| /// A URL pointing to the guild's discovery splash image; <see langword="null" /> if none is set. | |||
| /// </returns> | |||
| string DiscoverySplashUrl { get; } | |||
| /// <summary> | |||
| /// Determines if this guild is currently connected and ready to be used. | |||
| /// </summary> | |||
| /// <remarks> | |||
| @@ -98,7 +119,7 @@ namespace Discord | |||
| /// This boolean is used to determine if the guild is currently connected to the WebSocket and is ready to be used/accessed. | |||
| /// </remarks> | |||
| /// <returns> | |||
| /// <c>true</c> if this guild is currently connected and ready to be used; otherwise <c>false</c>. | |||
| /// <c>true</c> if this guild is currently connected and ready to be used; otherwise <see langword="false"/>. | |||
| /// </returns> | |||
| bool Available { get; } | |||
| @@ -106,7 +127,7 @@ namespace Discord | |||
| /// Gets the ID of the AFK voice channel for this guild. | |||
| /// </summary> | |||
| /// <returns> | |||
| /// A <see cref="ulong"/> representing the snowflake identifier of the AFK voice channel; <c>null</c> if | |||
| /// A <see langword="ulong"/> representing the snowflake identifier of the AFK voice channel; <see langword="null" /> if | |||
| /// none is set. | |||
| /// </returns> | |||
| ulong? AFKChannelId { get; } | |||
| @@ -121,7 +142,7 @@ namespace Discord | |||
| /// </note> | |||
| /// </remarks> | |||
| /// <returns> | |||
| /// A <see cref="ulong"/> representing the snowflake identifier of the default text channel; <c>0</c> if | |||
| /// A <see langword="ulong"/> representing the snowflake identifier of the default text channel; <c>0</c> if | |||
| /// none can be found. | |||
| /// </returns> | |||
| ulong DefaultChannelId { get; } | |||
| @@ -129,30 +150,54 @@ namespace Discord | |||
| /// Gets the ID of the widget embed channel of this guild. | |||
| /// </summary> | |||
| /// <returns> | |||
| /// A <see cref="ulong"/> representing the snowflake identifier of the embedded channel found within the | |||
| /// widget settings of this guild; <c>null</c> if none is set. | |||
| /// A <see langword="ulong"/> representing the snowflake identifier of the embedded channel found within the | |||
| /// widget settings of this guild; <see langword="null" /> if none is set. | |||
| /// </returns> | |||
| ulong? EmbedChannelId { get; } | |||
| /// <summary> | |||
| /// Gets the ID of the channel assigned to the widget of this guild. | |||
| /// </summary> | |||
| /// <returns> | |||
| /// A <see langword="ulong"/> representing the snowflake identifier of the channel assigned to the widget found | |||
| /// within the widget settings of this guild; <see langword="null" /> if none is set. | |||
| /// </returns> | |||
| ulong? WidgetChannelId { get; } | |||
| /// <summary> | |||
| /// Gets the ID of the channel where randomized welcome messages are sent. | |||
| /// </summary> | |||
| /// <returns> | |||
| /// A <see cref="ulong"/> representing the snowflake identifier of the system channel where randomized | |||
| /// welcome messages are sent; <c>null</c> if none is set. | |||
| /// A <see langword="ulong"/> representing the snowflake identifier of the system channel where randomized | |||
| /// welcome messages are sent; <see langword="null" /> if none is set. | |||
| /// </returns> | |||
| ulong? SystemChannelId { get; } | |||
| /// <summary> | |||
| /// Gets the ID of the channel with the rules. | |||
| /// </summary> | |||
| /// <returns> | |||
| /// A <see langword="ulong"/> representing the snowflake identifier of the channel that contains the rules; | |||
| /// <see langword="null" /> if none is set. | |||
| /// </returns> | |||
| ulong? RulesChannelId { get; } | |||
| /// <summary> | |||
| /// Gets the ID of the channel where admins and moderators of Community guilds receive notices from Discord. | |||
| /// </summary> | |||
| /// <returns> | |||
| /// A <see langword="ulong"/> representing the snowflake identifier of the channel where admins and moderators | |||
| /// of Community guilds receive notices from Discord; <see langword="null" /> if none is set. | |||
| /// </returns> | |||
| ulong? PublicUpdatesChannelId { get; } | |||
| /// <summary> | |||
| /// Gets the ID of the user that owns this guild. | |||
| /// </summary> | |||
| /// <returns> | |||
| /// A <see cref="ulong"/> representing the snowflake identifier of the user that owns this guild. | |||
| /// A <see langword="ulong"/> representing the snowflake identifier of the user that owns this guild. | |||
| /// </returns> | |||
| ulong OwnerId { get; } | |||
| /// <summary> | |||
| /// Gets the application ID of the guild creator if it is bot-created. | |||
| /// </summary> | |||
| /// <returns> | |||
| /// A <see cref="ulong"/> representing the snowflake identifier of the application ID that created this guild, or <c>null</c> if it was not bot-created. | |||
| /// A <see langword="ulong"/> representing the snowflake identifier of the application ID that created this guild, or <see langword="null" /> if it was not bot-created. | |||
| /// </returns> | |||
| ulong? ApplicationId { get; } | |||
| /// <summary> | |||
| @@ -208,21 +253,21 @@ namespace Discord | |||
| /// Gets the identifier for this guilds banner image. | |||
| /// </summary> | |||
| /// <returns> | |||
| /// An identifier for the banner image; <c>null</c> if none is set. | |||
| /// An identifier for the banner image; <see langword="null" /> if none is set. | |||
| /// </returns> | |||
| string BannerId { get; } | |||
| /// <summary> | |||
| /// Gets the URL of this guild's banner image. | |||
| /// </summary> | |||
| /// <returns> | |||
| /// A URL pointing to the guild's banner image; <c>null</c> if none is set. | |||
| /// A URL pointing to the guild's banner image; <see langword="null" /> if none is set. | |||
| /// </returns> | |||
| string BannerUrl { get; } | |||
| /// <summary> | |||
| /// Gets the code for this guild's vanity invite URL. | |||
| /// </summary> | |||
| /// <returns> | |||
| /// A string containing the vanity invite code for this guild; <c>null</c> if none is set. | |||
| /// A string containing the vanity invite code for this guild; <see langword="null" /> if none is set. | |||
| /// </returns> | |||
| string VanityURLCode { get; } | |||
| /// <summary> | |||
| @@ -236,7 +281,7 @@ namespace Discord | |||
| /// Gets the description for the guild. | |||
| /// </summary> | |||
| /// <returns> | |||
| /// The description for the guild; <c>null</c> if none is set. | |||
| /// The description for the guild; <see langword="null" /> if none is set. | |||
| /// </returns> | |||
| string Description { get; } | |||
| /// <summary> | |||
| @@ -246,9 +291,50 @@ namespace Discord | |||
| /// This is the number of users who have boosted this guild. | |||
| /// </remarks> | |||
| /// <returns> | |||
| /// The number of premium subscribers of this guild. | |||
| /// The number of premium subscribers of this guild; <see langword="null" /> if not available. | |||
| /// </returns> | |||
| int PremiumSubscriptionCount { get; } | |||
| /// <summary> | |||
| /// Gets the maximum number of presences for the guild. | |||
| /// </summary> | |||
| /// <returns> | |||
| /// The maximum number of presences for the guild. | |||
| /// </returns> | |||
| int? MaxPresences { get; } | |||
| /// <summary> | |||
| /// Gets the maximum number of members for the guild. | |||
| /// </summary> | |||
| /// <returns> | |||
| /// The maximum number of members for the guild. | |||
| /// </returns> | |||
| int? MaxMembers { get; } | |||
| /// <summary> | |||
| /// Gets the maximum amount of users in a video channel. | |||
| /// </summary> | |||
| /// <returns> | |||
| /// The maximum amount of users in a video channel. | |||
| /// </returns> | |||
| int? MaxVideoChannelUsers { get; } | |||
| /// <summary> | |||
| /// Gets the approximate number of members in this guild. | |||
| /// </summary> | |||
| /// <remarks> | |||
| /// Only available when getting a guild via REST when `with_counts` is true. | |||
| /// </remarks> | |||
| /// <returns> | |||
| /// The approximate number of members in this guild. | |||
| /// </returns> | |||
| int? ApproximateMemberCount { get; } | |||
| /// <summary> | |||
| /// Gets the approximate number of non-offline members in this guild. | |||
| /// </summary> | |||
| /// <remarks> | |||
| /// Only available when getting a guild via REST when `with_counts` is true. | |||
| /// </remarks> | |||
| /// <returns> | |||
| /// The approximate number of non-offline members in this guild. | |||
| /// </returns> | |||
| int? ApproximatePresenceCount { get; } | |||
| /// <summary> | |||
| /// Gets the preferred locale of this guild in IETF BCP 47 | |||
| @@ -285,8 +371,18 @@ namespace Discord | |||
| /// <returns> | |||
| /// A task that represents the asynchronous modification operation. | |||
| /// </returns> | |||
| [Obsolete("This endpoint is deprecated, use ModifyWidgetAsync instead.")] | |||
| Task ModifyEmbedAsync(Action<GuildEmbedProperties> func, RequestOptions options = null); | |||
| /// <summary> | |||
| /// Modifies this guild's widget. | |||
| /// </summary> | |||
| /// <param name="func">The delegate containing the properties to modify the guild widget with.</param> | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <returns> | |||
| /// A task that represents the asynchronous modification operation. | |||
| /// </returns> | |||
| Task ModifyWidgetAsync(Action<GuildWidgetProperties> func, RequestOptions options = null); | |||
| /// <summary> | |||
| /// Bulk-modifies the order of channels in this guild. | |||
| /// </summary> | |||
| /// <param name="args">The properties used to modify the channel positions with.</param> | |||
| @@ -336,7 +432,7 @@ namespace Discord | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <returns> | |||
| /// 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; <c>null</c> if the ban entry cannot be found. | |||
| /// contains the user information and the reason for the ban; <see langword="null" /> if the ban entry cannot be found. | |||
| /// </returns> | |||
| Task<IBan> GetBanAsync(IUser user, RequestOptions options = null); | |||
| /// <summary> | |||
| @@ -346,7 +442,7 @@ namespace Discord | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <returns> | |||
| /// 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; <c>null</c> if the ban entry cannot be found. | |||
| /// contains the user information and the reason for the ban; <see langword="null" /> if the ban entry cannot be found. | |||
| /// </returns> | |||
| Task<IBan> GetBanAsync(ulong userId, RequestOptions options = null); | |||
| /// <summary> | |||
| @@ -410,7 +506,7 @@ namespace Discord | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <returns> | |||
| /// A task that represents the asynchronous get operation. The task result contains the generic channel | |||
| /// associated with the specified <paramref name="id"/>; <c>null</c> if none is found. | |||
| /// associated with the specified <paramref name="id"/>; <see langword="null" /> if none is found. | |||
| /// </returns> | |||
| Task<IGuildChannel> GetChannelAsync(ulong id, CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null); | |||
| /// <summary> | |||
| @@ -431,7 +527,7 @@ namespace Discord | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <returns> | |||
| /// A task that represents the asynchronous get operation. The task result contains the text channel | |||
| /// associated with the specified <paramref name="id"/>; <c>null</c> if none is found. | |||
| /// associated with the specified <paramref name="id"/>; <see langword="null" /> if none is found. | |||
| /// </returns> | |||
| Task<ITextChannel> GetTextChannelAsync(ulong id, CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null); | |||
| /// <summary> | |||
| @@ -462,7 +558,7 @@ namespace Discord | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <returns> | |||
| /// A task that represents the asynchronous get operation. The task result contains the voice channel associated | |||
| /// with the specified <paramref name="id"/>; <c>null</c> if none is found. | |||
| /// with the specified <paramref name="id"/>; <see langword="null" /> if none is found. | |||
| /// </returns> | |||
| Task<IVoiceChannel> GetVoiceChannelAsync(ulong id, CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null); | |||
| /// <summary> | |||
| @@ -472,7 +568,7 @@ namespace Discord | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <returns> | |||
| /// 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; <c>null</c> if none is set. | |||
| /// AFK users will be moved to after they have idled for too long; <see langword="null" /> if none is set. | |||
| /// </returns> | |||
| Task<IVoiceChannel> GetAFKChannelAsync(CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null); | |||
| /// <summary> | |||
| @@ -482,7 +578,7 @@ namespace Discord | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <returns> | |||
| /// A task that represents the asynchronous get operation. The task result contains the text channel where | |||
| /// randomized welcome messages will be sent to; <c>null</c> if none is set. | |||
| /// randomized welcome messages will be sent to; <see langword="null" /> if none is set. | |||
| /// </returns> | |||
| Task<ITextChannel> GetSystemChannelAsync(CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null); | |||
| /// <summary> | |||
| @@ -492,7 +588,7 @@ namespace Discord | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <returns> | |||
| /// A task that represents the asynchronous get operation. The task result contains the first viewable text | |||
| /// channel in this guild; <c>null</c> if none is found. | |||
| /// channel in this guild; <see langword="null" /> if none is found. | |||
| /// </returns> | |||
| Task<ITextChannel> GetDefaultChannelAsync(CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null); | |||
| /// <summary> | |||
| @@ -502,9 +598,40 @@ namespace Discord | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <returns> | |||
| /// A task that represents the asynchronous get operation. The task result contains the embed channel set | |||
| /// within the server's widget settings; <c>null</c> if none is set. | |||
| /// within the server's widget settings; <see langword="null" /> if none is set. | |||
| /// </returns> | |||
| [Obsolete("This endpoint is deprecated, use GetWidgetChannelAsync instead.")] | |||
| Task<IGuildChannel> GetEmbedChannelAsync(CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null); | |||
| /// <summary> | |||
| /// Gets the widget channel (i.e. the channel set in the guild's widget settings) in this guild. | |||
| /// </summary> | |||
| /// <param name="mode">The <see cref="CacheMode" /> that determines whether the object should be fetched from cache.</param> | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <returns> | |||
| /// A task that represents the asynchronous get operation. The task result contains the widget channel set | |||
| /// within the server's widget settings; <see langword="null" /> if none is set. | |||
| /// </returns> | |||
| Task<IGuildChannel> GetWidgetChannelAsync(CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null); | |||
| /// <summary> | |||
| /// Gets the text channel where Community guilds can display rules and/or guidelines. | |||
| /// </summary> | |||
| /// <param name="mode">The <see cref="CacheMode"/> that determines whether the object should be fetched from cache.</param> | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <returns> | |||
| /// A task that represents the asynchronous get operation. The task result contains the text channel | |||
| /// where Community guilds can display rules and/or guidelines; <see langword="null" /> if none is set. | |||
| /// </returns> | |||
| Task<ITextChannel> GetRulesChannelAsync(CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null); | |||
| /// <summary> | |||
| /// Gets the text channel channel where admins and moderators of Community guilds receive notices from Discord. | |||
| /// </summary> | |||
| /// <param name="mode">The <see cref="CacheMode"/> that determines whether the object should be fetched from cache.</param> | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <returns> | |||
| /// 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; <see langword="null" /> if none is set. | |||
| /// </returns> | |||
| Task<ITextChannel> GetPublicUpdatesChannelAsync(CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null); | |||
| /// <summary> | |||
| /// Creates a new text channel in this guild. | |||
| @@ -573,7 +700,7 @@ namespace Discord | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <returns> | |||
| /// A task that represents the asynchronous get operation. The task result contains the partial metadata of | |||
| /// the vanity invite found within this guild; <c>null</c> if none is found. | |||
| /// the vanity invite found within this guild; <see langword="null" /> if none is found. | |||
| /// </returns> | |||
| Task<IInviteMetadata> GetVanityInviteAsync(RequestOptions options = null); | |||
| @@ -582,7 +709,7 @@ namespace Discord | |||
| /// </summary> | |||
| /// <param name="id">The snowflake identifier for the role.</param> | |||
| /// <returns> | |||
| /// A role that is associated with the specified <paramref name="id"/>; <c>null</c> if none is found. | |||
| /// A role that is associated with the specified <paramref name="id"/>; <see langword="null" /> if none is found. | |||
| /// </returns> | |||
| IRole GetRole(ulong id); | |||
| /// <summary> | |||
| @@ -624,7 +751,7 @@ namespace Discord | |||
| /// <param name="accessToken">The OAuth2 access token for the user, requested with the guilds.join scope.</param> | |||
| /// <param name="func">The delegate containing the properties to be applied to the user upon being added to the guild.</param> | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <returns>A guild user associated with the specified <paramref name="userId" />; <c>null</c> if the user is already in the guild.</returns> | |||
| /// <returns>A guild user associated with the specified <paramref name="userId" />; <see langword="null" /> if the user is already in the guild.</returns> | |||
| Task<IGuildUser> AddGuildUserAsync(ulong userId, string accessToken, Action<AddGuildUserProperties> func = null, RequestOptions options = null); | |||
| /// <summary> | |||
| /// Gets a collection of all users in this guild. | |||
| @@ -649,7 +776,7 @@ namespace Discord | |||
| /// <remarks> | |||
| /// This method retrieves a user found within this guild. | |||
| /// <note> | |||
| /// This may return <c>null</c> in the WebSocket implementation due to incomplete user collection in | |||
| /// This may return <see langword="null" /> in the WebSocket implementation due to incomplete user collection in | |||
| /// large guilds. | |||
| /// </note> | |||
| /// </remarks> | |||
| @@ -658,7 +785,7 @@ namespace Discord | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <returns> | |||
| /// A task that represents the asynchronous get operation. The task result contains the guild user | |||
| /// associated with the specified <paramref name="id"/>; <c>null</c> if none is found. | |||
| /// associated with the specified <paramref name="id"/>; <see langword="null" /> if none is found. | |||
| /// </returns> | |||
| Task<IGuildUser> GetUserAsync(ulong id, CacheMode mode = CacheMode.AllowDownload, RequestOptions options = null); | |||
| /// <summary> | |||
| @@ -705,11 +832,12 @@ namespace Discord | |||
| /// <param name="days">The number of days required for the users to be kicked.</param> | |||
| /// <param name="simulate">Whether this prune action is a simulation.</param> | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <param name="includeRoleIds">An array of role IDs to be included in the prune of users who do not have any additional roles.</param> | |||
| /// <returns> | |||
| /// 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. | |||
| /// </returns> | |||
| Task<int> PruneUsersAsync(int days = 30, bool simulate = false, RequestOptions options = null); | |||
| Task<int> PruneUsersAsync(int days = 30, bool simulate = false, RequestOptions options = null, IEnumerable<ulong> includeRoleIds = null); | |||
| /// <summary> | |||
| /// Gets a collection of users in this guild that the name or nickname starts with the | |||
| /// provided <see cref="string"/> at <paramref name="query"/>. | |||
| @@ -751,7 +879,7 @@ namespace Discord | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <returns> | |||
| /// A task that represents the asynchronous get operation. The task result contains the webhook with the | |||
| /// specified <paramref name="id"/>; <c>null</c> if none is found. | |||
| /// specified <paramref name="id"/>; <see langword="null" /> if none is found. | |||
| /// </returns> | |||
| Task<IWebhook> GetWebhookAsync(ulong id, RequestOptions options = null); | |||
| /// <summary> | |||
| @@ -771,7 +899,7 @@ namespace Discord | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <returns> | |||
| /// A task that represents the asynchronous get operation. The task result contains the emote found with the | |||
| /// specified <paramref name="id"/>; <c>null</c> if none is found. | |||
| /// specified <paramref name="id"/>; <see langword="null" /> if none is found. | |||
| /// </returns> | |||
| Task<GuildEmote> GetEmoteAsync(ulong id, RequestOptions options = null); | |||
| /// <summary> | |||
| @@ -22,6 +22,18 @@ namespace Discord | |||
| /// Gets the icon URL of the application. | |||
| /// </summary> | |||
| string IconUrl { get; } | |||
| /// <summary> | |||
| /// Gets if the bot is public. | |||
| /// </summary> | |||
| bool IsBotPublic { get; } | |||
| /// <summary> | |||
| /// Gets if the bot requires code grant. | |||
| /// </summary> | |||
| bool BotRequiresCodeGrant { get; } | |||
| /// <summary> | |||
| /// Gets the team associated with this application if there is one. | |||
| /// </summary> | |||
| ITeam Team { get; } | |||
| /// <summary> | |||
| /// Gets the partial user object containing info on the owner of the application. | |||
| @@ -10,6 +10,7 @@ namespace Discord | |||
| /// <summary> | |||
| /// Updates this object's properties with its current state. | |||
| /// </summary> | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| Task UpdateAsync(RequestOptions options = null); | |||
| } | |||
| } | |||
| @@ -0,0 +1,14 @@ | |||
| namespace Discord | |||
| { | |||
| public enum TargetUserType | |||
| { | |||
| /// <summary> | |||
| /// The invite whose target user type is not defined. | |||
| /// </summary> | |||
| Undefined = 0, | |||
| /// <summary> | |||
| /// The invite is for a Go Live stream. | |||
| /// </summary> | |||
| Stream = 1 | |||
| } | |||
| } | |||
| @@ -39,6 +39,13 @@ namespace Discord | |||
| /// </returns> | |||
| bool IsSuppressed { get; } | |||
| /// <summary> | |||
| /// Gets the value that indicates whether this message mentioned everyone. | |||
| /// </summary> | |||
| /// <returns> | |||
| /// <c>true</c> if this message mentioned everyone; otherwise <c>false</c>. | |||
| /// </returns> | |||
| bool MentionedEveryone { get; } | |||
| /// <summary> | |||
| /// Gets the content for this message. | |||
| /// </summary> | |||
| /// <returns> | |||
| @@ -17,7 +17,7 @@ namespace Discord | |||
| /// <summary> Gets a <see cref="ChannelPermissions"/> that grants all permissions for category channels. </summary> | |||
| public static readonly ChannelPermissions Category = new ChannelPermissions(0b01100_1111110_1111111110001_010001); | |||
| /// <summary> Gets a <see cref="ChannelPermissions"/> that grants all permissions for direct message channels. </summary> | |||
| public static readonly ChannelPermissions DM = new ChannelPermissions(0b00000_1000110_1011100110000_000000); | |||
| public static readonly ChannelPermissions DM = new ChannelPermissions(0b00000_1000110_1011100110001_000000); | |||
| /// <summary> Gets a <see cref="ChannelPermissions"/> that grants all permissions for group channels. </summary> | |||
| public static readonly ChannelPermissions Group = new ChannelPermissions(0b00000_1000110_0001101100000_000000); | |||
| /// <summary> Gets a <see cref="ChannelPermissions"/> that grants all permissions for a given channel type. </summary> | |||
| @@ -51,6 +51,10 @@ namespace Discord | |||
| /// authentication when used on a guild that has server-wide 2FA enabled. | |||
| /// </remarks> | |||
| ManageGuild = 0x00_00_00_20, | |||
| /// <summary> | |||
| /// Allows for viewing of guild insights | |||
| /// </summary> | |||
| ViewGuildInsights = 0x00_08_00_00, | |||
| // Text | |||
| /// <summary> | |||
| @@ -12,7 +12,7 @@ namespace Discord | |||
| /// <summary> Gets a <see cref="GuildPermissions"/> that grants all guild permissions for webhook users. </summary> | |||
| public static readonly GuildPermissions Webhook = new GuildPermissions(0b00000_0000000_0001101100000_000000); | |||
| /// <summary> Gets a <see cref="GuildPermissions"/> that grants all guild permissions. </summary> | |||
| public static readonly GuildPermissions All = new GuildPermissions(0b11111_1111110_1111111111111_111111); | |||
| public static readonly GuildPermissions All = new GuildPermissions(0b11111_1111111_1111111111111_111111); | |||
| /// <summary> Gets a packed value representing all the permissions in this <see cref="GuildPermissions"/>. </summary> | |||
| public ulong RawValue { get; } | |||
| @@ -34,6 +34,8 @@ namespace Discord | |||
| public bool AddReactions => Permissions.GetValue(RawValue, GuildPermission.AddReactions); | |||
| /// <summary> If <c>true</c>, a user may view the audit log. </summary> | |||
| public bool ViewAuditLog => Permissions.GetValue(RawValue, GuildPermission.ViewAuditLog); | |||
| /// <summary> If <c>true</c>, a user may view the guild insights. </summary> | |||
| public bool ViewGuildInsights => Permissions.GetValue(RawValue, GuildPermission.ViewGuildInsights); | |||
| /// <summary> If True, a user may join channels. </summary> | |||
| [Obsolete("Use ViewChannel instead.")] | |||
| @@ -97,6 +99,7 @@ namespace Discord | |||
| bool? manageGuild = null, | |||
| bool? addReactions = null, | |||
| bool? viewAuditLog = null, | |||
| bool? viewGuildInsights = null, | |||
| bool? viewChannel = null, | |||
| bool? sendMessages = null, | |||
| bool? sendTTSMessages = null, | |||
| @@ -130,6 +133,7 @@ namespace Discord | |||
| Permissions.SetValue(ref value, manageGuild, GuildPermission.ManageGuild); | |||
| Permissions.SetValue(ref value, addReactions, GuildPermission.AddReactions); | |||
| Permissions.SetValue(ref value, viewAuditLog, GuildPermission.ViewAuditLog); | |||
| Permissions.SetValue(ref value, viewGuildInsights, GuildPermission.ViewGuildInsights); | |||
| Permissions.SetValue(ref value, viewChannel, GuildPermission.ViewChannel); | |||
| Permissions.SetValue(ref value, sendMessages, GuildPermission.SendMessages); | |||
| Permissions.SetValue(ref value, sendTTSMessages, GuildPermission.SendTTSMessages); | |||
| @@ -166,6 +170,7 @@ namespace Discord | |||
| bool manageGuild = false, | |||
| bool addReactions = false, | |||
| bool viewAuditLog = false, | |||
| bool viewGuildInsights = false, | |||
| bool viewChannel = false, | |||
| bool sendMessages = false, | |||
| bool sendTTSMessages = false, | |||
| @@ -198,6 +203,7 @@ namespace Discord | |||
| manageGuild: manageGuild, | |||
| addReactions: addReactions, | |||
| viewAuditLog: viewAuditLog, | |||
| viewGuildInsights: viewGuildInsights, | |||
| viewChannel: viewChannel, | |||
| sendMessages: sendMessages, | |||
| sendTTSMessages: sendTTSMessages, | |||
| @@ -231,6 +237,7 @@ namespace Discord | |||
| bool? manageGuild = null, | |||
| bool? addReactions = null, | |||
| bool? viewAuditLog = null, | |||
| bool? viewGuildInsights = null, | |||
| bool? viewChannel = null, | |||
| bool? sendMessages = null, | |||
| bool? sendTTSMessages = null, | |||
| @@ -254,7 +261,7 @@ namespace Discord | |||
| bool? manageWebhooks = null, | |||
| bool? manageEmojis = null) | |||
| => new GuildPermissions(RawValue, createInstantInvite, kickMembers, banMembers, administrator, manageChannels, manageGuild, addReactions, | |||
| viewAuditLog, viewChannel, sendMessages, sendTTSMessages, manageMessages, embedLinks, attachFiles, | |||
| viewAuditLog, viewGuildInsights, viewChannel, sendMessages, sendTTSMessages, manageMessages, embedLinks, attachFiles, | |||
| readMessageHistory, mentionEveryone, useExternalEmojis, connect, speak, muteMembers, deafenMembers, moveMembers, | |||
| useVoiceActivation, prioritySpeaker, stream, changeNickname, manageNicknames, manageRoles, manageWebhooks, manageEmojis); | |||
| @@ -76,6 +76,10 @@ namespace Discord | |||
| public PermValue MoveMembers => Permissions.GetValue(AllowValue, DenyValue, ChannelPermission.MoveMembers); | |||
| /// <summary> If Allowed, a user may use voice-activity-detection rather than push-to-talk. </summary> | |||
| public PermValue UseVAD => Permissions.GetValue(AllowValue, DenyValue, ChannelPermission.UseVAD); | |||
| /// <summary> If Allowed, a user may use priority speaker in a voice channel. </summary> | |||
| public PermValue PrioritySpeaker => Permissions.GetValue(AllowValue, DenyValue, ChannelPermission.PrioritySpeaker); | |||
| /// <summary> If Allowed, a user may go live in a voice channel. </summary> | |||
| public PermValue Stream => Permissions.GetValue(AllowValue, DenyValue, ChannelPermission.Stream); | |||
| /// <summary> If Allowed, a user may adjust role permissions. This also implicitly grants all other permissions. </summary> | |||
| public PermValue ManageRoles => Permissions.GetValue(AllowValue, DenyValue, ChannelPermission.ManageRoles); | |||
| @@ -109,7 +113,9 @@ namespace Discord | |||
| PermValue? moveMembers = null, | |||
| PermValue? useVoiceActivation = null, | |||
| PermValue? manageRoles = null, | |||
| PermValue? manageWebhooks = null) | |||
| PermValue? manageWebhooks = null, | |||
| PermValue? prioritySpeaker = null, | |||
| PermValue? stream = null) | |||
| { | |||
| Permissions.SetValue(ref allowValue, ref denyValue, createInstantInvite, ChannelPermission.CreateInstantInvite); | |||
| Permissions.SetValue(ref allowValue, ref denyValue, manageChannel, ChannelPermission.ManageChannels); | |||
| @@ -129,6 +135,8 @@ namespace Discord | |||
| Permissions.SetValue(ref allowValue, ref denyValue, deafenMembers, ChannelPermission.DeafenMembers); | |||
| Permissions.SetValue(ref allowValue, ref denyValue, moveMembers, ChannelPermission.MoveMembers); | |||
| Permissions.SetValue(ref allowValue, ref denyValue, useVoiceActivation, ChannelPermission.UseVAD); | |||
| Permissions.SetValue(ref allowValue, ref denyValue, prioritySpeaker, ChannelPermission.PrioritySpeaker); | |||
| Permissions.SetValue(ref allowValue, ref denyValue, stream, ChannelPermission.Stream); | |||
| Permissions.SetValue(ref allowValue, ref denyValue, manageRoles, ChannelPermission.ManageRoles); | |||
| Permissions.SetValue(ref allowValue, ref denyValue, manageWebhooks, ChannelPermission.ManageWebhooks); | |||
| @@ -159,10 +167,12 @@ namespace Discord | |||
| PermValue moveMembers = PermValue.Inherit, | |||
| PermValue useVoiceActivation = PermValue.Inherit, | |||
| PermValue manageRoles = PermValue.Inherit, | |||
| PermValue manageWebhooks = PermValue.Inherit) | |||
| PermValue manageWebhooks = PermValue.Inherit, | |||
| PermValue prioritySpeaker = PermValue.Inherit, | |||
| PermValue stream = PermValue.Inherit) | |||
| : this(0, 0, createInstantInvite, manageChannel, addReactions, viewChannel, sendMessages, sendTTSMessages, manageMessages, | |||
| embedLinks, attachFiles, readMessageHistory, mentionEveryone, useExternalEmojis, connect, speak, muteMembers, deafenMembers, | |||
| moveMembers, useVoiceActivation, manageRoles, manageWebhooks) { } | |||
| moveMembers, useVoiceActivation, manageRoles, manageWebhooks, prioritySpeaker, stream) { } | |||
| /// <summary> | |||
| /// Initializes a new <see cref="OverwritePermissions" /> from the current one, changing the provided | |||
| @@ -188,10 +198,12 @@ namespace Discord | |||
| PermValue? moveMembers = null, | |||
| PermValue? useVoiceActivation = null, | |||
| PermValue? manageRoles = null, | |||
| PermValue? manageWebhooks = null) | |||
| PermValue? manageWebhooks = null, | |||
| PermValue? prioritySpeaker = null, | |||
| PermValue? stream = null) | |||
| => new OverwritePermissions(AllowValue, DenyValue, createInstantInvite, manageChannel, addReactions, viewChannel, sendMessages, sendTTSMessages, manageMessages, | |||
| embedLinks, attachFiles, readMessageHistory, mentionEveryone, useExternalEmojis, connect, speak, muteMembers, deafenMembers, | |||
| moveMembers, useVoiceActivation, manageRoles, manageWebhooks); | |||
| moveMembers, useVoiceActivation, manageRoles, manageWebhooks, prioritySpeaker, stream); | |||
| /// <summary> | |||
| /// Creates a <see cref="List{T}"/> of all the <see cref="ChannelPermission"/> values that are allowed. | |||
| @@ -0,0 +1,27 @@ | |||
| using System.Collections.Generic; | |||
| namespace Discord | |||
| { | |||
| /// <summary> | |||
| /// Represents a Discord Team. | |||
| /// </summary> | |||
| public interface ITeam | |||
| { | |||
| /// <summary> | |||
| /// Gets the team icon url. | |||
| /// </summary> | |||
| string IconUrl { get; } | |||
| /// <summary> | |||
| /// Gets the team unique identifier. | |||
| /// </summary> | |||
| ulong Id { get; } | |||
| /// <summary> | |||
| /// Gets the members of this team. | |||
| /// </summary> | |||
| IReadOnlyList<ITeamMember> TeamMembers { get; } | |||
| /// <summary> | |||
| /// Gets the user identifier that owns this team. | |||
| /// </summary> | |||
| ulong OwnerUserId { get; } | |||
| } | |||
| } | |||
| @@ -0,0 +1,25 @@ | |||
| namespace Discord | |||
| { | |||
| /// <summary> | |||
| /// Represents a Discord Team member. | |||
| /// </summary> | |||
| public interface ITeamMember | |||
| { | |||
| /// <summary> | |||
| /// Gets the membership state of this team member. | |||
| /// </summary> | |||
| MembershipState MembershipState { get; } | |||
| /// <summary> | |||
| /// Gets the permissions of this team member. | |||
| /// </summary> | |||
| string[] Permissions { get; } | |||
| /// <summary> | |||
| /// Gets the team unique identifier for this team member. | |||
| /// </summary> | |||
| ulong TeamId { get; } | |||
| /// <summary> | |||
| /// Gets the Discord user of this team member. | |||
| /// </summary> | |||
| IUser User { get; } | |||
| } | |||
| } | |||
| @@ -0,0 +1,11 @@ | |||
| namespace Discord | |||
| { | |||
| /// <summary> | |||
| /// Represents the membership state of a team member. | |||
| /// </summary> | |||
| public enum MembershipState | |||
| { | |||
| Invited, | |||
| Accepted, | |||
| } | |||
| } | |||
| @@ -17,7 +17,7 @@ namespace Discord | |||
| public static string GetJumpUrl(this IMessage msg) | |||
| { | |||
| var channel = msg.Channel; | |||
| return $"https://discordapp.com/channels/{(channel is IDMChannel ? "@me" : $"{(channel as ITextChannel).GuildId}")}/{channel.Id}/{msg.Id}"; | |||
| return $"https://discord.com/channels/{(channel is IDMChannel ? "@me" : $"{(channel as ITextChannel).GuildId}")}/{channel.Id}/{msg.Id}"; | |||
| } | |||
| /// <summary> | |||
| @@ -13,7 +13,7 @@ namespace Discord.Net | |||
| /// </summary> | |||
| /// <returns> | |||
| /// An | |||
| /// <see href="https://discordapp.com/developers/docs/topics/opcodes-and-status-codes#http">HTTP status code</see> | |||
| /// <see href="https://discord.com/developers/docs/topics/opcodes-and-status-codes#http">HTTP status code</see> | |||
| /// from Discord. | |||
| /// </returns> | |||
| public HttpStatusCode HttpCode { get; } | |||
| @@ -22,7 +22,7 @@ namespace Discord.Net | |||
| /// </summary> | |||
| /// <returns> | |||
| /// A | |||
| /// <see href="https://discordapp.com/developers/docs/topics/opcodes-and-status-codes#json">JSON error code</see> | |||
| /// <see href="https://discord.com/developers/docs/topics/opcodes-and-status-codes#json">JSON error code</see> | |||
| /// from Discord, or <c>null</c> if none. | |||
| /// </returns> | |||
| public int? DiscordCode { get; } | |||
| @@ -11,7 +11,7 @@ namespace Discord.Net | |||
| /// </summary> | |||
| /// <returns> | |||
| /// A | |||
| /// <see href="https://discordapp.com/developers/docs/topics/opcodes-and-status-codes#gateway-gateway-close-event-codes">close code</see> | |||
| /// <see href="https://discord.com/developers/docs/topics/opcodes-and-status-codes#gateway-gateway-close-event-codes">close code</see> | |||
| /// from Discord. | |||
| /// </returns> | |||
| public int CloseCode { get; } | |||
| @@ -1,4 +1,4 @@ | |||
| #pragma warning disable CS1591 | |||
| #pragma warning disable CS1591 | |||
| using Newtonsoft.Json; | |||
| namespace Discord.API | |||
| @@ -15,6 +15,12 @@ namespace Discord.API | |||
| public ulong Id { get; set; } | |||
| [JsonProperty("icon")] | |||
| public string Icon { get; set; } | |||
| [JsonProperty("bot_public")] | |||
| public bool IsBotPublic { get; set; } | |||
| [JsonProperty("bot_require_code_grant")] | |||
| public bool BotRequiresCodeGrant { get; set; } | |||
| [JsonProperty("team")] | |||
| public Team Team { get; set; } | |||
| [JsonProperty("flags"), Int53] | |||
| public Optional<ulong> Flags { get; set; } | |||
| @@ -13,6 +13,8 @@ namespace Discord.API | |||
| public string Icon { get; set; } | |||
| [JsonProperty("splash")] | |||
| public string Splash { get; set; } | |||
| [JsonProperty("discovery_splash")] | |||
| public string DiscoverySplash { get; set; } | |||
| [JsonProperty("owner_id")] | |||
| public ulong OwnerId { get; set; } | |||
| [JsonProperty("region")] | |||
| @@ -22,9 +24,9 @@ namespace Discord.API | |||
| [JsonProperty("afk_timeout")] | |||
| public int AFKTimeout { get; set; } | |||
| [JsonProperty("embed_enabled")] | |||
| public bool EmbedEnabled { get; set; } | |||
| public Optional<bool> EmbedEnabled { get; set; } | |||
| [JsonProperty("embed_channel_id")] | |||
| public ulong? EmbedChannelId { get; set; } | |||
| public Optional<ulong?> EmbedChannelId { get; set; } | |||
| [JsonProperty("verification_level")] | |||
| public VerificationLevel VerificationLevel { get; set; } | |||
| [JsonProperty("default_message_notifications")] | |||
| @@ -43,6 +45,10 @@ namespace Discord.API | |||
| public MfaLevel MfaLevel { get; set; } | |||
| [JsonProperty("application_id")] | |||
| public ulong? ApplicationId { get; set; } | |||
| [JsonProperty("widget_enabled")] | |||
| public Optional<bool> WidgetEnabled { get; set; } | |||
| [JsonProperty("widget_channel_id")] | |||
| public Optional<ulong?> WidgetChannelId { get; set; } | |||
| [JsonProperty("system_channel_id")] | |||
| public ulong? SystemChannelId { get; set; } | |||
| [JsonProperty("premium_tier")] | |||
| @@ -56,9 +62,23 @@ namespace Discord.API | |||
| // this value is inverted, flags set will turn OFF features | |||
| [JsonProperty("system_channel_flags")] | |||
| public SystemChannelMessageDeny SystemChannelFlags { get; set; } | |||
| [JsonProperty("rules_channel_id")] | |||
| public ulong? RulesChannelId { get; set; } | |||
| [JsonProperty("max_presences")] | |||
| public Optional<int?> MaxPresences { get; set; } | |||
| [JsonProperty("max_members")] | |||
| public Optional<int> MaxMembers { get; set; } | |||
| [JsonProperty("premium_subscription_count")] | |||
| public int? PremiumSubscriptionCount { get; set; } | |||
| public Optional<int> PremiumSubscriptionCount { get; set; } | |||
| [JsonProperty("preferred_locale")] | |||
| public string PreferredLocale { get; set; } | |||
| [JsonProperty("public_updates_channel_id")] | |||
| public ulong? PublicUpdatesChannelId { get; set; } | |||
| [JsonProperty("max_video_channel_users")] | |||
| public Optional<int> MaxVideoChannelUsers { get; set; } | |||
| [JsonProperty("approximate_member_count")] | |||
| public Optional<int> ApproximateMemberCount { get; set; } | |||
| [JsonProperty("approximate_presence_count")] | |||
| public Optional<int> ApproximatePresenceCount { get; set; } | |||
| } | |||
| } | |||
| @@ -1,4 +1,4 @@ | |||
| #pragma warning disable CS1591 | |||
| #pragma warning disable CS1591 | |||
| using Newtonsoft.Json; | |||
| namespace Discord.API | |||
| @@ -8,6 +8,6 @@ namespace Discord.API | |||
| [JsonProperty("enabled")] | |||
| public bool Enabled { get; set; } | |||
| [JsonProperty("channel_id")] | |||
| public ulong ChannelId { get; set; } | |||
| public ulong? ChannelId { get; set; } | |||
| } | |||
| } | |||
| @@ -0,0 +1,13 @@ | |||
| #pragma warning disable CS1591 | |||
| using Newtonsoft.Json; | |||
| namespace Discord.API | |||
| { | |||
| internal class GuildWidget | |||
| { | |||
| [JsonProperty("enabled")] | |||
| public bool Enabled { get; set; } | |||
| [JsonProperty("channel_id")] | |||
| public ulong? ChannelId { get; set; } | |||
| } | |||
| } | |||
| @@ -0,0 +1,9 @@ | |||
| namespace Discord.API | |||
| { | |||
| internal enum MembershipState | |||
| { | |||
| None = 0, | |||
| Invited = 1, | |||
| Accepted = 2, | |||
| } | |||
| } | |||
| @@ -0,0 +1,17 @@ | |||
| #pragma warning disable CS1591 | |||
| using Newtonsoft.Json; | |||
| namespace Discord.API | |||
| { | |||
| internal class Team | |||
| { | |||
| [JsonProperty("icon")] | |||
| public Optional<string> Icon { get; set; } | |||
| [JsonProperty("id")] | |||
| public ulong Id { get; set; } | |||
| [JsonProperty("members")] | |||
| public TeamMember[] TeamMembers { get; set; } | |||
| [JsonProperty("owner_user_id")] | |||
| public ulong OwnerUserId { get; set; } | |||
| } | |||
| } | |||
| @@ -0,0 +1,17 @@ | |||
| #pragma warning disable CS1591 | |||
| using Newtonsoft.Json; | |||
| namespace Discord.API | |||
| { | |||
| internal class TeamMember | |||
| { | |||
| [JsonProperty("membership_state")] | |||
| public MembershipState MembershipState { get; set; } | |||
| [JsonProperty("permissions")] | |||
| public string[] Permissions { get; set; } | |||
| [JsonProperty("team_id")] | |||
| public ulong TeamId { get; set; } | |||
| [JsonProperty("user")] | |||
| public User User { get; set; } | |||
| } | |||
| } | |||
| @@ -1,4 +1,4 @@ | |||
| #pragma warning disable CS1591 | |||
| #pragma warning disable CS1591 | |||
| using Newtonsoft.Json; | |||
| namespace Discord.API.Rest | |||
| @@ -19,6 +19,8 @@ namespace Discord.API.Rest | |||
| public Optional<string> Username { get; set; } | |||
| [JsonProperty("avatar_url")] | |||
| public Optional<string> AvatarUrl { get; set; } | |||
| [JsonProperty("allowed_mentions")] | |||
| public Optional<AllowedMentions> AllowedMentions { get; set; } | |||
| public CreateWebhookMessageParams(string content) | |||
| { | |||
| @@ -9,9 +9,13 @@ namespace Discord.API.Rest | |||
| [JsonProperty("days")] | |||
| public int Days { get; } | |||
| public GuildPruneParams(int days) | |||
| [JsonProperty("include_roles")] | |||
| public ulong[] IncludeRoleIds { get; } | |||
| public GuildPruneParams(int days, ulong[] includeRoleIds) | |||
| { | |||
| Days = days; | |||
| IncludeRoleIds = includeRoleIds; | |||
| } | |||
| } | |||
| } | |||
| @@ -0,0 +1,14 @@ | |||
| #pragma warning disable CS1591 | |||
| using Newtonsoft.Json; | |||
| namespace Discord.API.Rest | |||
| { | |||
| [JsonObject(MemberSerialization = MemberSerialization.OptIn)] | |||
| internal class ModifyGuildWidgetParams | |||
| { | |||
| [JsonProperty("enabled")] | |||
| public Optional<bool> Enabled { get; set; } | |||
| [JsonProperty("channel")] | |||
| public Optional<ulong?> ChannelId { get; set; } | |||
| } | |||
| } | |||
| @@ -21,6 +21,7 @@ namespace Discord.API.Rest | |||
| public Optional<string> Username { get; set; } | |||
| public Optional<string> AvatarUrl { get; set; } | |||
| public Optional<Embed[]> Embeds { get; set; } | |||
| public Optional<AllowedMentions> AllowedMentions { get; set; } | |||
| public bool IsSpoiler { get; set; } = false; | |||
| @@ -51,6 +52,8 @@ namespace Discord.API.Rest | |||
| payload["avatar_url"] = AvatarUrl.Value; | |||
| if (Embeds.IsSpecified) | |||
| payload["embeds"] = Embeds.Value; | |||
| if (AllowedMentions.IsSpecified) | |||
| payload["allowed_mentions"] = AllowedMentions.Value; | |||
| var json = new StringBuilder(); | |||
| using (var text = new StringWriter(json)) | |||
| @@ -46,12 +46,12 @@ namespace Discord.Rest | |||
| _restLogger = LogManager.CreateLogger("Rest"); | |||
| _isFirstLogin = config.DisplayInitialLog; | |||
| ApiClient.RequestQueue.RateLimitTriggered += async (id, info) => | |||
| ApiClient.RequestQueue.RateLimitTriggered += async (id, info, endpoint) => | |||
| { | |||
| if (info == null) | |||
| await _restLogger.VerboseAsync($"Preemptive Rate limit triggered: {id?.ToString() ?? "null"}").ConfigureAwait(false); | |||
| await _restLogger.VerboseAsync($"Preemptive Rate limit triggered: {endpoint} {(id.IsHashBucket ? $"(Bucket: {id.BucketHash})" : "")}").ConfigureAwait(false); | |||
| else | |||
| await _restLogger.WarningAsync($"Rate limit triggered: {id?.ToString() ?? "null"}").ConfigureAwait(false); | |||
| await _restLogger.WarningAsync($"Rate limit triggered: {endpoint} {(id.IsHashBucket ? $"(Bucket: {id.BucketHash})" : "")}").ConfigureAwait(false); | |||
| }; | |||
| ApiClient.SentRequest += async (method, endpoint, millis) => await _restLogger.VerboseAsync($"{method} {endpoint}: {millis} ms").ConfigureAwait(false); | |||
| } | |||
| @@ -62,9 +62,9 @@ namespace Discord.Rest | |||
| } | |||
| public static async Task<RestGuild> GetGuildAsync(BaseDiscordClient client, | |||
| ulong id, RequestOptions options) | |||
| ulong id, bool withCounts, RequestOptions options) | |||
| { | |||
| var model = await client.ApiClient.GetGuildAsync(id, options).ConfigureAwait(false); | |||
| var model = await client.ApiClient.GetGuildAsync(id, withCounts, options).ConfigureAwait(false); | |||
| if (model != null) | |||
| return RestGuild.Create(client, model); | |||
| return null; | |||
| @@ -77,6 +77,14 @@ namespace Discord.Rest | |||
| return RestGuildEmbed.Create(model); | |||
| return null; | |||
| } | |||
| public static async Task<RestGuildWidget?> GetGuildWidgetAsync(BaseDiscordClient client, | |||
| ulong id, RequestOptions options) | |||
| { | |||
| var model = await client.ApiClient.GetGuildWidgetAsync(id, options).ConfigureAwait(false); | |||
| if (model != null) | |||
| return RestGuildWidget.Create(model); | |||
| return null; | |||
| } | |||
| public static IAsyncEnumerable<IReadOnlyCollection<RestUserGuild>> GetGuildSummariesAsync(BaseDiscordClient client, | |||
| ulong? fromGuildId, int? limit, RequestOptions options) | |||
| { | |||
| @@ -106,13 +114,13 @@ namespace Discord.Rest | |||
| count: limit | |||
| ); | |||
| } | |||
| public static async Task<IReadOnlyCollection<RestGuild>> GetGuildsAsync(BaseDiscordClient client, RequestOptions options) | |||
| public static async Task<IReadOnlyCollection<RestGuild>> GetGuildsAsync(BaseDiscordClient client, bool withCounts, RequestOptions options) | |||
| { | |||
| var summaryModels = await GetGuildSummariesAsync(client, null, null, options).FlattenAsync().ConfigureAwait(false); | |||
| var guilds = ImmutableArray.CreateBuilder<RestGuild>(); | |||
| foreach (var summaryModel in summaryModels) | |||
| { | |||
| var guildModel = await client.ApiClient.GetGuildAsync(summaryModel.Id).ConfigureAwait(false); | |||
| var guildModel = await client.ApiClient.GetGuildAsync(summaryModel.Id, withCounts).ConfigureAwait(false); | |||
| if (guildModel != null) | |||
| guilds.Add(RestGuild.Create(client, guildModel)); | |||
| } | |||
| @@ -140,7 +148,7 @@ namespace Discord.Rest | |||
| public static async Task<RestGuildUser> GetGuildUserAsync(BaseDiscordClient client, | |||
| ulong guildId, ulong id, RequestOptions options) | |||
| { | |||
| var guild = await GetGuildAsync(client, guildId, options).ConfigureAwait(false); | |||
| var guild = await GetGuildAsync(client, guildId, false, options).ConfigureAwait(false); | |||
| if (guild == null) | |||
| return null; | |||
| @@ -787,7 +787,7 @@ namespace Discord.API | |||
| } | |||
| //Guilds | |||
| public async Task<Guild> GetGuildAsync(ulong guildId, RequestOptions options = null) | |||
| public async Task<Guild> GetGuildAsync(ulong guildId, bool withCounts, RequestOptions options = null) | |||
| { | |||
| Preconditions.NotEqual(guildId, 0, nameof(guildId)); | |||
| options = RequestOptions.CreateOrClone(options); | |||
| @@ -795,7 +795,7 @@ namespace Discord.API | |||
| try | |||
| { | |||
| var ids = new BucketIds(guildId: guildId); | |||
| return await SendAsync<Guild>("GET", () => $"guilds/{guildId}", ids, options: options).ConfigureAwait(false); | |||
| return await SendAsync<Guild>("GET", () => $"guilds/{guildId}?with_counts={(withCounts ? "true" : "false")}", ids, options: options).ConfigureAwait(false); | |||
| } | |||
| catch (HttpException ex) when (ex.HttpCode == HttpStatusCode.NotFound) { return null; } | |||
| } | |||
| @@ -853,10 +853,11 @@ namespace Discord.API | |||
| Preconditions.NotEqual(guildId, 0, nameof(guildId)); | |||
| Preconditions.NotNull(args, nameof(args)); | |||
| Preconditions.AtLeast(args.Days, 1, nameof(args.Days)); | |||
| string endpointRoleIds = args.IncludeRoleIds?.Length > 0 ? $"&include_roles={string.Join(",", args.IncludeRoleIds)}" : ""; | |||
| options = RequestOptions.CreateOrClone(options); | |||
| var ids = new BucketIds(guildId: guildId); | |||
| return await SendAsync<GetGuildPruneCountResponse>("GET", () => $"guilds/{guildId}/prune?days={args.Days}", ids, options: options).ConfigureAwait(false); | |||
| return await SendAsync<GetGuildPruneCountResponse>("GET", () => $"guilds/{guildId}/prune?days={args.Days}{endpointRoleIds}", ids, options: options).ConfigureAwait(false); | |||
| } | |||
| //Guild Bans | |||
| @@ -874,8 +875,12 @@ namespace Discord.API | |||
| Preconditions.NotEqual(guildId, 0, nameof(guildId)); | |||
| options = RequestOptions.CreateOrClone(options); | |||
| var ids = new BucketIds(guildId: guildId); | |||
| return await SendAsync<Ban>("GET", () => $"guilds/{guildId}/bans/{userId}", ids, options: options).ConfigureAwait(false); | |||
| try | |||
| { | |||
| var ids = new BucketIds(guildId: guildId); | |||
| return await SendAsync<Ban>("GET", () => $"guilds/{guildId}/bans/{userId}", ids, options: options).ConfigureAwait(false); | |||
| } | |||
| catch (HttpException ex) when (ex.HttpCode == HttpStatusCode.NotFound) { return null; } | |||
| } | |||
| /// <exception cref="ArgumentException"> | |||
| /// <paramref name="guildId"/> and <paramref name="userId"/> must not be equal to zero. | |||
| @@ -933,6 +938,32 @@ namespace Discord.API | |||
| return await SendJsonAsync<GuildEmbed>("PATCH", () => $"guilds/{guildId}/embed", args, ids, options: options).ConfigureAwait(false); | |||
| } | |||
| //Guild Widget | |||
| /// <exception cref="ArgumentException"><paramref name="guildId"/> must not be equal to zero.</exception> | |||
| public async Task<GuildWidget> GetGuildWidgetAsync(ulong guildId, RequestOptions options = null) | |||
| { | |||
| Preconditions.NotEqual(guildId, 0, nameof(guildId)); | |||
| options = RequestOptions.CreateOrClone(options); | |||
| try | |||
| { | |||
| var ids = new BucketIds(guildId: guildId); | |||
| return await SendAsync<GuildWidget>("GET", () => $"guilds/{guildId}/widget", ids, options: options).ConfigureAwait(false); | |||
| } | |||
| catch (HttpException ex) when (ex.HttpCode == HttpStatusCode.NotFound) { return null; } | |||
| } | |||
| /// <exception cref="ArgumentException"><paramref name="guildId"/> must not be equal to zero.</exception> | |||
| /// <exception cref="ArgumentNullException"><paramref name="args"/> must not be <see langword="null"/>.</exception> | |||
| public async Task<GuildWidget> ModifyGuildWidgetAsync(ulong guildId, Rest.ModifyGuildWidgetParams args, RequestOptions options = null) | |||
| { | |||
| Preconditions.NotNull(args, nameof(args)); | |||
| Preconditions.NotEqual(guildId, 0, nameof(guildId)); | |||
| options = RequestOptions.CreateOrClone(options); | |||
| var ids = new BucketIds(guildId: guildId); | |||
| return await SendJsonAsync<GuildWidget>("PATCH", () => $"guilds/{guildId}/widget", args, ids, options: options).ConfigureAwait(false); | |||
| } | |||
| //Guild Integrations | |||
| /// <exception cref="ArgumentException"><paramref name="guildId"/> must not be equal to zero.</exception> | |||
| public async Task<IReadOnlyCollection<Integration>> GetGuildIntegrationsAsync(ulong guildId, RequestOptions options = null) | |||
| @@ -1,3 +1,4 @@ | |||
| using System; | |||
| using System.Collections.Generic; | |||
| using System.Collections.Immutable; | |||
| using System.IO; | |||
| @@ -77,15 +78,22 @@ namespace Discord.Rest | |||
| => ClientHelper.GetInviteAsync(this, inviteId, options); | |||
| public Task<RestGuild> GetGuildAsync(ulong id, RequestOptions options = null) | |||
| => ClientHelper.GetGuildAsync(this, id, options); | |||
| => ClientHelper.GetGuildAsync(this, id, false, options); | |||
| public Task<RestGuild> GetGuildAsync(ulong id, bool withCounts, RequestOptions options = null) | |||
| => ClientHelper.GetGuildAsync(this, id, withCounts, options); | |||
| [Obsolete("This endpoint is deprecated, use GetGuildWidgetAsync instead.")] | |||
| public Task<RestGuildEmbed?> GetGuildEmbedAsync(ulong id, RequestOptions options = null) | |||
| => ClientHelper.GetGuildEmbedAsync(this, id, options); | |||
| public Task<RestGuildWidget?> GetGuildWidgetAsync(ulong id, RequestOptions options = null) | |||
| => ClientHelper.GetGuildWidgetAsync(this, id, options); | |||
| public IAsyncEnumerable<IReadOnlyCollection<RestUserGuild>> GetGuildSummariesAsync(RequestOptions options = null) | |||
| => ClientHelper.GetGuildSummariesAsync(this, null, null, options); | |||
| public IAsyncEnumerable<IReadOnlyCollection<RestUserGuild>> GetGuildSummariesAsync(ulong fromGuildId, int limit, RequestOptions options = null) | |||
| => ClientHelper.GetGuildSummariesAsync(this, fromGuildId, limit, options); | |||
| public Task<IReadOnlyCollection<RestGuild>> GetGuildsAsync(RequestOptions options = null) | |||
| => ClientHelper.GetGuildsAsync(this, options); | |||
| => ClientHelper.GetGuildsAsync(this, false, options); | |||
| public Task<IReadOnlyCollection<RestGuild>> GetGuildsAsync(bool withCounts, RequestOptions options = null) | |||
| => ClientHelper.GetGuildsAsync(this, withCounts, options); | |||
| public Task<RestGuild> CreateGuildAsync(string name, IVoiceRegion region, Stream jpegIcon = null, RequestOptions options = null) | |||
| => ClientHelper.CreateGuildAsync(this, name, region, jpegIcon, options); | |||
| @@ -28,7 +28,16 @@ namespace Discord.Rest | |||
| { | |||
| Name = args.Name, | |||
| Position = args.Position, | |||
| CategoryId = args.CategoryId | |||
| CategoryId = args.CategoryId, | |||
| Overwrites = args.PermissionOverwrites.IsSpecified | |||
| ? args.PermissionOverwrites.Value.Select(overwrite => new API.Overwrite | |||
| { | |||
| TargetId = overwrite.TargetId, | |||
| TargetType = overwrite.TargetType, | |||
| Allow = overwrite.Permissions.AllowValue, | |||
| Deny = overwrite.Permissions.DenyValue | |||
| }).ToArray() | |||
| : Optional.Create<API.Overwrite[]>(), | |||
| }; | |||
| return await client.ApiClient.ModifyGuildChannelAsync(channel.Id, apiArgs, options).ConfigureAwait(false); | |||
| } | |||
| @@ -70,7 +79,16 @@ namespace Discord.Rest | |||
| Name = args.Name, | |||
| Position = args.Position, | |||
| CategoryId = args.CategoryId, | |||
| UserLimit = args.UserLimit.IsSpecified ? (args.UserLimit.Value ?? 0) : Optional.Create<int>() | |||
| UserLimit = args.UserLimit.IsSpecified ? (args.UserLimit.Value ?? 0) : Optional.Create<int>(), | |||
| Overwrites = args.PermissionOverwrites.IsSpecified | |||
| ? args.PermissionOverwrites.Value.Select(overwrite => new API.Overwrite | |||
| { | |||
| TargetId = overwrite.TargetId, | |||
| TargetType = overwrite.TargetType, | |||
| Allow = overwrite.Permissions.AllowValue, | |||
| Deny = overwrite.Permissions.DenyValue | |||
| }).ToArray() | |||
| : Optional.Create<API.Overwrite[]>(), | |||
| }; | |||
| return await client.ApiClient.ModifyGuildChannelAsync(channel.Id, apiArgs, options).ConfigureAwait(false); | |||
| } | |||
| @@ -12,7 +12,7 @@ namespace Discord.Rest | |||
| /// Represents a REST-based news channel in a guild that has the same properties as a <see cref="RestTextChannel"/>. | |||
| /// </summary> | |||
| [DebuggerDisplay(@"{DebuggerDisplay,nq}")] | |||
| public class RestNewsChannel : RestTextChannel | |||
| public class RestNewsChannel : RestTextChannel, INewsChannel | |||
| { | |||
| internal RestNewsChannel(BaseDiscordClient discord, IGuild guild, ulong id) | |||
| :base(discord, guild, id) | |||
| @@ -5,6 +5,7 @@ using System.Collections.Immutable; | |||
| using System.Linq; | |||
| using System.Threading.Tasks; | |||
| using EmbedModel = Discord.API.GuildEmbed; | |||
| using WidgetModel = Discord.API.GuildWidget; | |||
| using Model = Discord.API.Guild; | |||
| using RoleModel = Discord.API.Role; | |||
| using ImageModel = Discord.API.Image; | |||
| @@ -99,6 +100,27 @@ namespace Discord.Rest | |||
| return await client.ApiClient.ModifyGuildEmbedAsync(guild.Id, apiArgs, options).ConfigureAwait(false); | |||
| } | |||
| /// <exception cref="ArgumentNullException"><paramref name="func"/> is <c>null</c>.</exception> | |||
| public static async Task<WidgetModel> ModifyWidgetAsync(IGuild guild, BaseDiscordClient client, | |||
| Action<GuildWidgetProperties> func, RequestOptions options) | |||
| { | |||
| if (func == null) | |||
| throw new ArgumentNullException(nameof(func)); | |||
| var args = new GuildWidgetProperties(); | |||
| func(args); | |||
| var apiArgs = new API.Rest.ModifyGuildWidgetParams | |||
| { | |||
| Enabled = args.Enabled | |||
| }; | |||
| if (args.Channel.IsSpecified) | |||
| apiArgs.ChannelId = args.Channel.Value?.Id; | |||
| else if (args.ChannelId.IsSpecified) | |||
| apiArgs.ChannelId = args.ChannelId.Value; | |||
| return await client.ApiClient.ModifyGuildWidgetAsync(guild.Id, apiArgs, options).ConfigureAwait(false); | |||
| } | |||
| public static async Task ReorderChannelsAsync(IGuild guild, BaseDiscordClient client, | |||
| IEnumerable<ReorderChannelProperties> args, RequestOptions options) | |||
| { | |||
| @@ -132,7 +154,7 @@ namespace Discord.Rest | |||
| public static async Task<RestBan> GetBanAsync(IGuild guild, BaseDiscordClient client, ulong userId, RequestOptions options) | |||
| { | |||
| var model = await client.ApiClient.GetGuildBanAsync(guild.Id, userId, options).ConfigureAwait(false); | |||
| return RestBan.Create(client, model); | |||
| return model == null ? null : RestBan.Create(client, model); | |||
| } | |||
| public static async Task AddBanAsync(IGuild guild, BaseDiscordClient client, | |||
| @@ -404,9 +426,9 @@ namespace Discord.Rest | |||
| ); | |||
| } | |||
| public static async Task<int> PruneUsersAsync(IGuild guild, BaseDiscordClient client, | |||
| int days, bool simulate, RequestOptions options) | |||
| int days, bool simulate, RequestOptions options, IEnumerable<ulong> includeRoleIds) | |||
| { | |||
| var args = new GuildPruneParams(days); | |||
| var args = new GuildPruneParams(days, includeRoleIds?.ToArray()); | |||
| GetGuildPruneCountResponse model; | |||
| if (simulate) | |||
| model = await client.ApiClient.GetGuildPruneCountAsync(guild.Id, args, options).ConfigureAwait(false); | |||
| @@ -479,7 +501,7 @@ namespace Discord.Rest | |||
| var emote = await client.ApiClient.GetGuildEmoteAsync(guild.Id, id, options).ConfigureAwait(false); | |||
| return emote.ToEntity(); | |||
| } | |||
| public static async Task<GuildEmote> CreateEmoteAsync(IGuild guild, BaseDiscordClient client, string name, Image image, Optional<IEnumerable<IRole>> roles, | |||
| public static async Task<GuildEmote> CreateEmoteAsync(IGuild guild, BaseDiscordClient client, string name, Image image, Optional<IEnumerable<IRole>> roles, | |||
| RequestOptions options) | |||
| { | |||
| var apiargs = new CreateGuildEmoteParams | |||
| @@ -494,7 +516,7 @@ namespace Discord.Rest | |||
| return emote.ToEntity(); | |||
| } | |||
| /// <exception cref="ArgumentNullException"><paramref name="func"/> is <c>null</c>.</exception> | |||
| public static async Task<GuildEmote> ModifyEmoteAsync(IGuild guild, BaseDiscordClient client, ulong id, Action<EmoteProperties> func, | |||
| public static async Task<GuildEmote> ModifyEmoteAsync(IGuild guild, BaseDiscordClient client, ulong id, Action<EmoteProperties> func, | |||
| RequestOptions options) | |||
| { | |||
| if (func == null) throw new ArgumentNullException(paramName: nameof(func)); | |||
| @@ -512,7 +534,7 @@ namespace Discord.Rest | |||
| var emote = await client.ApiClient.ModifyGuildEmoteAsync(guild.Id, id, apiargs, options).ConfigureAwait(false); | |||
| return emote.ToEntity(); | |||
| } | |||
| public static Task DeleteEmoteAsync(IGuild guild, BaseDiscordClient client, ulong id, RequestOptions options) | |||
| public static Task DeleteEmoteAsync(IGuild guild, BaseDiscordClient client, ulong id, RequestOptions options) | |||
| => client.ApiClient.DeleteGuildEmoteAsync(guild.Id, id, options); | |||
| } | |||
| } | |||
| @@ -7,6 +7,7 @@ using System.Globalization; | |||
| using System.Linq; | |||
| using System.Threading.Tasks; | |||
| using EmbedModel = Discord.API.GuildEmbed; | |||
| using WidgetModel = Discord.API.GuildWidget; | |||
| using Model = Discord.API.Guild; | |||
| namespace Discord.Rest | |||
| @@ -28,6 +29,8 @@ namespace Discord.Rest | |||
| /// <inheritdoc /> | |||
| public bool IsEmbeddable { get; private set; } | |||
| /// <inheritdoc /> | |||
| public bool IsWidgetEnabled { get; private set; } | |||
| /// <inheritdoc /> | |||
| public VerificationLevel VerificationLevel { get; private set; } | |||
| /// <inheritdoc /> | |||
| public MfaLevel MfaLevel { get; private set; } | |||
| @@ -41,8 +44,14 @@ namespace Discord.Rest | |||
| /// <inheritdoc /> | |||
| public ulong? EmbedChannelId { get; private set; } | |||
| /// <inheritdoc /> | |||
| public ulong? WidgetChannelId { get; private set; } | |||
| /// <inheritdoc /> | |||
| public ulong? SystemChannelId { get; private set; } | |||
| /// <inheritdoc /> | |||
| public ulong? RulesChannelId { get; private set; } | |||
| /// <inheritdoc /> | |||
| public ulong? PublicUpdatesChannelId { get; private set; } | |||
| /// <inheritdoc /> | |||
| public ulong OwnerId { get; private set; } | |||
| /// <inheritdoc /> | |||
| public string VoiceRegionId { get; private set; } | |||
| @@ -50,6 +59,8 @@ namespace Discord.Rest | |||
| public string IconId { get; private set; } | |||
| /// <inheritdoc /> | |||
| public string SplashId { get; private set; } | |||
| /// <inheritdoc /> | |||
| public string DiscoverySplashId { get; private set; } | |||
| internal bool Available { get; private set; } | |||
| /// <inheritdoc /> | |||
| public ulong? ApplicationId { get; private set; } | |||
| @@ -67,6 +78,16 @@ namespace Discord.Rest | |||
| public int PremiumSubscriptionCount { get; private set; } | |||
| /// <inheritdoc /> | |||
| public string PreferredLocale { get; private set; } | |||
| /// <inheritdoc /> | |||
| public int? MaxPresences { get; private set; } | |||
| /// <inheritdoc /> | |||
| public int? MaxMembers { get; private set; } | |||
| /// <inheritdoc /> | |||
| public int? MaxVideoChannelUsers { get; private set; } | |||
| /// <inheritdoc /> | |||
| public int? ApproximateMemberCount { get; private set; } | |||
| /// <inheritdoc /> | |||
| public int? ApproximatePresenceCount { get; private set; } | |||
| /// <inheritdoc /> | |||
| public CultureInfo PreferredCulture { get; private set; } | |||
| @@ -81,6 +102,8 @@ namespace Discord.Rest | |||
| /// <inheritdoc /> | |||
| public string SplashUrl => CDN.GetGuildSplashUrl(Id, SplashId); | |||
| /// <inheritdoc /> | |||
| public string DiscoverySplashUrl => CDN.GetGuildDiscoverySplashUrl(Id, DiscoverySplashId); | |||
| /// <inheritdoc /> | |||
| public string BannerUrl => CDN.GetGuildBannerUrl(Id, BannerId); | |||
| /// <summary> | |||
| @@ -110,15 +133,24 @@ namespace Discord.Rest | |||
| internal void Update(Model model) | |||
| { | |||
| AFKChannelId = model.AFKChannelId; | |||
| EmbedChannelId = model.EmbedChannelId; | |||
| if (model.EmbedChannelId.IsSpecified) | |||
| EmbedChannelId = model.EmbedChannelId.Value; | |||
| if (model.WidgetChannelId.IsSpecified) | |||
| WidgetChannelId = model.WidgetChannelId.Value; | |||
| SystemChannelId = model.SystemChannelId; | |||
| RulesChannelId = model.RulesChannelId; | |||
| PublicUpdatesChannelId = model.PublicUpdatesChannelId; | |||
| AFKTimeout = model.AFKTimeout; | |||
| IsEmbeddable = model.EmbedEnabled; | |||
| if (model.EmbedEnabled.IsSpecified) | |||
| IsEmbeddable = model.EmbedEnabled.Value; | |||
| if (model.WidgetEnabled.IsSpecified) | |||
| IsWidgetEnabled = model.WidgetEnabled.Value; | |||
| IconId = model.Icon; | |||
| Name = model.Name; | |||
| OwnerId = model.OwnerId; | |||
| VoiceRegionId = model.Region; | |||
| SplashId = model.Splash; | |||
| DiscoverySplashId = model.DiscoverySplash; | |||
| VerificationLevel = model.VerificationLevel; | |||
| MfaLevel = model.MfaLevel; | |||
| DefaultMessageNotifications = model.DefaultMessageNotifications; | |||
| @@ -129,9 +161,20 @@ namespace Discord.Rest | |||
| BannerId = model.Banner; | |||
| SystemChannelFlags = model.SystemChannelFlags; | |||
| Description = model.Description; | |||
| PremiumSubscriptionCount = model.PremiumSubscriptionCount.GetValueOrDefault(); | |||
| if (model.PremiumSubscriptionCount.IsSpecified) | |||
| PremiumSubscriptionCount = model.PremiumSubscriptionCount.Value; | |||
| if (model.MaxPresences.IsSpecified) | |||
| MaxPresences = model.MaxPresences.Value ?? 25000; | |||
| if (model.MaxMembers.IsSpecified) | |||
| MaxMembers = model.MaxMembers.Value; | |||
| if (model.MaxVideoChannelUsers.IsSpecified) | |||
| MaxVideoChannelUsers = model.MaxVideoChannelUsers.Value; | |||
| PreferredLocale = model.PreferredLocale; | |||
| PreferredCulture = new CultureInfo(PreferredLocale); | |||
| if (model.ApproximateMemberCount.IsSpecified) | |||
| ApproximateMemberCount = model.ApproximateMemberCount.Value; | |||
| if (model.ApproximatePresenceCount.IsSpecified) | |||
| ApproximatePresenceCount = model.ApproximatePresenceCount.Value; | |||
| if (model.Emojis != null) | |||
| { | |||
| @@ -163,17 +206,36 @@ namespace Discord.Rest | |||
| EmbedChannelId = model.ChannelId; | |||
| IsEmbeddable = model.Enabled; | |||
| } | |||
| internal void Update(WidgetModel model) | |||
| { | |||
| WidgetChannelId = model.ChannelId; | |||
| IsWidgetEnabled = model.Enabled; | |||
| } | |||
| //General | |||
| /// <inheritdoc /> | |||
| public async Task UpdateAsync(RequestOptions options = null) | |||
| => Update(await Discord.ApiClient.GetGuildAsync(Id, options).ConfigureAwait(false)); | |||
| => Update(await Discord.ApiClient.GetGuildAsync(Id, false, options).ConfigureAwait(false)); | |||
| /// <summary> | |||
| /// Updates this object's properties with its current state. | |||
| /// </summary> | |||
| /// <param name="withCounts"> | |||
| /// If true, <see cref="ApproximateMemberCount"/> and <see cref="ApproximatePresenceCount"/> | |||
| /// will be updated as well. | |||
| /// </param> | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <remarks> | |||
| /// If <paramref name="withCounts"/> is true, <see cref="ApproximateMemberCount"/> and | |||
| /// <see cref="ApproximatePresenceCount"/> will be updated as well. | |||
| /// </remarks> | |||
| public async Task UpdateAsync(bool withCounts, RequestOptions options = null) | |||
| => Update(await Discord.ApiClient.GetGuildAsync(Id, withCounts, options).ConfigureAwait(false)); | |||
| /// <inheritdoc /> | |||
| public Task DeleteAsync(RequestOptions options = null) | |||
| => GuildHelper.DeleteAsync(this, Discord, options); | |||
| /// <inheritdoc /> | |||
| /// <exception cref="ArgumentNullException"><paramref name="func"/> is <c>null</c>.</exception> | |||
| /// <exception cref="ArgumentNullException"><paramref name="func"/> is <see langword="null"/>.</exception> | |||
| public async Task ModifyAsync(Action<GuildProperties> func, RequestOptions options = null) | |||
| { | |||
| var model = await GuildHelper.ModifyAsync(this, Discord, func, options).ConfigureAwait(false); | |||
| @@ -181,7 +243,8 @@ namespace Discord.Rest | |||
| } | |||
| /// <inheritdoc /> | |||
| /// <exception cref="ArgumentNullException"><paramref name="func"/> is <c>null</c>.</exception> | |||
| /// <exception cref="ArgumentNullException"><paramref name="func"/> is <see langword="null"/>.</exception> | |||
| [Obsolete("This endpoint is deprecated, use ModifyWidgetAsync instead.")] | |||
| public async Task ModifyEmbedAsync(Action<GuildEmbedProperties> func, RequestOptions options = null) | |||
| { | |||
| var model = await GuildHelper.ModifyEmbedAsync(this, Discord, func, options).ConfigureAwait(false); | |||
| @@ -189,7 +252,15 @@ namespace Discord.Rest | |||
| } | |||
| /// <inheritdoc /> | |||
| /// <exception cref="ArgumentNullException"><paramref name="args" /> is <c>null</c>.</exception> | |||
| /// <exception cref="ArgumentNullException"><paramref name="func"/> is <see langword="null"/>.</exception> | |||
| public async Task ModifyWidgetAsync(Action<GuildWidgetProperties> func, RequestOptions options = null) | |||
| { | |||
| var model = await GuildHelper.ModifyWidgetAsync(this, Discord, func, options).ConfigureAwait(false); | |||
| Update(model); | |||
| } | |||
| /// <inheritdoc /> | |||
| /// <exception cref="ArgumentNullException"><paramref name="args" /> is <see langword="null"/>.</exception> | |||
| public async Task ReorderChannelsAsync(IEnumerable<ReorderChannelProperties> args, RequestOptions options = null) | |||
| { | |||
| var arr = args.ToArray(); | |||
| @@ -205,7 +276,7 @@ namespace Discord.Rest | |||
| role?.Update(model); | |||
| } | |||
| } | |||
| /// <inheritdoc /> | |||
| public Task LeaveAsync(RequestOptions options = null) | |||
| => GuildHelper.LeaveAsync(this, Discord, options); | |||
| @@ -230,7 +301,7 @@ namespace Discord.Rest | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <returns> | |||
| /// 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; <c>null</c> if the ban entry cannot be found. | |||
| /// contains the user information and the reason for the ban; <see langword="null"/> if the ban entry cannot be found. | |||
| /// </returns> | |||
| public Task<RestBan> GetBanAsync(IUser user, RequestOptions options = null) | |||
| => GuildHelper.GetBanAsync(this, Discord, user.Id, options); | |||
| @@ -241,7 +312,7 @@ namespace Discord.Rest | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <returns> | |||
| /// 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; <c>null</c> if the ban entry cannot be found. | |||
| /// contains the user information and the reason for the ban; <see langword="null"/> if the ban entry cannot be found. | |||
| /// </returns> | |||
| public Task<RestBan> GetBanAsync(ulong userId, RequestOptions options = null) | |||
| => GuildHelper.GetBanAsync(this, Discord, userId, options); | |||
| @@ -279,7 +350,7 @@ namespace Discord.Rest | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <returns> | |||
| /// A task that represents the asynchronous get operation. The task result contains the generic channel | |||
| /// associated with the specified <paramref name="id"/>; <c>null</c> if none is found. | |||
| /// associated with the specified <paramref name="id"/>; <see langword="null"/> if none is found. | |||
| /// </returns> | |||
| public Task<RestGuildChannel> GetChannelAsync(ulong id, RequestOptions options = null) | |||
| => GuildHelper.GetChannelAsync(this, Discord, id, options); | |||
| @@ -291,7 +362,7 @@ namespace Discord.Rest | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <returns> | |||
| /// A task that represents the asynchronous get operation. The task result contains the text channel | |||
| /// associated with the specified <paramref name="id"/>; <c>null</c> if none is found. | |||
| /// associated with the specified <paramref name="id"/>; <see langword="null"/> if none is found. | |||
| /// </returns> | |||
| public async Task<RestTextChannel> GetTextChannelAsync(ulong id, RequestOptions options = null) | |||
| { | |||
| @@ -320,7 +391,7 @@ namespace Discord.Rest | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <returns> | |||
| /// A task that represents the asynchronous get operation. The task result contains the voice channel associated | |||
| /// with the specified <paramref name="id"/>; <c>null</c> if none is found. | |||
| /// with the specified <paramref name="id"/>; <see langword="null"/> if none is found. | |||
| /// </returns> | |||
| public async Task<RestVoiceChannel> GetVoiceChannelAsync(ulong id, RequestOptions options = null) | |||
| { | |||
| @@ -362,7 +433,7 @@ namespace Discord.Rest | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <returns> | |||
| /// 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; <c>null</c> if none is set. | |||
| /// AFK users will be moved to after they have idled for too long; <see langword="null"/> if none is set. | |||
| /// </returns> | |||
| public async Task<RestVoiceChannel> GetAFKChannelAsync(RequestOptions options = null) | |||
| { | |||
| @@ -381,7 +452,7 @@ namespace Discord.Rest | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <returns> | |||
| /// A task that represents the asynchronous get operation. The task result contains the first viewable text | |||
| /// channel in this guild; <c>null</c> if none is found. | |||
| /// channel in this guild; <see langword="null"/> if none is found. | |||
| /// </returns> | |||
| public async Task<RestTextChannel> GetDefaultChannelAsync(RequestOptions options = null) | |||
| { | |||
| @@ -399,8 +470,9 @@ namespace Discord.Rest | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <returns> | |||
| /// A task that represents the asynchronous get operation. The task result contains the embed channel set | |||
| /// within the server's widget settings; <c>null</c> if none is set. | |||
| /// within the server's widget settings; <see langword="null"/> if none is set. | |||
| /// </returns> | |||
| [Obsolete("This endpoint is deprecated, use GetWidgetChannelAsync instead.")] | |||
| public async Task<RestGuildChannel> GetEmbedChannelAsync(RequestOptions options = null) | |||
| { | |||
| var embedId = EmbedChannelId; | |||
| @@ -410,12 +482,28 @@ namespace Discord.Rest | |||
| } | |||
| /// <summary> | |||
| /// Gets the first viewable text channel in this guild. | |||
| /// Gets the widget channel (i.e. the channel set in the guild's widget settings) in this guild. | |||
| /// </summary> | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <returns> | |||
| /// A task that represents the asynchronous get operation. The task result contains the first viewable text | |||
| /// channel in this guild; <c>null</c> if none is found. | |||
| /// A task that represents the asynchronous get operation. The task result contains the widget channel set | |||
| /// within the server's widget settings; <see langword="null"/> if none is set. | |||
| /// </returns> | |||
| public async Task<RestGuildChannel> GetWidgetChannelAsync(RequestOptions options = null) | |||
| { | |||
| var widgetChannelId = WidgetChannelId; | |||
| if (widgetChannelId.HasValue) | |||
| return await GuildHelper.GetChannelAsync(this, Discord, widgetChannelId.Value, options).ConfigureAwait(false); | |||
| return null; | |||
| } | |||
| /// <summary> | |||
| /// Gets the text channel where guild notices such as welcome messages and boost events are posted. | |||
| /// </summary> | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <returns> | |||
| /// 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; <see langword="null"/> if none is found. | |||
| /// </returns> | |||
| public async Task<RestTextChannel> GetSystemChannelAsync(RequestOptions options = null) | |||
| { | |||
| @@ -427,6 +515,45 @@ namespace Discord.Rest | |||
| } | |||
| return null; | |||
| } | |||
| /// <summary> | |||
| /// Gets the text channel where Community guilds can display rules and/or guidelines. | |||
| /// </summary> | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <returns> | |||
| /// A task that represents the asynchronous get operation. The task result contains the text channel | |||
| /// where Community guilds can display rules and/or guidelines; <see langword="null"/> if none is set. | |||
| /// </returns> | |||
| public async Task<RestTextChannel> GetRulesChannelAsync(RequestOptions options = null) | |||
| { | |||
| var rulesChannelId = RulesChannelId; | |||
| if (rulesChannelId.HasValue) | |||
| { | |||
| var channel = await GuildHelper.GetChannelAsync(this, Discord, rulesChannelId.Value, options).ConfigureAwait(false); | |||
| return channel as RestTextChannel; | |||
| } | |||
| return null; | |||
| } | |||
| /// <summary> | |||
| /// Gets the text channel channel where admins and moderators of Community guilds receive notices from Discord. | |||
| /// </summary> | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <returns> | |||
| /// 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; <see langword="null"/> if none is set. | |||
| /// </returns> | |||
| public async Task<RestTextChannel> GetPublicUpdatesChannelAsync(RequestOptions options = null) | |||
| { | |||
| var publicUpdatesChannelId = PublicUpdatesChannelId; | |||
| if (publicUpdatesChannelId.HasValue) | |||
| { | |||
| var channel = await GuildHelper.GetChannelAsync(this, Discord, publicUpdatesChannelId.Value, options).ConfigureAwait(false); | |||
| return channel as RestTextChannel; | |||
| } | |||
| return null; | |||
| } | |||
| /// <summary> | |||
| /// Creates a new text channel in this guild. | |||
| /// </summary> | |||
| @@ -458,7 +585,7 @@ namespace Discord.Rest | |||
| /// <param name="name">The name of the new channel.</param> | |||
| /// <param name="func">The delegate containing the properties to be applied to the channel upon its creation.</param> | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <exception cref="ArgumentNullException"><paramref name="name" /> is <c>null</c>.</exception> | |||
| /// <exception cref="ArgumentNullException"><paramref name="name" /> is <see langword="null"/>.</exception> | |||
| /// <returns> | |||
| /// The created voice channel. | |||
| /// </returns> | |||
| @@ -470,7 +597,7 @@ namespace Discord.Rest | |||
| /// <param name="name">The name of the new channel.</param> | |||
| /// <param name="func">The delegate containing the properties to be applied to the channel upon its creation.</param> | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <exception cref="ArgumentNullException"><paramref name="name" /> is <c>null</c>.</exception> | |||
| /// <exception cref="ArgumentNullException"><paramref name="name" /> is <see langword="null"/>.</exception> | |||
| /// <returns> | |||
| /// The created category channel. | |||
| /// </returns> | |||
| @@ -521,7 +648,7 @@ namespace Discord.Rest | |||
| /// </summary> | |||
| /// <param name="id">The snowflake identifier for the role.</param> | |||
| /// <returns> | |||
| /// A role that is associated with the specified <paramref name="id"/>; <c>null</c> if none is found. | |||
| /// A role that is associated with the specified <paramref name="id"/>; <see langword="null"/> if none is found. | |||
| /// </returns> | |||
| public RestRole GetRole(ulong id) | |||
| { | |||
| @@ -585,7 +712,7 @@ namespace Discord.Rest | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <returns> | |||
| /// A task that represents the asynchronous get operation. The task result contains the guild user | |||
| /// associated with the specified <paramref name="id"/>; <c>null</c> if none is found. | |||
| /// associated with the specified <paramref name="id"/>; <see langword="null"/> if none is found. | |||
| /// </returns> | |||
| public Task<RestGuildUser> GetUserAsync(ulong id, RequestOptions options = null) | |||
| => GuildHelper.GetUserAsync(this, Discord, id, options); | |||
| @@ -631,8 +758,8 @@ namespace Discord.Rest | |||
| /// 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. | |||
| /// </returns> | |||
| public Task<int> PruneUsersAsync(int days = 30, bool simulate = false, RequestOptions options = null) | |||
| => GuildHelper.PruneUsersAsync(this, Discord, days, simulate, options); | |||
| public Task<int> PruneUsersAsync(int days = 30, bool simulate = false, RequestOptions options = null, IEnumerable<ulong> includeRoleIds = null) | |||
| => GuildHelper.PruneUsersAsync(this, Discord, days, simulate, options, includeRoleIds); | |||
| /// <summary> | |||
| /// Gets a collection of users in this guild that the name or nickname starts with the | |||
| @@ -675,7 +802,7 @@ namespace Discord.Rest | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <returns> | |||
| /// A task that represents the asynchronous get operation. The task result contains the webhook with the | |||
| /// specified <paramref name="id"/>; <c>null</c> if none is found. | |||
| /// specified <paramref name="id"/>; <see langword="null"/> if none is found. | |||
| /// </returns> | |||
| public Task<RestWebhook> GetWebhookAsync(ulong id, RequestOptions options = null) | |||
| => GuildHelper.GetWebhookAsync(this, Discord, id, options); | |||
| @@ -708,7 +835,7 @@ namespace Discord.Rest | |||
| public Task<GuildEmote> CreateEmoteAsync(string name, Image image, Optional<IEnumerable<IRole>> roles = default(Optional<IEnumerable<IRole>>), RequestOptions options = null) | |||
| => GuildHelper.CreateEmoteAsync(this, Discord, name, image, roles, options); | |||
| /// <inheritdoc /> | |||
| /// <exception cref="ArgumentNullException"><paramref name="func"/> is <c>null</c>.</exception> | |||
| /// <exception cref="ArgumentNullException"><paramref name="func"/> is <see langword="null"/>.</exception> | |||
| public Task<GuildEmote> ModifyEmoteAsync(GuildEmote emote, Action<EmoteProperties> func, RequestOptions options = null) | |||
| => GuildHelper.ModifyEmoteAsync(this, Discord, emote.Id, func, options); | |||
| /// <inheritdoc /> | |||
| @@ -808,6 +935,7 @@ namespace Discord.Rest | |||
| return null; | |||
| } | |||
| /// <inheritdoc /> | |||
| [Obsolete("This endpoint is deprecated, use GetWidgetChannelAsync instead.")] | |||
| async Task<IGuildChannel> IGuild.GetEmbedChannelAsync(CacheMode mode, RequestOptions options) | |||
| { | |||
| if (mode == CacheMode.AllowDownload) | |||
| @@ -816,6 +944,14 @@ namespace Discord.Rest | |||
| return null; | |||
| } | |||
| /// <inheritdoc /> | |||
| async Task<IGuildChannel> IGuild.GetWidgetChannelAsync(CacheMode mode, RequestOptions options) | |||
| { | |||
| if (mode == CacheMode.AllowDownload) | |||
| return await GetWidgetChannelAsync(options).ConfigureAwait(false); | |||
| else | |||
| return null; | |||
| } | |||
| /// <inheritdoc /> | |||
| async Task<ITextChannel> IGuild.GetSystemChannelAsync(CacheMode mode, RequestOptions options) | |||
| { | |||
| if (mode == CacheMode.AllowDownload) | |||
| @@ -824,6 +960,22 @@ namespace Discord.Rest | |||
| return null; | |||
| } | |||
| /// <inheritdoc /> | |||
| async Task<ITextChannel> IGuild.GetRulesChannelAsync(CacheMode mode, RequestOptions options) | |||
| { | |||
| if (mode == CacheMode.AllowDownload) | |||
| return await GetRulesChannelAsync(options).ConfigureAwait(false); | |||
| else | |||
| return null; | |||
| } | |||
| /// <inheritdoc /> | |||
| async Task<ITextChannel> IGuild.GetPublicUpdatesChannelAsync(CacheMode mode, RequestOptions options) | |||
| { | |||
| if (mode == CacheMode.AllowDownload) | |||
| return await GetPublicUpdatesChannelAsync(options).ConfigureAwait(false); | |||
| else | |||
| return null; | |||
| } | |||
| /// <inheritdoc /> | |||
| async Task<ITextChannel> IGuild.CreateTextChannelAsync(string name, Action<TextChannelProperties> func, RequestOptions options) | |||
| => await CreateTextChannelAsync(name, func, options).ConfigureAwait(false); | |||
| /// <inheritdoc /> | |||
| @@ -0,0 +1,25 @@ | |||
| using System.Diagnostics; | |||
| using Model = Discord.API.GuildWidget; | |||
| namespace Discord.Rest | |||
| { | |||
| [DebuggerDisplay(@"{DebuggerDisplay,nq}")] | |||
| public struct RestGuildWidget | |||
| { | |||
| public bool IsEnabled { get; private set; } | |||
| public ulong? ChannelId { get; private set; } | |||
| internal RestGuildWidget(bool isEnabled, ulong? channelId) | |||
| { | |||
| ChannelId = channelId; | |||
| IsEnabled = isEnabled; | |||
| } | |||
| internal static RestGuildWidget Create(Model model) | |||
| { | |||
| return new RestGuildWidget(model.Enabled, model.ChannelId); | |||
| } | |||
| public override string ToString() => ChannelId?.ToString() ?? "Unknown"; | |||
| private string DebuggerDisplay => $"{ChannelId} ({(IsEnabled ? "Enabled" : "Disabled")})"; | |||
| } | |||
| } | |||
| @@ -65,12 +65,12 @@ namespace Discord.Rest | |||
| public static async Task AddReactionAsync(IMessage msg, IEmote emote, BaseDiscordClient client, RequestOptions options) | |||
| { | |||
| await client.ApiClient.AddReactionAsync(msg.Channel.Id, msg.Id, emote is Emote e ? $"{e.Name}:{e.Id}" : emote.Name, options).ConfigureAwait(false); | |||
| await client.ApiClient.AddReactionAsync(msg.Channel.Id, msg.Id, emote is Emote e ? $"{e.Name}:{e.Id}" : UrlEncode(emote.Name), options).ConfigureAwait(false); | |||
| } | |||
| public static async Task RemoveReactionAsync(IMessage msg, ulong userId, IEmote emote, BaseDiscordClient client, RequestOptions options) | |||
| { | |||
| await client.ApiClient.RemoveReactionAsync(msg.Channel.Id, msg.Id, userId, emote is Emote e ? $"{e.Name}:{e.Id}" : emote.Name, options).ConfigureAwait(false); | |||
| await client.ApiClient.RemoveReactionAsync(msg.Channel.Id, msg.Id, userId, emote is Emote e ? $"{e.Name}:{e.Id}" : UrlEncode(emote.Name), options).ConfigureAwait(false); | |||
| } | |||
| public static async Task RemoveAllReactionsAsync(IMessage msg, BaseDiscordClient client, RequestOptions options) | |||
| @@ -80,14 +80,14 @@ namespace Discord.Rest | |||
| public static async Task RemoveAllReactionsForEmoteAsync(IMessage msg, IEmote emote, BaseDiscordClient client, RequestOptions options) | |||
| { | |||
| await client.ApiClient.RemoveAllReactionsForEmoteAsync(msg.Channel.Id, msg.Id, emote is Emote e ? $"{e.Name}:{e.Id}" : emote.Name, options).ConfigureAwait(false); | |||
| await client.ApiClient.RemoveAllReactionsForEmoteAsync(msg.Channel.Id, msg.Id, emote is Emote e ? $"{e.Name}:{e.Id}" : UrlEncode(emote.Name), options).ConfigureAwait(false); | |||
| } | |||
| public static IAsyncEnumerable<IReadOnlyCollection<IUser>> GetReactionUsersAsync(IMessage msg, IEmote emote, | |||
| int? limit, BaseDiscordClient client, RequestOptions options) | |||
| { | |||
| Preconditions.NotNull(emote, nameof(emote)); | |||
| var emoji = (emote is Emote e ? $"{e.Name}:{e.Id}" : emote.Name); | |||
| var emoji = (emote is Emote e ? $"{e.Name}:{e.Id}" : UrlEncode(emote.Name)); | |||
| return new PagedAsyncEnumerable<IUser>( | |||
| DiscordConfig.MaxUserReactionsPerBatch, | |||
| @@ -114,7 +114,15 @@ namespace Discord.Rest | |||
| }, | |||
| count: limit | |||
| ); | |||
| } | |||
| private static string UrlEncode(string text) | |||
| { | |||
| #if NET461 | |||
| return System.Net.WebUtility.UrlEncode(text); | |||
| #else | |||
| return System.Web.HttpUtility.UrlEncode(text); | |||
| #endif | |||
| } | |||
| public static async Task PinAsync(IMessage msg, BaseDiscordClient client, | |||
| @@ -37,6 +37,9 @@ namespace Discord.Rest | |||
| public virtual bool IsSuppressed => false; | |||
| /// <inheritdoc /> | |||
| public virtual DateTimeOffset? EditedTimestamp => null; | |||
| /// <inheritdoc /> | |||
| public virtual bool MentionedEveryone => false; | |||
| /// <summary> | |||
| /// Gets a collection of the <see cref="Attachment"/>'s on the message. | |||
| /// </summary> | |||
| @@ -18,6 +18,8 @@ namespace Discord.Rest | |||
| private ImmutableArray<Attachment> _attachments = ImmutableArray.Create<Attachment>(); | |||
| private ImmutableArray<Embed> _embeds = ImmutableArray.Create<Embed>(); | |||
| private ImmutableArray<ITag> _tags = ImmutableArray.Create<ITag>(); | |||
| private ImmutableArray<ulong> _roleMentionIds = ImmutableArray.Create<ulong>(); | |||
| private ImmutableArray<RestUser> _userMentions = ImmutableArray.Create<RestUser>(); | |||
| /// <inheritdoc /> | |||
| public override bool IsTTS => _isTTS; | |||
| @@ -28,15 +30,17 @@ namespace Discord.Rest | |||
| /// <inheritdoc /> | |||
| public override DateTimeOffset? EditedTimestamp => DateTimeUtils.FromTicks(_editedTimestampTicks); | |||
| /// <inheritdoc /> | |||
| public override bool MentionedEveryone => _isMentioningEveryone; | |||
| /// <inheritdoc /> | |||
| public override IReadOnlyCollection<Attachment> Attachments => _attachments; | |||
| /// <inheritdoc /> | |||
| public override IReadOnlyCollection<Embed> Embeds => _embeds; | |||
| /// <inheritdoc /> | |||
| public override IReadOnlyCollection<ulong> MentionedChannelIds => MessageHelper.FilterTagsByKey(TagType.ChannelMention, _tags); | |||
| /// <inheritdoc /> | |||
| public override IReadOnlyCollection<ulong> MentionedRoleIds => MessageHelper.FilterTagsByKey(TagType.RoleMention, _tags); | |||
| public override IReadOnlyCollection<ulong> MentionedRoleIds => _roleMentionIds; | |||
| /// <inheritdoc /> | |||
| public override IReadOnlyCollection<RestUser> MentionedUsers => MessageHelper.FilterTagsByValue<RestUser>(TagType.UserMention, _tags); | |||
| public override IReadOnlyCollection<RestUser> MentionedUsers => _userMentions; | |||
| /// <inheritdoc /> | |||
| public override IReadOnlyCollection<ITag> Tags => _tags; | |||
| @@ -67,6 +71,8 @@ namespace Discord.Rest | |||
| { | |||
| _isSuppressed = model.Flags.Value.HasFlag(API.MessageFlags.Suppressed); | |||
| } | |||
| if (model.RoleMentions.IsSpecified) | |||
| _roleMentionIds = model.RoleMentions.Value.ToImmutableArray(); | |||
| if (model.Attachments.IsSpecified) | |||
| { | |||
| @@ -96,20 +102,19 @@ namespace Discord.Rest | |||
| _embeds = ImmutableArray.Create<Embed>(); | |||
| } | |||
| ImmutableArray<IUser> mentions = ImmutableArray.Create<IUser>(); | |||
| if (model.UserMentions.IsSpecified) | |||
| { | |||
| var value = model.UserMentions.Value; | |||
| if (value.Length > 0) | |||
| { | |||
| var newMentions = ImmutableArray.CreateBuilder<IUser>(value.Length); | |||
| var newMentions = ImmutableArray.CreateBuilder<RestUser>(value.Length); | |||
| for (int i = 0; i < value.Length; i++) | |||
| { | |||
| var val = value[i]; | |||
| if (val.Object != null) | |||
| newMentions.Add(RestUser.Create(Discord, val.Object)); | |||
| } | |||
| mentions = newMentions.ToImmutable(); | |||
| _userMentions = newMentions.ToImmutable(); | |||
| } | |||
| } | |||
| @@ -118,7 +123,7 @@ namespace Discord.Rest | |||
| var text = model.Content.Value; | |||
| var guildId = (Channel as IGuildChannel)?.GuildId; | |||
| var guild = guildId != null ? (Discord as IDiscordClient).GetGuildAsync(guildId.Value, CacheMode.CacheOnly).Result : null; | |||
| _tags = MessageHelper.ParseTags(text, null, guild, mentions); | |||
| _tags = MessageHelper.ParseTags(text, null, guild, _userMentions); | |||
| model.Content = text; | |||
| } | |||
| } | |||
| @@ -149,10 +154,10 @@ namespace Discord.Rest | |||
| => MentionUtils.Resolve(this, 0, userHandling, channelHandling, roleHandling, everyoneHandling, emojiHandling); | |||
| /// <inheritdoc /> | |||
| /// <exception cref="InvalidOperationException">This operation may only be called on a <see cref="RestNewsChannel"/> channel.</exception> | |||
| /// <exception cref="InvalidOperationException">This operation may only be called on a <see cref="INewsChannel"/> channel.</exception> | |||
| public async Task CrosspostAsync(RequestOptions options = null) | |||
| { | |||
| if (!(Channel is RestNewsChannel)) | |||
| if (!(Channel is INewsChannel)) | |||
| { | |||
| throw new InvalidOperationException("Publishing (crossposting) is only valid in news channels."); | |||
| } | |||
| @@ -21,6 +21,12 @@ namespace Discord.Rest | |||
| public string[] RPCOrigins { get; private set; } | |||
| /// <inheritdoc /> | |||
| public ulong Flags { get; private set; } | |||
| /// <inheritdoc /> | |||
| public bool IsBotPublic { get; private set; } | |||
| /// <inheritdoc /> | |||
| public bool BotRequiresCodeGrant { get; private set; } | |||
| /// <inheritdoc /> | |||
| public ITeam Team { get; private set; } | |||
| /// <inheritdoc /> | |||
| public IUser Owner { get; private set; } | |||
| @@ -46,11 +52,15 @@ namespace Discord.Rest | |||
| RPCOrigins = model.RPCOrigins; | |||
| Name = model.Name; | |||
| _iconId = model.Icon; | |||
| IsBotPublic = model.IsBotPublic; | |||
| BotRequiresCodeGrant = model.BotRequiresCodeGrant; | |||
| if (model.Flags.IsSpecified) | |||
| Flags = model.Flags.Value; //TODO: Do we still need this? | |||
| if (model.Owner.IsSpecified) | |||
| Owner = RestUser.Create(Discord, model.Owner.Value); | |||
| if (model.Team != null) | |||
| Team = RestTeam.Create(Discord, model.Team); | |||
| } | |||
| /// <exception cref="InvalidOperationException">Unable to update this object from a different application token.</exception> | |||
| @@ -0,0 +1,37 @@ | |||
| using System.Collections.Generic; | |||
| using System.Collections.Immutable; | |||
| using System.Linq; | |||
| using Model = Discord.API.Team; | |||
| namespace Discord.Rest | |||
| { | |||
| public class RestTeam : RestEntity<ulong>, ITeam | |||
| { | |||
| /// <inheritdoc /> | |||
| public string IconUrl => _iconId != null ? CDN.GetTeamIconUrl(Id, _iconId) : null; | |||
| /// <inheritdoc /> | |||
| public IReadOnlyList<ITeamMember> TeamMembers { get; private set; } | |||
| /// <inheritdoc /> | |||
| public ulong OwnerUserId { get; private set; } | |||
| private string _iconId; | |||
| internal RestTeam(BaseDiscordClient discord, ulong id) | |||
| : base(discord, id) | |||
| { | |||
| } | |||
| internal static RestTeam Create(BaseDiscordClient discord, Model model) | |||
| { | |||
| var entity = new RestTeam(discord, model.Id); | |||
| entity.Update(model); | |||
| return entity; | |||
| } | |||
| internal virtual void Update(Model model) | |||
| { | |||
| if (model.Icon.IsSpecified) | |||
| _iconId = model.Icon.Value; | |||
| OwnerUserId = model.OwnerUserId; | |||
| TeamMembers = model.TeamMembers.Select(x => new RestTeamMember(Discord, x)).ToImmutableArray(); | |||
| } | |||
| } | |||
| } | |||
| @@ -0,0 +1,30 @@ | |||
| using System; | |||
| using Model = Discord.API.TeamMember; | |||
| namespace Discord.Rest | |||
| { | |||
| public class RestTeamMember : ITeamMember | |||
| { | |||
| /// <inheritdoc /> | |||
| public MembershipState MembershipState { get; } | |||
| /// <inheritdoc /> | |||
| public string[] Permissions { get; } | |||
| /// <inheritdoc /> | |||
| public ulong TeamId { get; } | |||
| /// <inheritdoc /> | |||
| public IUser User { get; } | |||
| internal RestTeamMember(BaseDiscordClient discord, Model model) | |||
| { | |||
| MembershipState = model.MembershipState switch | |||
| { | |||
| API.MembershipState.Invited => MembershipState.Invited, | |||
| API.MembershipState.Accepted => MembershipState.Accepted, | |||
| _ => throw new InvalidOperationException("Invalid membership state"), | |||
| }; | |||
| Permissions = model.Permissions; | |||
| TeamId = model.TeamId; | |||
| User = RestUser.Create(discord, model.User); | |||
| } | |||
| } | |||
| } | |||
| @@ -12,7 +12,7 @@ namespace Discord.Net.Queue | |||
| { | |||
| internal class RequestQueue : IDisposable | |||
| { | |||
| public event Func<BucketId, RateLimitInfo?, Task> RateLimitTriggered; | |||
| public event Func<BucketId, RateLimitInfo?, string, Task> RateLimitTriggered; | |||
| private readonly ConcurrentDictionary<BucketId, object> _buckets; | |||
| private readonly SemaphoreSlim _tokenLock; | |||
| @@ -190,9 +190,9 @@ namespace Discord.Net.Queue | |||
| } | |||
| return (RequestBucket)obj; | |||
| } | |||
| internal async Task RaiseRateLimitTriggered(BucketId bucketId, RateLimitInfo? info) | |||
| internal async Task RaiseRateLimitTriggered(BucketId bucketId, RateLimitInfo? info, string endpoint) | |||
| { | |||
| await RateLimitTriggered(bucketId, info).ConfigureAwait(false); | |||
| await RateLimitTriggered(bucketId, info, endpoint).ConfigureAwait(false); | |||
| } | |||
| internal (RequestBucket, BucketId) UpdateBucketHash(BucketId id, string discordHash) | |||
| { | |||
| @@ -86,7 +86,7 @@ namespace Discord.Net.Queue | |||
| #endif | |||
| UpdateRateLimit(id, request, info, true); | |||
| } | |||
| await _queue.RaiseRateLimitTriggered(Id, info).ConfigureAwait(false); | |||
| await _queue.RaiseRateLimitTriggered(Id, info, $"{request.Method} {request.Endpoint}").ConfigureAwait(false); | |||
| continue; //Retry | |||
| case HttpStatusCode.BadGateway: //502 | |||
| #if DEBUG_LIMITS | |||
| @@ -249,7 +249,7 @@ namespace Discord.Net.Queue | |||
| if (!isRateLimited) | |||
| { | |||
| isRateLimited = true; | |||
| await _queue.RaiseRateLimitTriggered(Id, null).ConfigureAwait(false); | |||
| await _queue.RaiseRateLimitTriggered(Id, null, $"{request.Method} {request.Endpoint}").ConfigureAwait(false); | |||
| } | |||
| ThrowRetryLimit(request); | |||
| @@ -0,0 +1,31 @@ | |||
| using Newtonsoft.Json; | |||
| using System; | |||
| namespace Discord.API.Gateway | |||
| { | |||
| internal class InviteCreateEvent | |||
| { | |||
| [JsonProperty("channel_id")] | |||
| public ulong ChannelId { get; set; } | |||
| [JsonProperty("code")] | |||
| public string Code { get; set; } | |||
| [JsonProperty("created_at")] | |||
| public DateTimeOffset CreatedAt { get; set; } | |||
| [JsonProperty("guild_id")] | |||
| public Optional<ulong> GuildId { get; set; } | |||
| [JsonProperty("inviter")] | |||
| public Optional<User> Inviter { get; set; } | |||
| [JsonProperty("max_age")] | |||
| public int MaxAge { get; set; } | |||
| [JsonProperty("max_uses")] | |||
| public int MaxUses { get; set; } | |||
| [JsonProperty("target_user")] | |||
| public Optional<User> TargetUser { get; set; } | |||
| [JsonProperty("target_user_type")] | |||
| public Optional<TargetUserType> TargetUserType { get; set; } | |||
| [JsonProperty("temporary")] | |||
| public bool Temporary { get; set; } | |||
| [JsonProperty("uses")] | |||
| public int Uses { get; set; } | |||
| } | |||
| } | |||
| @@ -0,0 +1,14 @@ | |||
| using Newtonsoft.Json; | |||
| namespace Discord.API.Gateway | |||
| { | |||
| internal class InviteDeleteEvent | |||
| { | |||
| [JsonProperty("channel_id")] | |||
| public ulong ChannelId { get; set; } | |||
| [JsonProperty("code")] | |||
| public string Code { get; set; } | |||
| [JsonProperty("guild_id")] | |||
| public Optional<ulong> GuildId { get; set; } | |||
| } | |||
| } | |||
| @@ -99,6 +99,12 @@ namespace Discord.Audio | |||
| _token = token; | |||
| await _connection.StartAsync().ConfigureAwait(false); | |||
| } | |||
| public IReadOnlyDictionary<ulong, AudioInStream> GetStreams() | |||
| { | |||
| return _streams.ToDictionary(pair => pair.Key, pair => pair.Value.Reader); | |||
| } | |||
| public async Task StopAsync() | |||
| { | |||
| await _connection.StopAsync().ConfigureAwait(false); | |||
| @@ -379,7 +385,7 @@ namespace Discord.Audio | |||
| private async Task RunHeartbeatAsync(int intervalMillis, CancellationToken cancelToken) | |||
| { | |||
| //TODO: Clean this up when Discord's session patch is live | |||
| // TODO: Clean this up when Discord's session patch is live | |||
| try | |||
| { | |||
| await _audioLogger.DebugAsync("Heartbeat Started").ConfigureAwait(false); | |||
| @@ -61,14 +61,17 @@ namespace Discord.Audio.Streams | |||
| _task = Run(); | |||
| } | |||
| protected override void Dispose(bool disposing) | |||
| { | |||
| if (disposing) | |||
| { | |||
| _disposeTokenSource?.Cancel(); | |||
| _disposeTokenSource?.Dispose(); | |||
| _cancelTokenSource?.Cancel(); | |||
| _cancelTokenSource?.Dispose(); | |||
| _queueLock?.Dispose(); | |||
| _next.Dispose(); | |||
| } | |||
| base.Dispose(disposing); | |||
| } | |||
| @@ -68,10 +68,12 @@ namespace Discord.Audio.Streams | |||
| protected override void Dispose(bool disposing) | |||
| { | |||
| base.Dispose(disposing); | |||
| if (disposing) | |||
| { | |||
| _decoder.Dispose(); | |||
| _next.Dispose(); | |||
| } | |||
| base.Dispose(disposing); | |||
| } | |||
| } | |||
| } | |||
| @@ -1,4 +1,4 @@ | |||
| using System; | |||
| using System; | |||
| using System.Threading; | |||
| using System.Threading.Tasks; | |||
| @@ -89,10 +89,12 @@ namespace Discord.Audio.Streams | |||
| protected override void Dispose(bool disposing) | |||
| { | |||
| base.Dispose(disposing); | |||
| if (disposing) | |||
| { | |||
| _encoder.Dispose(); | |||
| _next.Dispose(); | |||
| } | |||
| base.Dispose(disposing); | |||
| } | |||
| } | |||
| } | |||
| @@ -76,5 +76,12 @@ namespace Discord.Audio.Streams | |||
| (buffer[extensionOffset + 3]); | |||
| return extensionOffset + 4 + (extensionLength * 4); | |||
| } | |||
| protected override void Dispose(bool disposing) | |||
| { | |||
| if (disposing) | |||
| _next.Dispose(); | |||
| base.Dispose(disposing); | |||
| } | |||
| } | |||
| } | |||
| @@ -1,4 +1,4 @@ | |||
| using System; | |||
| using System; | |||
| using System.Threading; | |||
| using System.Threading.Tasks; | |||
| @@ -69,5 +69,12 @@ namespace Discord.Audio.Streams | |||
| { | |||
| await _next.ClearAsync(cancelToken).ConfigureAwait(false); | |||
| } | |||
| protected override void Dispose(bool disposing) | |||
| { | |||
| if (disposing) | |||
| _next.Dispose(); | |||
| base.Dispose(disposing); | |||
| } | |||
| } | |||
| } | |||
| @@ -44,5 +44,12 @@ namespace Discord.Audio.Streams | |||
| { | |||
| await _next.ClearAsync(cancelToken).ConfigureAwait(false); | |||
| } | |||
| protected override void Dispose(bool disposing) | |||
| { | |||
| if (disposing) | |||
| _next.Dispose(); | |||
| base.Dispose(disposing); | |||
| } | |||
| } | |||
| } | |||
| @@ -60,5 +60,12 @@ namespace Discord.Audio.Streams | |||
| { | |||
| await _next.ClearAsync(cancelToken).ConfigureAwait(false); | |||
| } | |||
| protected override void Dispose(bool disposing) | |||
| { | |||
| if (disposing) | |||
| _next.Dispose(); | |||
| base.Dispose(disposing); | |||
| } | |||
| } | |||
| } | |||
| @@ -389,5 +389,47 @@ namespace Discord.WebSocket | |||
| remove { _recipientRemovedEvent.Remove(value); } | |||
| } | |||
| internal readonly AsyncEvent<Func<SocketGroupUser, Task>> _recipientRemovedEvent = new AsyncEvent<Func<SocketGroupUser, Task>>(); | |||
| //Invites | |||
| /// <summary> | |||
| /// Fired when an invite is created. | |||
| /// </summary> | |||
| /// <remarks> | |||
| /// <para> | |||
| /// This event is fired when an invite is created. The event handler must return a | |||
| /// <see cref="Task"/> and accept a <see cref="SocketInvite"/> as its parameter. | |||
| /// </para> | |||
| /// <para> | |||
| /// The invite created will be passed into the <see cref="SocketInvite"/> parameter. | |||
| /// </para> | |||
| /// </remarks> | |||
| public event Func<SocketInvite, Task> InviteCreated | |||
| { | |||
| add { _inviteCreatedEvent.Add(value); } | |||
| remove { _inviteCreatedEvent.Remove(value); } | |||
| } | |||
| internal readonly AsyncEvent<Func<SocketInvite, Task>> _inviteCreatedEvent = new AsyncEvent<Func<SocketInvite, Task>>(); | |||
| /// <summary> | |||
| /// Fired when an invite is deleted. | |||
| /// </summary> | |||
| /// <remarks> | |||
| /// <para> | |||
| /// This event is fired when an invite is deleted. The event handler must return | |||
| /// a <see cref="Task"/> and accept a <see cref="SocketGuildChannel"/> and | |||
| /// <see cref="string"/> as its parameter. | |||
| /// </para> | |||
| /// <para> | |||
| /// The channel where this invite was created will be passed into the <see cref="SocketGuildChannel"/> parameter. | |||
| /// </para> | |||
| /// <para> | |||
| /// The code of the deleted invite will be passed into the <see cref="string"/> parameter. | |||
| /// </para> | |||
| /// </remarks> | |||
| public event Func<SocketGuildChannel, string, Task> InviteDeleted | |||
| { | |||
| add { _inviteDeletedEvent.Add(value); } | |||
| remove { _inviteDeletedEvent.Remove(value); } | |||
| } | |||
| internal readonly AsyncEvent<Func<SocketGuildChannel, string, Task>> _inviteDeletedEvent = new AsyncEvent<Func<SocketGuildChannel, string, Task>>(); | |||
| } | |||
| } | |||
| @@ -44,6 +44,8 @@ namespace Discord | |||
| var ex2 = ex as WebSocketClosedException; | |||
| if (ex2?.CloseCode == 4006) | |||
| CriticalError(new Exception("WebSocket session expired", ex)); | |||
| else if (ex2?.CloseCode == 4014) | |||
| CriticalError(new Exception("WebSocket connection was closed", ex)); | |||
| else | |||
| Error(new Exception("WebSocket connection was closed", ex)); | |||
| } | |||
| @@ -358,6 +358,9 @@ namespace Discord.WebSocket | |||
| client.UserIsTyping += (oldUser, newUser) => _userIsTypingEvent.InvokeAsync(oldUser, newUser); | |||
| client.RecipientAdded += (user) => _recipientAddedEvent.InvokeAsync(user); | |||
| client.RecipientRemoved += (user) => _recipientRemovedEvent.InvokeAsync(user); | |||
| client.InviteCreated += (invite) => _inviteCreatedEvent.InvokeAsync(invite); | |||
| client.InviteDeleted += (channel, invite) => _inviteDeletedEvent.InvokeAsync(channel, invite); | |||
| } | |||
| //IDiscordClient | |||
| @@ -368,7 +368,7 @@ namespace Discord.WebSocket | |||
| { | |||
| var cachedGuilds = guilds.ToImmutableArray(); | |||
| const short batchSize = 100; //TODO: Gateway Intents will limit to a maximum of 1 guild_id | |||
| const short batchSize = 1; | |||
| ulong[] batchIds = new ulong[Math.Min(batchSize, cachedGuilds.Length)]; | |||
| Task[] batchTasks = new Task[batchIds.Length]; | |||
| int batchCount = (cachedGuilds.Length + (batchSize - 1)) / batchSize; | |||
| @@ -901,6 +901,13 @@ namespace Discord.WebSocket | |||
| if (user != null) | |||
| { | |||
| var globalBefore = user.GlobalUser.Clone(); | |||
| if (user.GlobalUser.Update(State, data.User)) | |||
| { | |||
| //Global data was updated, trigger UserUpdated | |||
| await TimedInvokeAsync(_userUpdatedEvent, nameof(UserUpdated), globalBefore, user).ConfigureAwait(false); | |||
| } | |||
| var before = user.Clone(); | |||
| user.Update(State, data); | |||
| await TimedInvokeAsync(_guildMemberUpdatedEvent, nameof(GuildMemberUpdated), before, user).ConfigureAwait(false); | |||
| @@ -1679,6 +1686,64 @@ namespace Discord.WebSocket | |||
| } | |||
| break; | |||
| //Invites | |||
| case "INVITE_CREATE": | |||
| { | |||
| await _gatewayLogger.DebugAsync("Received Dispatch (INVITE_CREATE)").ConfigureAwait(false); | |||
| var data = (payload as JToken).ToObject<API.Gateway.InviteCreateEvent>(_serializer); | |||
| if (State.GetChannel(data.ChannelId) is SocketGuildChannel channel) | |||
| { | |||
| var guild = channel.Guild; | |||
| if (!guild.IsSynced) | |||
| { | |||
| await UnsyncedGuildAsync(type, guild.Id).ConfigureAwait(false); | |||
| return; | |||
| } | |||
| SocketGuildUser inviter = data.Inviter.IsSpecified | |||
| ? (guild.GetUser(data.Inviter.Value.Id) ?? guild.AddOrUpdateUser(data.Inviter.Value)) | |||
| : null; | |||
| SocketUser target = data.TargetUser.IsSpecified | |||
| ? (guild.GetUser(data.TargetUser.Value.Id) ?? (SocketUser)SocketUnknownUser.Create(this, State, data.TargetUser.Value)) | |||
| : null; | |||
| var invite = SocketInvite.Create(this, guild, channel, inviter, target, data); | |||
| await TimedInvokeAsync(_inviteCreatedEvent, nameof(InviteCreated), invite).ConfigureAwait(false); | |||
| } | |||
| else | |||
| { | |||
| await UnknownChannelAsync(type, data.ChannelId).ConfigureAwait(false); | |||
| return; | |||
| } | |||
| } | |||
| break; | |||
| case "INVITE_DELETE": | |||
| { | |||
| await _gatewayLogger.DebugAsync("Received Dispatch (INVITE_DELETE)").ConfigureAwait(false); | |||
| var data = (payload as JToken).ToObject<API.Gateway.InviteDeleteEvent>(_serializer); | |||
| if (State.GetChannel(data.ChannelId) is SocketGuildChannel channel) | |||
| { | |||
| var guild = channel.Guild; | |||
| if (!guild.IsSynced) | |||
| { | |||
| await UnsyncedGuildAsync(type, guild.Id).ConfigureAwait(false); | |||
| return; | |||
| } | |||
| await TimedInvokeAsync(_inviteDeletedEvent, nameof(InviteDeleted), channel, data.Code).ConfigureAwait(false); | |||
| } | |||
| else | |||
| { | |||
| await UnknownChannelAsync(type, data.ChannelId).ConfigureAwait(false); | |||
| return; | |||
| } | |||
| } | |||
| break; | |||
| //Ignored (User only) | |||
| case "CHANNEL_PINS_ACK": | |||
| await _gatewayLogger.DebugAsync("Ignored Dispatch (CHANNEL_PINS_ACK)").ConfigureAwait(false); | |||
| @@ -87,7 +87,7 @@ namespace Discord.WebSocket | |||
| /// </para> | |||
| /// <para> | |||
| /// For more information, please see | |||
| /// <see href="https://discordapp.com/developers/docs/topics/gateway#request-guild-members">Request Guild Members</see> | |||
| /// <see href="https://discord.com/developers/docs/topics/gateway#request-guild-members">Request Guild Members</see> | |||
| /// on the official Discord API documentation. | |||
| /// </para> | |||
| /// <note> | |||
| @@ -158,6 +158,7 @@ namespace Discord.WebSocket | |||
| } | |||
| private int _maxWaitForGuildAvailable = 10000; | |||
| /// <summary> | |||
| /// Gets or sets gateway intents to limit what events are sent from Discord. Allows for more granular control than the <see cref="GuildSubscriptions"/> property. | |||
| /// </summary> | |||
| /// <remarks> | |||
| @@ -125,7 +125,6 @@ namespace Discord.WebSocket | |||
| public virtual async Task AddPermissionOverwriteAsync(IUser user, OverwritePermissions permissions, RequestOptions options = null) | |||
| { | |||
| await ChannelHelper.AddPermissionOverwriteAsync(this, Discord, user, permissions, options).ConfigureAwait(false); | |||
| _overwrites = _overwrites.Add(new Overwrite(user.Id, PermissionTarget.User, new OverwritePermissions(permissions.AllowValue, permissions.DenyValue))); | |||
| } | |||
| /// <summary> | |||
| @@ -140,7 +139,6 @@ namespace Discord.WebSocket | |||
| public virtual async Task AddPermissionOverwriteAsync(IRole role, OverwritePermissions permissions, RequestOptions options = null) | |||
| { | |||
| await ChannelHelper.AddPermissionOverwriteAsync(this, Discord, role, permissions, options).ConfigureAwait(false); | |||
| _overwrites = _overwrites.Add(new Overwrite(role.Id, PermissionTarget.Role, new OverwritePermissions(permissions.AllowValue, permissions.DenyValue))); | |||
| } | |||
| /// <summary> | |||
| /// Removes the permission overwrite for the given user, if one exists. | |||
| @@ -153,15 +151,6 @@ namespace Discord.WebSocket | |||
| public virtual async Task RemovePermissionOverwriteAsync(IUser user, RequestOptions options = null) | |||
| { | |||
| await ChannelHelper.RemovePermissionOverwriteAsync(this, Discord, user, options).ConfigureAwait(false); | |||
| for (int i = 0; i < _overwrites.Length; i++) | |||
| { | |||
| if (_overwrites[i].TargetId == user.Id) | |||
| { | |||
| _overwrites = _overwrites.RemoveAt(i); | |||
| return; | |||
| } | |||
| } | |||
| } | |||
| /// <summary> | |||
| /// Removes the permission overwrite for the given role, if one exists. | |||
| @@ -174,15 +163,6 @@ namespace Discord.WebSocket | |||
| public virtual async Task RemovePermissionOverwriteAsync(IRole role, RequestOptions options = null) | |||
| { | |||
| await ChannelHelper.RemovePermissionOverwriteAsync(this, Discord, role, options).ConfigureAwait(false); | |||
| for (int i = 0; i < _overwrites.Length; i++) | |||
| { | |||
| if (_overwrites[i].TargetId == role.Id) | |||
| { | |||
| _overwrites = _overwrites.RemoveAt(i); | |||
| return; | |||
| } | |||
| } | |||
| } | |||
| public new virtual SocketGuildUser GetUser(ulong id) => null; | |||
| @@ -15,7 +15,7 @@ namespace Discord.WebSocket | |||
| /// </note> | |||
| /// </remarks> | |||
| [DebuggerDisplay(@"{DebuggerDisplay,nq}")] | |||
| public class SocketNewsChannel : SocketTextChannel | |||
| public class SocketNewsChannel : SocketTextChannel, INewsChannel | |||
| { | |||
| internal SocketNewsChannel(DiscordSocketClient discord, ulong id, SocketGuild guild) | |||
| :base(discord, id, guild) | |||
| @@ -48,6 +48,8 @@ namespace Discord.WebSocket | |||
| /// <inheritdoc /> | |||
| public bool IsEmbeddable { get; private set; } | |||
| /// <inheritdoc /> | |||
| public bool IsWidgetEnabled { get; private set; } | |||
| /// <inheritdoc /> | |||
| public VerificationLevel VerificationLevel { get; private set; } | |||
| /// <inheritdoc /> | |||
| public MfaLevel MfaLevel { get; private set; } | |||
| @@ -83,7 +85,10 @@ namespace Discord.WebSocket | |||
| internal ulong? AFKChannelId { get; private set; } | |||
| internal ulong? EmbedChannelId { get; private set; } | |||
| internal ulong? WidgetChannelId { get; private set; } | |||
| internal ulong? SystemChannelId { get; private set; } | |||
| internal ulong? RulesChannelId { get; private set; } | |||
| internal ulong? PublicUpdatesChannelId { get; private set; } | |||
| /// <inheritdoc /> | |||
| public ulong OwnerId { get; private set; } | |||
| /// <summary> Gets the user that owns this guild. </summary> | |||
| @@ -95,6 +100,8 @@ namespace Discord.WebSocket | |||
| /// <inheritdoc /> | |||
| public string SplashId { get; private set; } | |||
| /// <inheritdoc /> | |||
| public string DiscoverySplashId { get; private set; } | |||
| /// <inheritdoc /> | |||
| public PremiumTier PremiumTier { get; private set; } | |||
| /// <inheritdoc /> | |||
| public string BannerId { get; private set; } | |||
| @@ -108,6 +115,12 @@ namespace Discord.WebSocket | |||
| public int PremiumSubscriptionCount { get; private set; } | |||
| /// <inheritdoc /> | |||
| public string PreferredLocale { get; private set; } | |||
| /// <inheritdoc /> | |||
| public int? MaxPresences { get; private set; } | |||
| /// <inheritdoc /> | |||
| public int? MaxMembers { get; private set; } | |||
| /// <inheritdoc /> | |||
| public int? MaxVideoChannelUsers { get; private set; } | |||
| /// <inheritdoc /> | |||
| public CultureInfo PreferredCulture { get; private set; } | |||
| @@ -119,6 +132,8 @@ namespace Discord.WebSocket | |||
| /// <inheritdoc /> | |||
| public string SplashUrl => CDN.GetGuildSplashUrl(Id, SplashId); | |||
| /// <inheritdoc /> | |||
| public string DiscoverySplashUrl => CDN.GetGuildDiscoverySplashUrl(Id, DiscoverySplashId); | |||
| /// <inheritdoc /> | |||
| public string BannerUrl => CDN.GetGuildBannerUrl(Id, BannerId); | |||
| /// <summary> Indicates whether the client has all the members downloaded to the local guild cache. </summary> | |||
| public bool HasAllMembers => MemberCount == DownloadedMemberCount;// _downloaderPromise.Task.IsCompleted; | |||
| @@ -152,7 +167,7 @@ namespace Discord.WebSocket | |||
| /// </summary> | |||
| /// <returns> | |||
| /// A <see cref="SocketVoiceChannel" /> that the AFK users will be moved to after they have idled for too | |||
| /// long; <c>null</c> if none is set. | |||
| /// long; <see langword="null"/> if none is set. | |||
| /// </returns> | |||
| public SocketVoiceChannel AFKChannel | |||
| { | |||
| @@ -166,8 +181,9 @@ namespace Discord.WebSocket | |||
| /// Gets the embed channel (i.e. the channel set in the guild's widget settings) in this guild. | |||
| /// </summary> | |||
| /// <returns> | |||
| /// A channel set within the server's widget settings; <c>null</c> if none is set. | |||
| /// A channel set within the server's widget settings; <see langword="null"/> if none is set. | |||
| /// </returns> | |||
| [Obsolete("This property is deprecated, use WidgetChannel instead.")] | |||
| public SocketGuildChannel EmbedChannel | |||
| { | |||
| get | |||
| @@ -177,10 +193,24 @@ namespace Discord.WebSocket | |||
| } | |||
| } | |||
| /// <summary> | |||
| /// Gets the widget channel (i.e. the channel set in the guild's widget settings) in this guild. | |||
| /// </summary> | |||
| /// <returns> | |||
| /// A channel set within the server's widget settings; <see langword="null"/> if none is set. | |||
| /// </returns> | |||
| public SocketGuildChannel WidgetChannel | |||
| { | |||
| get | |||
| { | |||
| var id = WidgetChannelId; | |||
| return id.HasValue ? GetChannel(id.Value) : null; | |||
| } | |||
| } | |||
| /// <summary> | |||
| /// Gets the system channel where randomized welcome messages are sent in this guild. | |||
| /// </summary> | |||
| /// <returns> | |||
| /// A text channel where randomized welcome messages will be sent to; <c>null</c> if none is set. | |||
| /// A text channel where randomized welcome messages will be sent to; <see langword="null"/> if none is set. | |||
| /// </returns> | |||
| public SocketTextChannel SystemChannel | |||
| { | |||
| @@ -191,6 +221,36 @@ namespace Discord.WebSocket | |||
| } | |||
| } | |||
| /// <summary> | |||
| /// Gets the channel with the guild rules. | |||
| /// </summary> | |||
| /// <returns> | |||
| /// A text channel with the guild rules; <see langword="null"/> if none is set. | |||
| /// </returns> | |||
| public SocketTextChannel RulesChannel | |||
| { | |||
| get | |||
| { | |||
| var id = RulesChannelId; | |||
| return id.HasValue ? GetTextChannel(id.Value) : null; | |||
| } | |||
| } | |||
| /// <summary> | |||
| /// Gets the channel where admins and moderators of Community guilds receive | |||
| /// notices from Discord. | |||
| /// </summary> | |||
| /// <returns> | |||
| /// A text channel where admins and moderators of Community guilds receive | |||
| /// notices from Discord; <see langword="null"/> if none is set. | |||
| /// </returns> | |||
| public SocketTextChannel PublicUpdatesChannel | |||
| { | |||
| get | |||
| { | |||
| var id = PublicUpdatesChannelId; | |||
| return id.HasValue ? GetTextChannel(id.Value) : null; | |||
| } | |||
| } | |||
| /// <summary> | |||
| /// Gets a collection of all text channels in this guild. | |||
| /// </summary> | |||
| /// <returns> | |||
| @@ -360,15 +420,24 @@ namespace Discord.WebSocket | |||
| internal void Update(ClientState state, Model model) | |||
| { | |||
| AFKChannelId = model.AFKChannelId; | |||
| EmbedChannelId = model.EmbedChannelId; | |||
| if (model.EmbedChannelId.IsSpecified) | |||
| EmbedChannelId = model.EmbedChannelId.Value; | |||
| if (model.WidgetChannelId.IsSpecified) | |||
| WidgetChannelId = model.WidgetChannelId.Value; | |||
| SystemChannelId = model.SystemChannelId; | |||
| RulesChannelId = model.RulesChannelId; | |||
| PublicUpdatesChannelId = model.PublicUpdatesChannelId; | |||
| AFKTimeout = model.AFKTimeout; | |||
| IsEmbeddable = model.EmbedEnabled; | |||
| if (model.EmbedEnabled.IsSpecified) | |||
| IsEmbeddable = model.EmbedEnabled.Value; | |||
| if (model.WidgetEnabled.IsSpecified) | |||
| IsWidgetEnabled = model.WidgetEnabled.Value; | |||
| IconId = model.Icon; | |||
| Name = model.Name; | |||
| OwnerId = model.OwnerId; | |||
| VoiceRegionId = model.Region; | |||
| SplashId = model.Splash; | |||
| DiscoverySplashId = model.DiscoverySplash; | |||
| VerificationLevel = model.VerificationLevel; | |||
| MfaLevel = model.MfaLevel; | |||
| DefaultMessageNotifications = model.DefaultMessageNotifications; | |||
| @@ -379,9 +448,16 @@ namespace Discord.WebSocket | |||
| BannerId = model.Banner; | |||
| SystemChannelFlags = model.SystemChannelFlags; | |||
| Description = model.Description; | |||
| PremiumSubscriptionCount = model.PremiumSubscriptionCount.GetValueOrDefault(); | |||
| if (model.PremiumSubscriptionCount.IsSpecified) | |||
| PremiumSubscriptionCount = model.PremiumSubscriptionCount.Value; | |||
| if (model.MaxPresences.IsSpecified) | |||
| MaxPresences = model.MaxPresences.Value ?? 25000; | |||
| if (model.MaxMembers.IsSpecified) | |||
| MaxMembers = model.MaxMembers.Value; | |||
| if (model.MaxVideoChannelUsers.IsSpecified) | |||
| MaxVideoChannelUsers = model.MaxVideoChannelUsers.Value; | |||
| PreferredLocale = model.PreferredLocale; | |||
| PreferredCulture = new CultureInfo(PreferredLocale); | |||
| PreferredCulture = PreferredLocale == null ? null : new CultureInfo(PreferredLocale); | |||
| if (model.Emojis != null) | |||
| { | |||
| @@ -447,15 +523,20 @@ namespace Discord.WebSocket | |||
| => GuildHelper.DeleteAsync(this, Discord, options); | |||
| /// <inheritdoc /> | |||
| /// <exception cref="ArgumentNullException"><paramref name="func"/> is <c>null</c>.</exception> | |||
| /// <exception cref="ArgumentNullException"><paramref name="func"/> is <see langword="null"/>.</exception> | |||
| public Task ModifyAsync(Action<GuildProperties> func, RequestOptions options = null) | |||
| => GuildHelper.ModifyAsync(this, Discord, func, options); | |||
| /// <inheritdoc /> | |||
| /// <exception cref="ArgumentNullException"><paramref name="func"/> is <c>null</c>.</exception> | |||
| /// <exception cref="ArgumentNullException"><paramref name="func"/> is <see langword="null"/>.</exception> | |||
| [Obsolete("This endpoint is deprecated, use ModifyWidgetAsync instead.")] | |||
| public Task ModifyEmbedAsync(Action<GuildEmbedProperties> func, RequestOptions options = null) | |||
| => GuildHelper.ModifyEmbedAsync(this, Discord, func, options); | |||
| /// <inheritdoc /> | |||
| /// <exception cref="ArgumentNullException"><paramref name="func"/> is <see langword="null"/>.</exception> | |||
| public Task ModifyWidgetAsync(Action<GuildWidgetProperties> func, RequestOptions options = null) | |||
| => GuildHelper.ModifyWidgetAsync(this, Discord, func, options); | |||
| /// <inheritdoc /> | |||
| public Task ReorderChannelsAsync(IEnumerable<ReorderChannelProperties> args, RequestOptions options = null) | |||
| => GuildHelper.ReorderChannelsAsync(this, Discord, args, options); | |||
| /// <inheritdoc /> | |||
| @@ -485,7 +566,7 @@ namespace Discord.WebSocket | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <returns> | |||
| /// 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; <c>null</c> if the ban entry cannot be found. | |||
| /// contains the user information and the reason for the ban; <see langword="null"/> if the ban entry cannot be found. | |||
| /// </returns> | |||
| public Task<RestBan> GetBanAsync(IUser user, RequestOptions options = null) | |||
| => GuildHelper.GetBanAsync(this, Discord, user.Id, options); | |||
| @@ -496,7 +577,7 @@ namespace Discord.WebSocket | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <returns> | |||
| /// 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; <c>null</c> if the ban entry cannot be found. | |||
| /// contains the user information and the reason for the ban; <see langword="null"/> if the ban entry cannot be found. | |||
| /// </returns> | |||
| public Task<RestBan> GetBanAsync(ulong userId, RequestOptions options = null) | |||
| => GuildHelper.GetBanAsync(this, Discord, userId, options); | |||
| @@ -521,7 +602,7 @@ namespace Discord.WebSocket | |||
| /// </summary> | |||
| /// <param name="id">The snowflake identifier for the channel.</param> | |||
| /// <returns> | |||
| /// A generic channel associated with the specified <paramref name="id" />; <c>null</c> if none is found. | |||
| /// A generic channel associated with the specified <paramref name="id" />; <see langword="null"/> if none is found. | |||
| /// </returns> | |||
| public SocketGuildChannel GetChannel(ulong id) | |||
| { | |||
| @@ -535,7 +616,7 @@ namespace Discord.WebSocket | |||
| /// </summary> | |||
| /// <param name="id">The snowflake identifier for the text channel.</param> | |||
| /// <returns> | |||
| /// A text channel associated with the specified <paramref name="id" />; <c>null</c> if none is found. | |||
| /// A text channel associated with the specified <paramref name="id" />; <see langword="null"/> if none is found. | |||
| /// </returns> | |||
| public SocketTextChannel GetTextChannel(ulong id) | |||
| => GetChannel(id) as SocketTextChannel; | |||
| @@ -544,7 +625,7 @@ namespace Discord.WebSocket | |||
| /// </summary> | |||
| /// <param name="id">The snowflake identifier for the voice channel.</param> | |||
| /// <returns> | |||
| /// A voice channel associated with the specified <paramref name="id" />; <c>null</c> if none is found. | |||
| /// A voice channel associated with the specified <paramref name="id" />; <see langword="null"/> if none is found. | |||
| /// </returns> | |||
| public SocketVoiceChannel GetVoiceChannel(ulong id) | |||
| => GetChannel(id) as SocketVoiceChannel; | |||
| @@ -553,7 +634,7 @@ namespace Discord.WebSocket | |||
| /// </summary> | |||
| /// <param name="id">The snowflake identifier for the category channel.</param> | |||
| /// <returns> | |||
| /// A category channel associated with the specified <paramref name="id" />; <c>null</c> if none is found. | |||
| /// A category channel associated with the specified <paramref name="id" />; <see langword="null"/> if none is found. | |||
| /// </returns> | |||
| public SocketCategoryChannel GetCategoryChannel(ulong id) | |||
| => GetChannel(id) as SocketCategoryChannel; | |||
| @@ -589,7 +670,7 @@ namespace Discord.WebSocket | |||
| /// <param name="name">The new name for the voice channel.</param> | |||
| /// <param name="func">The delegate containing the properties to be applied to the channel upon its creation.</param> | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <exception cref="ArgumentNullException"><paramref name="name"/> is <c>null</c>.</exception> | |||
| /// <exception cref="ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception> | |||
| /// <returns> | |||
| /// A task that represents the asynchronous creation operation. The task result contains the newly created | |||
| /// voice channel. | |||
| @@ -602,7 +683,7 @@ namespace Discord.WebSocket | |||
| /// <param name="name">The new name for the category.</param> | |||
| /// <param name="func">The delegate containing the properties to be applied to the channel upon its creation.</param> | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <exception cref="ArgumentNullException"><paramref name="name"/> is <c>null</c>.</exception> | |||
| /// <exception cref="ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception> | |||
| /// <returns> | |||
| /// A task that represents the asynchronous creation operation. The task result contains the newly created | |||
| /// category channel. | |||
| @@ -666,7 +747,7 @@ namespace Discord.WebSocket | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <returns> | |||
| /// A task that represents the asynchronous get operation. The task result contains the partial metadata of | |||
| /// the vanity invite found within this guild; <c>null</c> if none is found. | |||
| /// the vanity invite found within this guild; <see langword="null"/> if none is found. | |||
| /// </returns> | |||
| public Task<RestInviteMetadata> GetVanityInviteAsync(RequestOptions options = null) | |||
| => GuildHelper.GetVanityInviteAsync(this, Discord, options); | |||
| @@ -677,7 +758,7 @@ namespace Discord.WebSocket | |||
| /// </summary> | |||
| /// <param name="id">The snowflake identifier for the role.</param> | |||
| /// <returns> | |||
| /// A role that is associated with the specified <paramref name="id"/>; <c>null</c> if none is found. | |||
| /// A role that is associated with the specified <paramref name="id"/>; <see langword="null"/> if none is found. | |||
| /// </returns> | |||
| public SocketRole GetRole(ulong id) | |||
| { | |||
| @@ -699,7 +780,7 @@ namespace Discord.WebSocket | |||
| /// <param name="isHoisted">Whether the role is separated from others on the sidebar.</param> | |||
| /// <param name="isMentionable">Whether the role can be mentioned.</param> | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <exception cref="ArgumentNullException"><paramref name="name"/> is <c>null</c>.</exception> | |||
| /// <exception cref="ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception> | |||
| /// <returns> | |||
| /// A task that represents the asynchronous creation operation. The task result contains the newly created | |||
| /// role. | |||
| @@ -731,13 +812,13 @@ namespace Discord.WebSocket | |||
| /// <remarks> | |||
| /// This method retrieves a user found within this guild. | |||
| /// <note> | |||
| /// This may return <c>null</c> in the WebSocket implementation due to incomplete user collection in | |||
| /// This may return <see langword="null"/> in the WebSocket implementation due to incomplete user collection in | |||
| /// large guilds. | |||
| /// </note> | |||
| /// </remarks> | |||
| /// <param name="id">The snowflake identifier of the user.</param> | |||
| /// <returns> | |||
| /// A guild user associated with the specified <paramref name="id"/>; <c>null</c> if none is found. | |||
| /// A guild user associated with the specified <paramref name="id"/>; <see langword="null"/> if none is found. | |||
| /// </returns> | |||
| public SocketGuildUser GetUser(ulong id) | |||
| { | |||
| @@ -746,8 +827,8 @@ namespace Discord.WebSocket | |||
| return null; | |||
| } | |||
| /// <inheritdoc /> | |||
| public Task<int> PruneUsersAsync(int days = 30, bool simulate = false, RequestOptions options = null) | |||
| => GuildHelper.PruneUsersAsync(this, Discord, days, simulate, options); | |||
| public Task<int> PruneUsersAsync(int days = 30, bool simulate = false, RequestOptions options = null, IEnumerable<ulong> includeRoleIds = null) | |||
| => GuildHelper.PruneUsersAsync(this, Discord, days, simulate, options, includeRoleIds); | |||
| internal SocketGuildUser AddOrUpdateUser(UserModel model) | |||
| { | |||
| @@ -891,7 +972,7 @@ namespace Discord.WebSocket | |||
| /// <param name="options">The options to be used when sending the request.</param> | |||
| /// <returns> | |||
| /// A task that represents the asynchronous get operation. The task result contains the webhook with the | |||
| /// specified <paramref name="id"/>; <c>null</c> if none is found. | |||
| /// specified <paramref name="id"/>; <see langword="null"/> if none is found. | |||
| /// </returns> | |||
| public Task<RestWebhook> GetWebhookAsync(ulong id, RequestOptions options = null) | |||
| => GuildHelper.GetWebhookAsync(this, Discord, id, options); | |||
| @@ -914,7 +995,7 @@ namespace Discord.WebSocket | |||
| public Task<GuildEmote> CreateEmoteAsync(string name, Image image, Optional<IEnumerable<IRole>> roles = default(Optional<IEnumerable<IRole>>), RequestOptions options = null) | |||
| => GuildHelper.CreateEmoteAsync(this, Discord, name, image, roles, options); | |||
| /// <inheritdoc /> | |||
| /// <exception cref="ArgumentNullException"><paramref name="func"/> is <c>null</c>.</exception> | |||
| /// <exception cref="ArgumentNullException"><paramref name="func"/> is <see langword="null"/>.</exception> | |||
| public Task<GuildEmote> ModifyEmoteAsync(GuildEmote emote, Action<EmoteProperties> func, RequestOptions options = null) | |||
| => GuildHelper.ModifyEmoteAsync(this, Discord, emote.Id, func, options); | |||
| /// <inheritdoc /> | |||
| @@ -1133,11 +1214,21 @@ namespace Discord.WebSocket | |||
| /// <inheritdoc /> | |||
| ulong? IGuild.EmbedChannelId => EmbedChannelId; | |||
| /// <inheritdoc /> | |||
| ulong? IGuild.WidgetChannelId => WidgetChannelId; | |||
| /// <inheritdoc /> | |||
| ulong? IGuild.SystemChannelId => SystemChannelId; | |||
| /// <inheritdoc /> | |||
| ulong? IGuild.RulesChannelId => RulesChannelId; | |||
| /// <inheritdoc /> | |||
| ulong? IGuild.PublicUpdatesChannelId => PublicUpdatesChannelId; | |||
| /// <inheritdoc /> | |||
| IRole IGuild.EveryoneRole => EveryoneRole; | |||
| /// <inheritdoc /> | |||
| IReadOnlyCollection<IRole> IGuild.Roles => Roles; | |||
| /// <inheritdoc /> | |||
| int? IGuild.ApproximateMemberCount => null; | |||
| /// <inheritdoc /> | |||
| int? IGuild.ApproximatePresenceCount => null; | |||
| /// <inheritdoc /> | |||
| async Task<IReadOnlyCollection<IBan>> IGuild.GetBansAsync(RequestOptions options) | |||
| @@ -1177,12 +1268,22 @@ namespace Discord.WebSocket | |||
| Task<ITextChannel> IGuild.GetDefaultChannelAsync(CacheMode mode, RequestOptions options) | |||
| => Task.FromResult<ITextChannel>(DefaultChannel); | |||
| /// <inheritdoc /> | |||
| [Obsolete("This method is deprecated, use GetWidgetChannelAsync instead.")] | |||
| Task<IGuildChannel> IGuild.GetEmbedChannelAsync(CacheMode mode, RequestOptions options) | |||
| => Task.FromResult<IGuildChannel>(EmbedChannel); | |||
| /// <inheritdoc /> | |||
| Task<IGuildChannel> IGuild.GetWidgetChannelAsync(CacheMode mode, RequestOptions options) | |||
| => Task.FromResult<IGuildChannel>(WidgetChannel); | |||
| /// <inheritdoc /> | |||
| Task<ITextChannel> IGuild.GetSystemChannelAsync(CacheMode mode, RequestOptions options) | |||
| => Task.FromResult<ITextChannel>(SystemChannel); | |||
| /// <inheritdoc /> | |||
| Task<ITextChannel> IGuild.GetRulesChannelAsync(CacheMode mode, RequestOptions options) | |||
| => Task.FromResult<ITextChannel>(RulesChannel); | |||
| /// <inheritdoc /> | |||
| Task<ITextChannel> IGuild.GetPublicUpdatesChannelAsync(CacheMode mode, RequestOptions options) | |||
| => Task.FromResult<ITextChannel>(PublicUpdatesChannel); | |||
| /// <inheritdoc /> | |||
| async Task<ITextChannel> IGuild.CreateTextChannelAsync(string name, Action<TextChannelProperties> func, RequestOptions options) | |||
| => await CreateTextChannelAsync(name, func, options).ConfigureAwait(false); | |||
| /// <inheritdoc /> | |||
| @@ -0,0 +1,143 @@ | |||
| using Discord.Rest; | |||
| using System; | |||
| using System.Diagnostics; | |||
| using System.Threading.Tasks; | |||
| using Model = Discord.API.Gateway.InviteCreateEvent; | |||
| namespace Discord.WebSocket | |||
| { | |||
| [DebuggerDisplay(@"{DebuggerDisplay,nq}")] | |||
| public class SocketInvite : SocketEntity<string>, IInviteMetadata | |||
| { | |||
| private long _createdAtTicks; | |||
| /// <inheritdoc /> | |||
| public ulong ChannelId { get; private set; } | |||
| /// <summary> | |||
| /// Gets the channel where this invite was created. | |||
| /// </summary> | |||
| public SocketGuildChannel Channel { get; private set; } | |||
| /// <inheritdoc /> | |||
| public ulong? GuildId { get; private set; } | |||
| /// <summary> | |||
| /// Gets the guild where this invite was created. | |||
| /// </summary> | |||
| public SocketGuild Guild { get; private set; } | |||
| /// <inheritdoc /> | |||
| ChannelType IInvite.ChannelType | |||
| { | |||
| get | |||
| { | |||
| switch (Channel) | |||
| { | |||
| case IVoiceChannel voiceChannel: return ChannelType.Voice; | |||
| case ICategoryChannel categoryChannel: return ChannelType.Category; | |||
| case IDMChannel dmChannel: return ChannelType.DM; | |||
| case IGroupChannel groupChannel: return ChannelType.Group; | |||
| case INewsChannel newsChannel: return ChannelType.News; | |||
| case ITextChannel textChannel: return ChannelType.Text; | |||
| default: throw new InvalidOperationException("Invalid channel type."); | |||
| } | |||
| } | |||
| } | |||
| /// <inheritdoc /> | |||
| string IInvite.ChannelName => Channel.Name; | |||
| /// <inheritdoc /> | |||
| string IInvite.GuildName => Guild.Name; | |||
| /// <inheritdoc /> | |||
| int? IInvite.PresenceCount => throw new NotImplementedException(); | |||
| /// <inheritdoc /> | |||
| int? IInvite.MemberCount => throw new NotImplementedException(); | |||
| /// <inheritdoc /> | |||
| bool IInviteMetadata.IsRevoked => throw new NotImplementedException(); | |||
| /// <inheritdoc /> | |||
| public bool IsTemporary { get; private set; } | |||
| /// <inheritdoc /> | |||
| int? IInviteMetadata.MaxAge { get => MaxAge; } | |||
| /// <inheritdoc /> | |||
| int? IInviteMetadata.MaxUses { get => MaxUses; } | |||
| /// <inheritdoc /> | |||
| int? IInviteMetadata.Uses { get => Uses; } | |||
| /// <summary> | |||
| /// Gets the time (in seconds) until the invite expires. | |||
| /// </summary> | |||
| public int MaxAge { get; private set; } | |||
| /// <summary> | |||
| /// Gets the max number of uses this invite may have. | |||
| /// </summary> | |||
| public int MaxUses { get; private set; } | |||
| /// <summary> | |||
| /// Gets the number of times this invite has been used. | |||
| /// </summary> | |||
| public int Uses { get; private set; } | |||
| /// <summary> | |||
| /// Gets the user that created this invite if available. | |||
| /// </summary> | |||
| public SocketGuildUser Inviter { get; private set; } | |||
| /// <inheritdoc /> | |||
| DateTimeOffset? IInviteMetadata.CreatedAt => DateTimeUtils.FromTicks(_createdAtTicks); | |||
| /// <summary> | |||
| /// Gets when this invite was created. | |||
| /// </summary> | |||
| public DateTimeOffset CreatedAt => DateTimeUtils.FromTicks(_createdAtTicks); | |||
| /// <summary> | |||
| /// Gets the user targeted by this invite if available. | |||
| /// </summary> | |||
| public SocketUser TargetUser { get; private set; } | |||
| /// <summary> | |||
| /// Gets the type of the user targeted by this invite. | |||
| /// </summary> | |||
| public TargetUserType TargetUserType { get; private set; } | |||
| /// <inheritdoc /> | |||
| public string Code => Id; | |||
| /// <inheritdoc /> | |||
| public string Url => $"{DiscordConfig.InviteUrl}{Code}"; | |||
| internal SocketInvite(DiscordSocketClient discord, SocketGuild guild, SocketGuildChannel channel, SocketGuildUser inviter, SocketUser target, string id) | |||
| : base(discord, id) | |||
| { | |||
| Guild = guild; | |||
| Channel = channel; | |||
| Inviter = inviter; | |||
| TargetUser = target; | |||
| } | |||
| internal static SocketInvite Create(DiscordSocketClient discord, SocketGuild guild, SocketGuildChannel channel, SocketGuildUser inviter, SocketUser target, Model model) | |||
| { | |||
| var entity = new SocketInvite(discord, guild, channel, inviter, target, model.Code); | |||
| entity.Update(model); | |||
| return entity; | |||
| } | |||
| internal void Update(Model model) | |||
| { | |||
| ChannelId = model.ChannelId; | |||
| GuildId = model.GuildId.IsSpecified ? model.GuildId.Value : Guild.Id; | |||
| IsTemporary = model.Temporary; | |||
| MaxAge = model.MaxAge; | |||
| MaxUses = model.MaxUses; | |||
| Uses = model.Uses; | |||
| _createdAtTicks = model.CreatedAt.UtcTicks; | |||
| TargetUserType = model.TargetUserType.IsSpecified ? model.TargetUserType.Value : TargetUserType.Undefined; | |||
| } | |||
| /// <inheritdoc /> | |||
| public Task DeleteAsync(RequestOptions options = null) | |||
| => InviteHelper.DeleteAsync(this, Discord, options); | |||
| /// <summary> | |||
| /// Gets the URL of the invite. | |||
| /// </summary> | |||
| /// <returns> | |||
| /// A string that resolves to the Url of the invite. | |||
| /// </returns> | |||
| public override string ToString() => Url; | |||
| private string DebuggerDisplay => $"{Url} ({Guild?.Name} / {Channel.Name})"; | |||
| /// <inheritdoc /> | |||
| IGuild IInvite.Guild => Guild; | |||
| /// <inheritdoc /> | |||
| IChannel IInvite.Channel => Channel; | |||
| /// <inheritdoc /> | |||
| IUser IInviteMetadata.Inviter => Inviter; | |||
| } | |||
| } | |||
| @@ -46,6 +46,8 @@ namespace Discord.WebSocket | |||
| public virtual bool IsSuppressed => false; | |||
| /// <inheritdoc /> | |||
| public virtual DateTimeOffset? EditedTimestamp => null; | |||
| /// <inheritdoc /> | |||
| public virtual bool MentionedEveryone => false; | |||
| /// <inheritdoc /> | |||
| public MessageActivity Activity { get; private set; } | |||
| @@ -20,7 +20,9 @@ namespace Discord.WebSocket | |||
| private ImmutableArray<Attachment> _attachments = ImmutableArray.Create<Attachment>(); | |||
| private ImmutableArray<Embed> _embeds = ImmutableArray.Create<Embed>(); | |||
| private ImmutableArray<ITag> _tags = ImmutableArray.Create<ITag>(); | |||
| private ImmutableArray<SocketRole> _roleMentions = ImmutableArray.Create<SocketRole>(); | |||
| private ImmutableArray<SocketUser> _userMentions = ImmutableArray.Create<SocketUser>(); | |||
| /// <inheritdoc /> | |||
| public override bool IsTTS => _isTTS; | |||
| /// <inheritdoc /> | |||
| @@ -30,6 +32,8 @@ namespace Discord.WebSocket | |||
| /// <inheritdoc /> | |||
| public override DateTimeOffset? EditedTimestamp => DateTimeUtils.FromTicks(_editedTimestampTicks); | |||
| /// <inheritdoc /> | |||
| public override bool MentionedEveryone => _isMentioningEveryone; | |||
| /// <inheritdoc /> | |||
| public override IReadOnlyCollection<Attachment> Attachments => _attachments; | |||
| /// <inheritdoc /> | |||
| public override IReadOnlyCollection<Embed> Embeds => _embeds; | |||
| @@ -38,9 +42,9 @@ namespace Discord.WebSocket | |||
| /// <inheritdoc /> | |||
| public override IReadOnlyCollection<SocketGuildChannel> MentionedChannels => MessageHelper.FilterTagsByValue<SocketGuildChannel>(TagType.ChannelMention, _tags); | |||
| /// <inheritdoc /> | |||
| public override IReadOnlyCollection<SocketRole> MentionedRoles => MessageHelper.FilterTagsByValue<SocketRole>(TagType.RoleMention, _tags); | |||
| public override IReadOnlyCollection<SocketRole> MentionedRoles => _roleMentions; | |||
| /// <inheritdoc /> | |||
| public override IReadOnlyCollection<SocketUser> MentionedUsers => MessageHelper.FilterTagsByValue<SocketUser>(TagType.UserMention, _tags); | |||
| public override IReadOnlyCollection<SocketUser> MentionedUsers => _userMentions; | |||
| internal SocketUserMessage(DiscordSocketClient discord, ulong id, ISocketMessageChannel channel, SocketUser author, MessageSource source) | |||
| : base(discord, id, channel, author, source) | |||
| @@ -57,6 +61,8 @@ namespace Discord.WebSocket | |||
| { | |||
| base.Update(state, model); | |||
| SocketGuild guild = (Channel as SocketGuildChannel)?.Guild; | |||
| if (model.IsTextToSpeech.IsSpecified) | |||
| _isTTS = model.IsTextToSpeech.Value; | |||
| if (model.Pinned.IsSpecified) | |||
| @@ -69,6 +75,8 @@ namespace Discord.WebSocket | |||
| { | |||
| _isSuppressed = model.Flags.Value.HasFlag(API.MessageFlags.Suppressed); | |||
| } | |||
| if (model.RoleMentions.IsSpecified) | |||
| _roleMentions = model.RoleMentions.Value.Select(x => guild.GetRole(x)).ToImmutableArray(); | |||
| if (model.Attachments.IsSpecified) | |||
| { | |||
| @@ -98,28 +106,29 @@ namespace Discord.WebSocket | |||
| _embeds = ImmutableArray.Create<Embed>(); | |||
| } | |||
| IReadOnlyCollection<IUser> mentions = ImmutableArray.Create<SocketUnknownUser>(); //Is passed to ParseTags to get real mention collection | |||
| if (model.UserMentions.IsSpecified) | |||
| { | |||
| var value = model.UserMentions.Value; | |||
| if (value.Length > 0) | |||
| { | |||
| var newMentions = ImmutableArray.CreateBuilder<SocketUnknownUser>(value.Length); | |||
| var newMentions = ImmutableArray.CreateBuilder<SocketUser>(value.Length); | |||
| for (int i = 0; i < value.Length; i++) | |||
| { | |||
| var val = value[i]; | |||
| if (val.Object != null) | |||
| var guildUser = guild.GetUser(val.Id); | |||
| if (guildUser != null) | |||
| newMentions.Add(guildUser); | |||
| else if (val.Object != null) | |||
| newMentions.Add(SocketUnknownUser.Create(Discord, state, val.Object)); | |||
| } | |||
| mentions = newMentions.ToImmutable(); | |||
| _userMentions = newMentions.ToImmutable(); | |||
| } | |||
| } | |||
| if (model.Content.IsSpecified) | |||
| { | |||
| var text = model.Content.Value; | |||
| var guild = (Channel as SocketGuildChannel)?.Guild; | |||
| _tags = MessageHelper.ParseTags(text, Channel, guild, mentions); | |||
| _tags = MessageHelper.ParseTags(text, Channel, guild, _userMentions); | |||
| model.Content = text; | |||
| } | |||
| } | |||
| @@ -149,10 +158,10 @@ namespace Discord.WebSocket | |||
| => MentionUtils.Resolve(this, 0, userHandling, channelHandling, roleHandling, everyoneHandling, emojiHandling); | |||
| /// <inheritdoc /> | |||
| /// <exception cref="InvalidOperationException">This operation may only be called on a <see cref="SocketNewsChannel"/> channel.</exception> | |||
| /// <exception cref="InvalidOperationException">This operation may only be called on a <see cref="INewsChannel"/> channel.</exception> | |||
| public async Task CrosspostAsync(RequestOptions options = null) | |||
| { | |||
| if (!(Channel is SocketNewsChannel)) | |||
| if (!(Channel is INewsChannel)) | |||
| { | |||
| throw new InvalidOperationException("Publishing (crossposting) is only valid in news channels."); | |||
| } | |||
| @@ -33,7 +33,7 @@ namespace Discord.Webhook | |||
| : this(webhookUrl, new DiscordRestConfig()) { } | |||
| // regex pattern to match webhook urls | |||
| private static Regex WebhookUrlRegex = new Regex(@"^.*(discord|discordapp)\.com\/api\/webhooks\/([\d]+)\/([a-z0-9_-]+)$", RegexOptions.Compiled | RegexOptions.IgnoreCase); | |||
| private static Regex WebhookUrlRegex = new Regex(@"^.*(discord|discordapp)\.com\/api\/webhooks\/([\d]+)\/([a-z0-9_-]+)$", RegexOptions.Compiled | RegexOptions.IgnoreCase | RegexOptions.CultureInvariant); | |||
| /// <summary> Creates a new Webhook Discord client. </summary> | |||
| public DiscordWebhookClient(ulong webhookId, string webhookToken, DiscordRestConfig config) | |||
| @@ -74,12 +74,12 @@ namespace Discord.Webhook | |||
| _restLogger = LogManager.CreateLogger("Rest"); | |||
| ApiClient.RequestQueue.RateLimitTriggered += async (id, info) => | |||
| ApiClient.RequestQueue.RateLimitTriggered += async (id, info, endpoint) => | |||
| { | |||
| if (info == null) | |||
| await _restLogger.VerboseAsync($"Preemptive Rate limit triggered: {id?.ToString() ?? "null"}").ConfigureAwait(false); | |||
| await _restLogger.VerboseAsync($"Preemptive Rate limit triggered: {endpoint} {(id.IsHashBucket ? $"(Bucket: {id.BucketHash})" : "")}").ConfigureAwait(false); | |||
| else | |||
| await _restLogger.WarningAsync($"Rate limit triggered: {id?.ToString() ?? "null"}").ConfigureAwait(false); | |||
| await _restLogger.WarningAsync($"Rate limit triggered: {endpoint} {(id.IsHashBucket ? $"(Bucket: {id.BucketHash})" : "")}").ConfigureAwait(false); | |||
| }; | |||
| ApiClient.SentRequest += async (method, endpoint, millis) => await _restLogger.VerboseAsync($"{method} {endpoint}: {millis} ms").ConfigureAwait(false); | |||
| } | |||
| @@ -88,19 +88,21 @@ namespace Discord.Webhook | |||
| /// <summary> Sends a message to the channel for this webhook. </summary> | |||
| /// <returns> Returns the ID of the created message. </returns> | |||
| public Task<ulong> SendMessageAsync(string text = null, bool isTTS = false, IEnumerable<Embed> embeds = null, | |||
| string username = null, string avatarUrl = null, RequestOptions options = null) | |||
| => WebhookClientHelper.SendMessageAsync(this, text, isTTS, embeds, username, avatarUrl, options); | |||
| string username = null, string avatarUrl = null, RequestOptions options = null, AllowedMentions allowedMentions = null) | |||
| => WebhookClientHelper.SendMessageAsync(this, text, isTTS, embeds, username, avatarUrl, allowedMentions, options); | |||
| /// <summary> Sends a message to the channel for this webhook with an attachment. </summary> | |||
| /// <returns> Returns the ID of the created message. </returns> | |||
| public Task<ulong> SendFileAsync(string filePath, string text, bool isTTS = false, | |||
| IEnumerable<Embed> embeds = null, string username = null, string avatarUrl = null, RequestOptions options = null, bool isSpoiler = false) | |||
| => WebhookClientHelper.SendFileAsync(this, filePath, text, isTTS, embeds, username, avatarUrl, options, isSpoiler); | |||
| IEnumerable<Embed> embeds = null, string username = null, string avatarUrl = null, | |||
| RequestOptions options = null, bool isSpoiler = false, AllowedMentions allowedMentions = null) | |||
| => WebhookClientHelper.SendFileAsync(this, filePath, text, isTTS, embeds, username, avatarUrl, allowedMentions, options, isSpoiler); | |||
| /// <summary> Sends a message to the channel for this webhook with an attachment. </summary> | |||
| /// <returns> Returns the ID of the created message. </returns> | |||
| public Task<ulong> SendFileAsync(Stream stream, string filename, string text, bool isTTS = false, | |||
| IEnumerable<Embed> embeds = null, string username = null, string avatarUrl = null, RequestOptions options = null, bool isSpoiler = false) | |||
| => WebhookClientHelper.SendFileAsync(this, stream, filename, text, isTTS, embeds, username, avatarUrl, options, isSpoiler); | |||
| IEnumerable<Embed> embeds = null, string username = null, string avatarUrl = null, | |||
| RequestOptions options = null, bool isSpoiler = false, AllowedMentions allowedMentions = null) | |||
| => WebhookClientHelper.SendFileAsync(this, stream, filename, text, isTTS, embeds, username, avatarUrl, allowedMentions, options, isSpoiler); | |||
| /// <summary> Modifies the properties of this webhook. </summary> | |||
| public Task ModifyWebhookAsync(Action<WebhookProperties> func, RequestOptions options = null) | |||
| @@ -21,7 +21,7 @@ namespace Discord.Webhook | |||
| return RestInternalWebhook.Create(client, model); | |||
| } | |||
| public static async Task<ulong> SendMessageAsync(DiscordWebhookClient client, | |||
| string text, bool isTTS, IEnumerable<Embed> embeds, string username, string avatarUrl, RequestOptions options) | |||
| string text, bool isTTS, IEnumerable<Embed> embeds, string username, string avatarUrl, AllowedMentions allowedMentions, RequestOptions options) | |||
| { | |||
| var args = new CreateWebhookMessageParams(text) { IsTTS = isTTS }; | |||
| if (embeds != null) | |||
| @@ -30,19 +30,21 @@ namespace Discord.Webhook | |||
| args.Username = username; | |||
| if (avatarUrl != null) | |||
| args.AvatarUrl = avatarUrl; | |||
| if (allowedMentions != null) | |||
| args.AllowedMentions = allowedMentions.ToModel(); | |||
| var model = await client.ApiClient.CreateWebhookMessageAsync(client.Webhook.Id, args, options: options).ConfigureAwait(false); | |||
| return model.Id; | |||
| } | |||
| public static async Task<ulong> SendFileAsync(DiscordWebhookClient client, string filePath, string text, bool isTTS, | |||
| IEnumerable<Embed> embeds, string username, string avatarUrl, RequestOptions options, bool isSpoiler) | |||
| IEnumerable<Embed> embeds, string username, string avatarUrl, AllowedMentions allowedMentions, RequestOptions options, bool isSpoiler) | |||
| { | |||
| string filename = Path.GetFileName(filePath); | |||
| using (var file = File.OpenRead(filePath)) | |||
| return await SendFileAsync(client, file, filename, text, isTTS, embeds, username, avatarUrl, options, isSpoiler).ConfigureAwait(false); | |||
| return await SendFileAsync(client, file, filename, text, isTTS, embeds, username, avatarUrl, allowedMentions, options, isSpoiler).ConfigureAwait(false); | |||
| } | |||
| public static async Task<ulong> SendFileAsync(DiscordWebhookClient client, Stream stream, string filename, string text, bool isTTS, | |||
| IEnumerable<Embed> embeds, string username, string avatarUrl, RequestOptions options, bool isSpoiler) | |||
| IEnumerable<Embed> embeds, string username, string avatarUrl, AllowedMentions allowedMentions, RequestOptions options, bool isSpoiler) | |||
| { | |||
| var args = new UploadWebhookFileParams(stream) { Filename = filename, Content = text, IsTTS = isTTS, IsSpoiler = isSpoiler }; | |||
| if (username != null) | |||
| @@ -51,6 +53,8 @@ namespace Discord.Webhook | |||
| args.AvatarUrl = avatarUrl; | |||
| if (embeds != null) | |||
| args.Embeds = embeds.Select(x => x.ToModel()).ToArray(); | |||
| if(allowedMentions != null) | |||
| args.AllowedMentions = allowedMentions.ToModel(); | |||
| var msg = await client.ApiClient.UploadWebhookFileAsync(client.Webhook.Id, args, options).ConfigureAwait(false); | |||
| return msg.Id; | |||
| } | |||
| @@ -69,6 +69,7 @@ namespace Discord | |||
| AssertFlag(() => new GuildPermissions(manageGuild: true), GuildPermission.ManageGuild); | |||
| AssertFlag(() => new GuildPermissions(addReactions: true), GuildPermission.AddReactions); | |||
| AssertFlag(() => new GuildPermissions(viewAuditLog: true), GuildPermission.ViewAuditLog); | |||
| AssertFlag(() => new GuildPermissions(viewGuildInsights: true), GuildPermission.ViewGuildInsights); | |||
| AssertFlag(() => new GuildPermissions(viewChannel: true), GuildPermission.ViewChannel); | |||
| AssertFlag(() => new GuildPermissions(sendMessages: true), GuildPermission.SendMessages); | |||
| AssertFlag(() => new GuildPermissions(sendTTSMessages: true), GuildPermission.SendTTSMessages); | |||
| @@ -141,6 +142,7 @@ namespace Discord | |||
| AssertUtil(GuildPermission.ManageGuild, x => x.ManageGuild, (p, enable) => p.Modify(manageGuild: enable)); | |||
| AssertUtil(GuildPermission.AddReactions, x => x.AddReactions, (p, enable) => p.Modify(addReactions: enable)); | |||
| AssertUtil(GuildPermission.ViewAuditLog, x => x.ViewAuditLog, (p, enable) => p.Modify(viewAuditLog: enable)); | |||
| AssertUtil(GuildPermission.ViewGuildInsights, x => x.ViewGuildInsights, (p, enable) => p.Modify(viewGuildInsights: enable)); | |||
| AssertUtil(GuildPermission.ViewChannel, x => x.ViewChannel, (p, enable) => p.Modify(viewChannel: enable)); | |||
| AssertUtil(GuildPermission.SendMessages, x => x.SendMessages, (p, enable) => p.Modify(sendMessages: enable)); | |||
| AssertUtil(GuildPermission.SendTTSMessages, x => x.SendTTSMessages, (p, enable) => p.Modify(sendTTSMessages: enable)); | |||
| @@ -83,7 +83,7 @@ namespace Discord | |||
| public void BotTokenDoesNotThrowExceptions(string token) | |||
| { | |||
| // This example token is pulled from the Discord Docs | |||
| // https://discordapp.com/developers/docs/reference#authentication-example-bot-token-authorization-header | |||
| // https://discord.com/developers/docs/reference#authentication-example-bot-token-authorization-header | |||
| // should not throw any exception | |||
| TokenUtils.ValidateToken(TokenType.Bot, token); | |||
| } | |||
| @@ -12,18 +12,18 @@ namespace Discord | |||
| public class DiscordWebhookClientTests | |||
| { | |||
| [Theory] | |||
| [InlineData("https://discordapp.com/api/webhooks/123412347732897802/_abcde123456789-ABCDEFGHIJKLMNOP12345678-abcdefghijklmnopABCDEFGHIJK", | |||
| [InlineData("https://discord.com/api/webhooks/123412347732897802/_abcde123456789-ABCDEFGHIJKLMNOP12345678-abcdefghijklmnopABCDEFGHIJK", | |||
| 123412347732897802, "_abcde123456789-ABCDEFGHIJKLMNOP12345678-abcdefghijklmnopABCDEFGHIJK")] | |||
| // ptb, canary, etc will have slightly different urls | |||
| [InlineData("https://ptb.discordapp.com/api/webhooks/123412347732897802/_abcde123456789-ABCDEFGHIJKLMNOP12345678-abcdefghijklmnopABCDEFGHIJK", | |||
| [InlineData("https://ptb.discord.com/api/webhooks/123412347732897802/_abcde123456789-ABCDEFGHIJKLMNOP12345678-abcdefghijklmnopABCDEFGHIJK", | |||
| 123412347732897802, "_abcde123456789-ABCDEFGHIJKLMNOP12345678-abcdefghijklmnopABCDEFGHIJK")] | |||
| [InlineData("https://canary.discordapp.com/api/webhooks/123412347732897802/_abcde123456789-ABCDEFGHIJKLMNOP12345678-abcdefghijklmnopABCDEFGHIJK", | |||
| [InlineData("https://canary.discord.com/api/webhooks/123412347732897802/_abcde123456789-ABCDEFGHIJKLMNOP12345678-abcdefghijklmnopABCDEFGHIJK", | |||
| 123412347732897802, "_abcde123456789-ABCDEFGHIJKLMNOP12345678-abcdefghijklmnopABCDEFGHIJK")] | |||
| // don't care about https | |||
| [InlineData("http://canary.discordapp.com/api/webhooks/123412347732897802/_abcde123456789-ABCDEFGHIJKLMNOP12345678-abcdefghijklmnopABCDEFGHIJK", | |||
| [InlineData("http://canary.discord.com/api/webhooks/123412347732897802/_abcde123456789-ABCDEFGHIJKLMNOP12345678-abcdefghijklmnopABCDEFGHIJK", | |||
| 123412347732897802, "_abcde123456789-ABCDEFGHIJKLMNOP12345678-abcdefghijklmnopABCDEFGHIJK")] | |||
| // this is the minimum that the regex cares about | |||
| [InlineData("discordapp.com/api/webhooks/123412347732897802/_abcde123456789-ABCDEFGHIJKLMNOP12345678-abcdefghijklmnopABCDEFGHIJK", | |||
| [InlineData("discord.com/api/webhooks/123412347732897802/_abcde123456789-ABCDEFGHIJKLMNOP12345678-abcdefghijklmnopABCDEFGHIJK", | |||
| 123412347732897802, "_abcde123456789-ABCDEFGHIJKLMNOP12345678-abcdefghijklmnopABCDEFGHIJK")] | |||
| public void TestWebhook_Valid(string webhookurl, ulong expectedId, string expectedToken) | |||
| { | |||
| @@ -48,7 +48,7 @@ namespace Discord | |||
| [Theory] | |||
| [InlineData("123412347732897802/_abcde123456789-ABCDEFGHIJKLMNOP12345678-abcdefghijklmnopABCDEFGHIJK")] | |||
| // trailing slash | |||
| [InlineData("https://discordapp.com/api/webhooks/123412347732897802/_abcde123456789-ABCDEFGHIJKLMNOP12345678-abcdefghijklmnopABCDEFGHIJK/")] | |||
| [InlineData("https://discord.com/api/webhooks/123412347732897802/_abcde123456789-ABCDEFGHIJKLMNOP12345678-abcdefghijklmnopABCDEFGHIJK/")] | |||
| public void TestWebhook_Invalid(string webhookurl) | |||
| { | |||
| Assert.Throws<ArgumentException>(() => | |||