40844b9e13
* WIP commit, update IActivity and IUser with missing types * incomplete implementation of interfaces * Add implementation of activity flags, and extension method to check flag * remove usings that were not required * clean up files and add documentation where missing * remove unused usings * Add remark saying that premium_type info may be inaccessible to bots it seems that this information can not be accessed by any user, and may require the identity oauth scope * Add locale property to the user model adds the locale property to the user model, which appears not to be specified for bots * rename ActivityFlags * Add incomplete xmldoc to ActivityFlag Added xmldoc to the ActivityFlag type, excluded flags that i was unsure about * rename the UserFlags file * Add incomplete xmldoc to UserFlag enum * Remove unnecessary extension methods and use built-in functionality * use <c> tag for xmldoc 'null's * Add xmldoc for JoinRequest ActivityFlag * improve the PremiumType xmldoc * Add zero activityflag * Add summary tag verbs, example of IUser locale * Rename Flag enum types to use Properties suffix * Expose the details field in the Game model * update Activity extension methods to support Details field * Use inherited Details implementation in RichGame * lint: remove commented out code from debugging * Fix issue in previous commit * Move oauth-only user fields to SelfUser classes Moves the implementation of the Flags, PremiumType, and Locale user fields to ISelfUser classes. In testing, it seemed that normal bot accounts did not have this information supplied to them. When tested with a Bearer token in the Rest client, these fields are set. * remove old HypeSquadEvents flag that appears to have been replaced with the new HypeSquad flags
Discord.Net
An unofficial .NET API Wrapper for the Discord client (http://discordapp.com).
Check out the documentation or join the Discord API Chat.
Installation
Stable (NuGet)
Our stable builds available from NuGet through the Discord.Net metapackage:
The individual components may also be installed from NuGet:
Unstable (MyGet)
Nightly builds are available through our MyGet feed (https://www.myget.org/F/discord-net/api/v3/index.json).
Compiling
In order to compile Discord.Net, you require the following:
Using Visual Studio
The .NET Core workload must be selected during Visual Studio installation.
Using Command Line
Known Issues
WebSockets (Win7 and earlier)
.NET Core 1.1 does not support WebSockets on Win7 and earlier. This issue has been fixed since the release of .NET Core 2.1. It is recommended to target .NET Core 2.1 or above for your project if you wish to run your bot on legacy platforms; alternatively, you may choose to install the Discord.Net.Providers.WS4Net package.
Versioning Guarantees
This library generally abides by Semantic Versioning. Packages are published in MAJOR.MINOR.PATCH version format.
An increment of the PATCH component always indicates that an internal-only change was made, generally a bugfix. These changes will not affect the public-facing API in any way, and are always guaranteed to be forward- and backwards-compatible with your codebase, any any pre-compiled dependencies of your codebase.
An increment of the MINOR component indicates that some addition was made to the library, and this addition is not backwards-compatible with prior versions. However, Discord.Net does not guarantee forward-compatibility on minor additions. In other words, we permit a limited set of breaking changes on a minor version bump.
Due to the nature of the Discord API, we will oftentimes need to add a property to an entity to support the latest API changes. Discord.Net provides interfaces as a method of consuming entities; and as such, introducing a new field to an entity is technically a breaking change. Major version bumps generally indicate some major change to the library, and as such we are hesitant to bump the major version for every minor addition to the library. To compromise, we have decided that interfaces should be treated as consumable only, and your applications should typically not be implementing interfaces. (For applications where interfaces are implemented, such as in test mocks, we apologize for this inconsistency with SemVer).
Furthermore, while we will never break the API (outside of interface changes) on minor builds, we will occasionally need to break the ABI, by introducing parameters to a method to match changes upstream with Discord. As such, a minor version increment may require you to recompile your code, and dependencies, such as addons, may also need to be recompiled and republished on the newer version. When a binary breaking change is made, the change will be noted in the release notes.
An increment of the MAJOR component indicates that breaking changes have been made to the library; consumers should check the release notes to determine what changes need to be made.