You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.

CHANGELOG.md 19 kB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319
  1. # Changelog
  2. ## [2.2.0] - 2020-04-16
  3. ### Added
  4. - #1247 Implement Client Status Support (9da11b4)
  5. - #1310 id overload for RemoveReactionAsync (c88b1da)
  6. - #1319 BOOST (faf23de)
  7. - #1326 Added a Rest property to DiscordShardedClient (9fede34)
  8. - #1348 Add Quote Formatting (265da99)
  9. - #1354 Add support for setting X-RateLimit-Precision (9482204)
  10. - #1355 Provide ParameterInfo with error ParseResult (3755a02)
  11. - #1357 add the "Stream" permission. (b00da3d)
  12. - #1358 Add ChannelFollowAdd MessageType (794eba5)
  13. - #1369 Add SelfStream voice state property (9bb08c9)
  14. - #1372 support X-RateLimit-Reset-After (7b9029d)
  15. - #1373 update audit log models (c54867f)
  16. - #1377 Support filtering audit log entries on user, action type, and before entry id (68eb71c)
  17. - #1386 support guild subscription opt-out (0d54207)
  18. - #1387 #1381 Guild PreferredLocale support (a61adb0)
  19. - #1406 CustomStatusGame Activity (79a0ea9)
  20. - #1413 Implemented Message Reference Property (f86c39d)
  21. - #1414 add StartedAt, EndsAt, Elapsed and Remaining to SpotifyGame. (2bba324)
  22. - #1432 Add ability to modify the banner for guilds (d734ce0)
  23. - suppress messages (cd28892)
  24. ### Fixed
  25. - #1318 #1314 Don't parse tags within code blocks (c977f2e)
  26. - #1333 Remove null coalescing on ToEmbedBuilder Color (120c0f7)
  27. - #1337 Fixed attempting to access a non-present optional value (4edda5b)
  28. - #1346 CommandExecuted event will fire when a parameter precondition fails like what happens when standard precondition fails. (e8cb031)
  29. - #1371 Fix keys of guild update audit (b0a595b)
  30. - #1375 Use double precision for X-Reset-After, set CultureInfo when parsing numeric types (606dac3)
  31. - #1392 patch todo in NamedTypeReader (0bda8a4)
  32. - #1405 add .NET Standard 2.1 support for Color (7f0c0c9)
  33. - #1412 GetUsersAsync to use MaxUsersPerBatch const as limit instead of MaxMessagesPerBatch. (5439cba)
  34. - #1416 false-positive detection of CustomStatusGame based on Id property (a484651)
  35. - #1418 #1335 Add isMentionable parameter to CreateRoleAsync in non-breaking manner (1c63fd4)
  36. - #1421 (3ff4e3d)
  37. - include MessageFlags and SuppressEmbedParams (d6d4429)
  38. ### Changed
  39. - #1368 Update ISystemMessage interface to allow reactions (07f4d5f)
  40. - #1417 fix #1415 Re-add support for overwrite permissions for news channels (e627f07)
  41. - use millisecond precision by default (bcb3534)
  42. ### Misc
  43. - #1290 Split Unit and Integration tests into separate projects (a797be9)
  44. - #1328 Fix #1327 Color.ToString returns wrong value (1e8aa08)
  45. - #1329 Fix invalid cref values in docs (363d1c6)
  46. - #1330 Fix spelling mistake in ExclusiveBulkDelete warning (c864f48)
  47. - #1331 Change token explanation (0484fe8)
  48. - #1349 Fixed a spelling error. (af79ed5)
  49. - #1353 [ci skip] Removed duplicate "any" from the readme (15b2a36)
  50. - #1359 Fixing GatewayEncoding comment (52565ed)
  51. - #1379 September 2019 Documentation Update (fd3810e)
  52. - #1382 Fix .NET Core 3.0 compatibility + Drop NS1.3 (d199d93)
  53. - #1388 fix coercion error with DateTime/Offset (3d39704)
  54. - #1393 Utilize ValueTuples (99d7135)
  55. - #1400 Fix #1394 Misworded doc for command params args (1c6ee72)
  56. - #1401 Fix package publishing in azure pipelines (a08d529)
  57. - #1402 Fix packaging (65223a6)
  58. - #1403 Cache regex instances in MessageHelper (007b011)
  59. - #1424 Fix the Comparer descriptions not linking the type (911523d)
  60. - #1426 Fix incorrect and missing colour values for Color fields (9ede6b9)
  61. - #1470 Added System.Linq reference (adf823c)
  62. - temporary sanity checking in SocketGuild (c870e67)
  63. - build and deploy docs automatically (2981d6b)
  64. - 2.2.0 (4b602b4)
  65. - target the Process env-var scope (3c6b376)
  66. - fix metapackage build (1794f95)
  67. - copy only _site to docs-static (a8cdadc)
  68. - do not exit on failed robocopy (fd204ee)
  69. - add idn debugger (91aec9f)
  70. - rename IsStream to IsStreaming (dcd9cdd)
  71. - feature (40844b9)
  72. ## [2.1.1] - 2019-06-08
  73. ### Fixed
  74. - #994: Remainder parameters now ignore character escaping, as there is no reason to escape characters here (2e95c49)
  75. - #1316: `Emote.Equals` now pays no respect to the Name property, since Discord's API does not care about an emote's name (abf3e90)
  76. - #1317: `Emote.GetHashCode` now pays no respect to the Name property, see above (1b54883)
  77. - #1323: Optionals will no longer claim to be specified when a reaction message was not cached (1cc5d73)
  78. - Log messages sourcing from REST events will no longer be raised twice (c78a679)
  79. - News embeds will be processed as `EmbedType.Unknown`, rather than throwing an error and dropping the message (d287ed1)
  80. ### Changed
  81. - #1311: Members may now be disconnected from voice channels by passing `null` as `GuildUserProperties.Channel` (fc48c66)
  82. - #1313: `IMessage.Tags` now includes the EveryoneRole on @everyone and @here mentions (1f55f01)
  83. - #1320: The maximum value for setting slow-mode has been updated to 6 hours, per the new API limit (4433ca7)
  84. ### Misc
  85. - This library's compatibility with Semantic Versioning has been clarified. Please see the README (4d7de17)
  86. - The depency on System.Interactive.Async has been bumped to `3.2.0` (3e65e03)
  87. ## [2.1.0] - 2019-05-18
  88. ### Added
  89. - #1236: Bulk deletes (for messages) may now be accessed via the `MessagesBulkDeleted` event (dec353e)
  90. - #1240: OAuth applications utilizing the `guilds.join` scope may now add users to guilds through any client (1356ea9)
  91. - #1255: Message and attachment spoilers may now be set or detected (f3b20b2)
  92. - #1260: DiscordWebhookClient may be created from a Webhook URL (f2113c7)
  93. - #1261: A `GetCategoryChannel` helper may now be used to retrieve category channels directly from socket guilds (e03c527)
  94. - #1263: "user joined the guild" messages are now supported (00d3f5a)
  95. - #1271: AuthorID may now be retrieved from message delete audit log entries (1ae4220)
  96. - #1293: News Channels are now supported 📰 (9084c42)
  97. - `ExclusiveBulkDelete` configuration setting can be used to control bulk delete event behavior (03e6401)
  98. ### Removed
  99. - #1294: The `IGuildUser` overload of `EmbedBuilder.WithAuthor` no longer exists (b52b54d)
  100. ### Fixed
  101. - #1256: Fetching audit logs no longer raises null reference exceptions when a webhook has been deleted (049b014)
  102. - #1268: Null reference exceptions on `MESSAGE_CREATE` concerning partial member objects no longer occur (377622b)
  103. - #1278: The token validator now internally pads tokens to the proper length (48b327b)
  104. - #1292: Messages now properly initialize empty collections (b2ebc03)
  105. - The `DiscordSocketRestClient` is now properly initialized (a44c13a)
  106. - Exceptions in event handlers are now always logged (f6e3200)
  107. ### Changed
  108. - #1305: Token validation will fail when tokens contain whitespace (bb61efa)
  109. ### Misc
  110. - #1241: Added documentation samples for Webhooks (655a006)
  111. - #1243: Happy new year 🎉 (0275f7d)
  112. - #1257: Improved clarity in comments in the command samples (2473619)
  113. - #1276: Documentation uses a relative path for the logo asset (b80f0e8)
  114. - #1303: EmbedBuilder documentation now builds in the correct spot (51618e6)
  115. - #1304: Updated documentation (4309550)
  116. - CI for this project is now powered by Azure DevOps (this is not a sponsored message 🚀) (9b2bc18)
  117. - IDisposableAnalyzers should now be a development dependency (8003ac8)
  118. ## [2.0.1] - 2019-01-04
  119. ### Fixed
  120. - #1226: Only escape the closing quotation mark of non-remainder strings (65b8c09)
  121. - Commands with async RunModes will now propagate exceptions up to CommandExecuted (497918e)
  122. ### Misc
  123. - #1225: Commands sample no longer hooks the log event twice (552f34c)
  124. - #1227: The logo on the docs index page should scale responsively (d39bf6e)
  125. - #1230: Replaced precondition sample on docs (feed4fd)
  126. ## [2.0.0] - 2018-12-28
  127. ### Added
  128. - #747: `CommandService` now has a `CommandExecuted` event (e991715)
  129. - #765: Parameters may have a name specified via `NameAttribute` (9c81ab9)
  130. - #773: Both socket clients inherit from `BaseSocketClient` (9b7afec)
  131. - #785: Primitives now automatically load a NullableTypeReader (cb0ff78)
  132. - #819: Support for Welcome Message channels (30e867a)
  133. - #835: Emoji may now be managed from a bot (b4bf046)
  134. - #843: Webhooks may now be managed from a bot (7b2ddd0)
  135. - #863: An embed may be converted to an `EmbedBuilder` using the `.ToEmbedBuilder()` method (5218e6b)
  136. - #877: Support for reading rich presences (34b4e5a)
  137. - #888: Users may now opt-in to using a proxy (678a723)
  138. - #906: API Analyzers to assist users when writing their bot (f69ef2a)
  139. - #907: Full support for channel categories (030422f)
  140. - #913: Animated emoji may be read and written (a19ff18)
  141. - #915: Unused parameters may be discarded, rather than failing the command (5f46aef)
  142. - #929: Standard EqualityComparers for use in LINQ operations with the library's entities (b5e7548)
  143. - #934: Modules now contain an `OnModuleBuilding` method, which is invoked when the module is built (bb8ebc1)
  144. - #952: Added 'All' permission set for categories (6d58796)
  145. - #957: Ratelimit related objects now include request information (500f5f4)
  146. - #962: Add `GetRecommendedShardCountAsync` (fc5e70c)
  147. - #970: Add Spotify track support to user Activities (64b9cc7)
  148. - #973: Added `GetDefaultAvatarUrl` to user (109f663)
  149. - #978: Embeds can be attached alongside a file upload (e9f9b48)
  150. - #984, #1089: `VoiceServerUpdate` events are now publically accessible (e775853, 48fed06)
  151. - #996: Added `DeleteMessageAsync` to `IMessageChannel` (bc6009e)
  152. - #1005: Added dedicated `TimeSpan` TypeReader which "doesn't suck" (b52af7a)
  153. - #1009: Users can now specify the replacement behavior or default typereaders (6b7c6e9)
  154. - #1020: Users can now specify parameters when creating channels (bf5275e)
  155. - #1030: Added `IsDeprecated`, `IsCustom` properties to `VoiceRegion` (510f474)
  156. - #1037: Added `SocketUser.MutualGuilds`, various extension methods to commands (637d9fc)
  157. - #1043: `Discord.Color` is now compatible with `System.Drawing.Color` (c275e57)
  158. - #1055: Added audit logs (39dffe8)
  159. - #1056: Added `GetBanAsync` (97c8931)
  160. - #1102: Added `GetJumpUrl()` to messages (afc3a9d)
  161. - #1123: Commands can now accept named parameters (419c0a5)
  162. - #1124: Preconditions can now set custom error messages (5677f23)
  163. - #1126: `Color` now has equality (a2d8800)
  164. - #1159: Guild channels can now by synced with their parent category (5ea1fb3)
  165. - #1165: Bring Guild and Message models up to date with the API (d30d122)
  166. - #1166: Added `GetVoiceRegionsAsync` to `IGuild` (00717cf)
  167. - #1183: Added Add Guild Member endpoint for OAuth clients (8ef5f81)
  168. - #1196: Channel position can now be specified when creating a channel (a64ab60)
  169. - #1198: The Socket client can now access its underlying REST client (65afd37)
  170. - #1213: Added `GuildEmote#CreatorId` (92bf836)
  171. - 'html' variant added to the `EmbedType` enum (42c879c)
  172. - Modules can now be nested in non-module classes (4edbd8d)
  173. - Added `BanAsync` to guild members (1905fde)
  174. - Added the permisison bit for priority speaker (c1d7818)
  175. - All result types can use `FromError` (748e92b)
  176. - Added support for reading/writing slow mode (97d17cf)
  177. - Added markdown format for URLs (f005af3)
  178. - Reactions can now be added to messages in bulk (5421df1)
  179. ### Fixed
  180. - #742: `DiscordShardedClient#GetGuildFor` will now direct null guilds to Shard 0 (d5e9d6f)
  181. - #743: Various issues with permissions and inheritance of permissions (f996338)
  182. - #755: `IRole.Mention` will correctly tag the @everyone role (6b5a6e7)
  183. - #768: `CreateGuildAsync` will include the icon stream (865080a)
  184. - #866: Revised permissions constants and behavior (dec7cb2)
  185. - #872: Bulk message deletion should no longer fail for incomplete batch sizes (804d918)
  186. - #923: A null value should properly reset a user's nickname (227f61a)
  187. - #938: The reconnect handler should no longer deadlock during Discord outages (73ac9d7)
  188. - #941: Fix behavior of OverrideTypeReader (170a2e0)
  189. - #945: Fix properties on SocketCategoryChannel (810f6d6)
  190. - #959: Webhooks now use the correct parameter when assigning to the Avatar URL (8876597)
  191. - #966: Correct the implementation of HasFlag and ResolveChannel in permissions (32ebdd5)
  192. - #968: Add missing parameter in WebSocket4Net constructor (8537924)
  193. - #981: Enforce a maximum value when parsing timestamps from Discord (bfaa6fc)
  194. - #993: Null content will no longer null-ref on message sends/edits (55299ff)
  195. - #1003: Fixed ordering of parameters in permissions classes (a06e212)
  196. - #1010: EmbedBuilder no longer produces mutable embeds (2988b38)
  197. - #1012: `Embed.Length` should now yield the correct results (a3ce80c)
  198. - #1017: GetReactionUsersAsync includes query parameters (9b29c00)
  199. - #1022: GetReactionUsersAsync is now correctly paginated (79811d0)
  200. - #1023: Fix/update invite-related behaviors (7022149)
  201. - #1031: Messages with no guild-specific data should no longer be lost (3631886)
  202. - #1036: Fixed cases where `RetryMode.RetryRatelimit` were ignored (c618cb3)
  203. - #1044: Populate the guild in `SocketWebhookUser` (6a7810b)
  204. - #1048: The REST client will now create a full GuildUser object (033d312)
  205. - #1049: Fixed null-ref in `GetShardIdFor` (7cfed7f)
  206. - #1059: Include 'view channel' in voice channel's All permissions set (e764daf)
  207. - #1083: Default type readers will now be properly replaced (4bc06a0)
  208. - #1093: Fixed race condition in audio client authentication (322d46e)
  209. - #1139: Fixed consistency in exceptions (9e9a11d)
  210. - #1151: `GetReactionUsersAsync` now uses the correct pagination constant (c898325)
  211. - #1163: Reaction ratelimits are now placed in the same bucket, treated correctly (5ea1fb3)
  212. - #1186: Webhooks can now send files with embeds correctly (c1d5152)
  213. - #1192: CommandExecuted no longer fires twice for RuntimeResults (10233f3)
  214. - #1195: Channel Create audit log events properly deserialize (dca6c33)
  215. - #1202: The UDP client should no longer be used after disposed (ccb16e4)
  216. - #1203: The Audio client should no longer lock up on disconnect (2c93363)
  217. - #1209: MessageUpdated should no longer pass a null after object (91e0f03)
  218. - Ignore messages with no ID in bulk delete (676be40)
  219. - No longer attempt to load generic types as modules (b1eaa44)
  220. - No longer complain when a `PRESENCES_REPLACE` update is received (beb3d46)
  221. - CommandExecuted will be raised on async exception failures (6260749)
  222. - ExecuteResult now contains the entire exception, not an abridged message (f549da5)
  223. - CommandExecuted will no longer be raised twice for exceptions (aec7105)
  224. - The default WebSocket will now close correctly (ac389f5)
  225. ### Changed
  226. - #731: `IUserMessage#GetReactionUsersAsync` now takes an `IEmote` instead of a `string` (5d7f2fc)
  227. - #744: IAsyncEnumerable has been redesigned (5bbd9bb)
  228. - #777: `IGuild#DefaultChannel` will now resolve the first accessible channel, per changes to Discord (1ffcd4b)
  229. - #781: Attempting to add or remove a member's EveryoneRole will throw (506a6c9)
  230. - #801: `EmbedBuilder` will no longer implicitly convert to `Embed`, you must build manually (94f7dd2)
  231. - #804: Command-related tasks will have the 'async' suffix (14fbe40)
  232. - #812: The WebSocket4Net provider has been bumped to version 0.15, allowing support for .NET Standard apps (e25054b)
  233. - #829: DeleteMessagesAsync moved from IMessageChannel to ITextChannel (e00f17f)
  234. - #853: WebSocket will now use `zlib-stream` compression (759db34)
  235. - #874: The `ReadMessages` permission is moving to `ViewChannel` (edfbd05)
  236. - #877: Refactored Games into Activities (34b4e5a)
  237. - #943: Multiple types of quotation marks can now be parsed (thanks 🍎) (cee71ef)
  238. - #955: The `GameParty` model will now use long values (178ea8d)
  239. - #986: Expose the internal entity TypeReaders (660fec0)
  240. - #992: Throw an exception when trying to modify someone else's message (d50fc3b)
  241. - #998: Commands can specify their own `IgnoreExtraArgs` behavior (6d30100)
  242. - #1033: The `ReadMessages` permission bit is now named `ViewChannel` (5f084ad)
  243. - #1042: Content parameter of `SendMessageAsync` is now optional (0ba8b06)
  244. - #1057: An audio channel's `ConnectAsync` now allows users to handle the voice connection elsewhere, such as in Lavalink (890904f)
  245. - #1094: Overhauled invites, added vanity invite support (ffe994a)
  246. - #1108: Reactions now use the undocumented 1/.25 ratelimit, making them 4x faster (6b21b11)
  247. - #1128: Bot tokens will now be validated for common mishaps before use (2de6cef)
  248. - #1140: Check the invite `maxAge` parameter before making the request (649a779)
  249. - #1164: All command results will now be raised in `CommandExecuted` (10f67a8)
  250. - #1171: Clients have been changed to properly make use of `IDisposable` (7366cd4)
  251. - #1172: Invite related methods were moved from `IGuildChannel` to `INestedChannel` (a3f5e0b)
  252. - #1200: HasPrefix extensions now check for null values first (46e2674)
  253. - `IGuildChannel#Nsfw` moved to `ITextChannel`, now maps to the API property (608bc35)
  254. - Preemptive ratelimits are now logged under verbose, rather than warning. (3c1e766)
  255. - The default InviteAge when creating Invites is now 24 hours (9979a02)
  256. - All parameters to `ReplyAsync` have been made optional (b38dca7)
  257. - The socket client will now use additional fields to fill in member/guild information on messages (8fb2c71)
  258. - The Audio Client now uses Voice WS v3 (9ba38d7)
  259. ### Removed
  260. - #790: Redundant overloads for `AddField` removed from EmbedBuilder (479361b)
  261. - #925: RPC is no longer being maintained nor packaged (b30af57)
  262. - #958: Remove support for user tokens (2fd4f56)
  263. - User logins (including selfbots) are no longer supported (fc5adca)
  264. ### Misc
  265. - #786: Unit tests for the Color structure (22b969c)
  266. - #828: We now include a contributing guide (cd82a0f)
  267. - #876: We now include a standard editorconfig (5c8c784)
  268. - #963: Docs now include a release version, build instructions (88e6244)
  269. - #964: Fix documentation spelling of 'echoes' (fda19b5)
  270. - #967: Unit test permissions (63e6704)
  271. - #968: Bumped version of WebSocket4Net to 0.15.2 (8537924)
  272. - #972: Include sample bots in the source repository (217ec34)
  273. - #1046: We now support .NET Standard 2.0 (bbbac85)
  274. - #1114: Various performance optimizations (82cfdff)
  275. - #1149: The CI will now test on Ubuntu as well as Windows (674a0fc)
  276. - #1161: The entire documentation has been rewritten, all core entities were docstringed (ff0fea9)
  277. - #1175: Documentation changes in command samples (fb8dbca)
  278. - #1177: Added documentation for sharded bots (00097d3)
  279. - #1219: The project now has a logo! 🎉 (5750c3e)
  280. - This project is now licensed to the Discord.Net contributors (710e182)
  281. - Added templates for pull requests (f2ddf51)
  282. - Fixed documentation layout for the logo (bafdce4)
  283. ## [1.0.2] - 2017-09-09
  284. ### Fixed
  285. - Guilds utilizing Channel Categories will no longer crash bots on the `READY` event.
  286. ## [1.0.1] - 2017-07-05
  287. ### Fixed
  288. - #732: Fixed parameter preconditions not being loaded from class-based modules (b6dcc9e)
  289. - #726: Fixed CalculateScore throwing an ArgumentException for missing parameters (7597cf5)
  290. - EmbedBuilder URI validation should no longer throw NullReferenceExceptions in certain edge cases (d89804d)
  291. - Fixed module auto-detection for nested modules (d2afb06)
  292. ### Changed
  293. - ShardedCommandContext now inherits from SocketCommandContext (8cd99be)