docs: Documentation December Update (#1218)
* Fix broken link (#11) * Fix typos and improve wording * Add information for IGuildUser + Add GetPermission sample + Add ModifyAsync remarks * Add information for IGuildChannel + Add ModifyAsync remarks + Add GetOverwritePermissionAsync examples * Add warning for Direction.Around * Fix indentations and references * Move IRole.ModifyAsync sample * Add information for IUser + Add example, remarks for Get(Default)AvatarUrl + Add example, remarks for GetOrCreateDMChannelAsync + Add missing remarks/summary/returns for other properties of the class * Change verbs used in IVoiceState summary/remarks * Add additional explanation for IGuildUser.RoleIds * Change verbs used in IMessage summary/remarks * Clarify IUserMessage Add/RemoveReactionAsync samples * Fix command handler sample typo * Add information for DiscordSocketConfig + Add remarks/example to the class + Add remarks to AlwaysDownloadUsers * Fix documentation for SlowMode * Add additional remarks for Guild/TextChannelProperties * Update DocFx.Plugins.LastModified to v1.2.0 This should drastically improve docfx build time. * Add missing dependencies * Update DocFx.Plugins.LastModified to v1.2.1 Improve performance * Update DocFx.Plugins.LastModified to v1.2.2 * Clarify deployment.md + Rewritten .NET Core deployment strategies for better clarification * Split deployment types into framework-dependent and self-contained * Clarify the benefits of using different types of publishing * Include a sample of how to execute dotnet application with the dotnet command in a TIP dialog for visibility * Update post-execution article and samples + This change is to reflect changes made in https://github.com/RogueException/Discord.Net/pull/1164, where CommandInfo is now passed into the CommandExecuted event as an Optional<T> * Update DocFX.Plugin.DescriptionGenerator to v1.1.1 * Adjust according to recent CommandExecuted changes See: +f549da50e0+6260749095* Add further documentation for https://github.com/RogueException/Discord.Net/pull/1037 * Add partial documentation for the precondition helper class * Include CHANGELOG.md in docs * Revise post-execution docs * Fix incorrect Optional<T> usage * Indent some sample code and add a comment reminding the user that the post-execution basic sample code is not ideal. * Streamline docs for Attachment + This commit also adds further explanation for why Embeds and Attachments are read-only collections * Add further documentation for MessageActivity and MessageApplication * Add caching-related docs to ISocketMessageChannel * Add missing documentation inheritance for SyncPermissionsAsync * Streamline documentation process This is done by changing the documentation of the implementations required by interfaces to redirect to the interface method instead (e.g., SocketDMChannel#GetMessagesAsync refer to IMessageChannel.GetMessagesAsync within the remarks of the method). * Cleanup92bf8363ca* Update src/Discord.Net.Core/Entities/Channels/Direction.cs Co-Authored-By: Still34 <341464@gmail.com> * Update src/Discord.Net.Core/Entities/Channels/Direction.cs Co-Authored-By: Still34 <341464@gmail.com> * Update src/Discord.Net.Core/Entities/Channels/GuildChannelProperties.cs Co-Authored-By: Still34 <341464@gmail.com> * Update src/Discord.Net.WebSocket/DiscordSocketConfig.cs Co-Authored-By: Still34 <341464@gmail.com> * Update according to PR suggestions * Reword sentences of deployment article for clarification & remove mention of portability * Fix typos/grammar errors within TextChannelProperties * Add the logo SVG to the page navbar * Implement changing logo image based on theme color using CSS background image * Add a favicon * use the purple logomark instead of white * hack? set the title to navbar svg to read "Discord.Net Docs"
This commit is contained in:
Still Hsu
@@ -5,7 +5,9 @@ namespace Discord
|
||||
internal static class Preconditions
|
||||
{
|
||||
//Objects
|
||||
/// <exception cref="ArgumentNullException"><paramref name="obj"/> must not be <see langword="null"/>.</exception>
|
||||
public static void NotNull<T>(T obj, string name, string msg = null) where T : class { if (obj == null) throw CreateNotNullException(name, msg); }
|
||||
/// <exception cref="ArgumentNullException"><paramref name="obj"/> must not be <see langword="null"/>.</exception>
|
||||
public static void NotNull<T>(Optional<T> obj, string name, string msg = null) where T : class { if (obj.IsSpecified && obj.Value == null) throw CreateNotNullException(name, msg); }
|
||||
|
||||
private static ArgumentNullException CreateNotNullException(string name, string msg)
|
||||
@@ -15,13 +17,19 @@ namespace Discord
|
||||
}
|
||||
|
||||
//Strings
|
||||
/// <exception cref="ArgumentException"><paramref name="obj"/> cannot be blank.</exception>
|
||||
public static void NotEmpty(string obj, string name, string msg = null) { if (obj.Length == 0) throw CreateNotEmptyException(name, msg); }
|
||||
/// <exception cref="ArgumentException"><paramref name="obj"/> cannot be blank.</exception>
|
||||
public static void NotEmpty(Optional<string> obj, string name, string msg = null) { if (obj.IsSpecified && obj.Value.Length == 0) throw CreateNotEmptyException(name, msg); }
|
||||
/// <exception cref="ArgumentException"><paramref name="obj"/> cannot be blank.</exception>
|
||||
/// <exception cref="ArgumentNullException"><paramref name="obj"/> must not be <see langword="null"/>.</exception>
|
||||
public static void NotNullOrEmpty(string obj, string name, string msg = null)
|
||||
{
|
||||
if (obj == null) throw CreateNotNullException(name, msg);
|
||||
if (obj.Length == 0) throw CreateNotEmptyException(name, msg);
|
||||
}
|
||||
/// <exception cref="ArgumentException"><paramref name="obj"/> cannot be blank.</exception>
|
||||
/// <exception cref="ArgumentNullException"><paramref name="obj"/> must not be <see langword="null"/>.</exception>
|
||||
public static void NotNullOrEmpty(Optional<string> obj, string name, string msg = null)
|
||||
{
|
||||
if (obj.IsSpecified)
|
||||
@@ -30,11 +38,15 @@ namespace Discord
|
||||
if (obj.Value.Length == 0) throw CreateNotEmptyException(name, msg);
|
||||
}
|
||||
}
|
||||
/// <exception cref="ArgumentException"><paramref name="obj"/> cannot be blank.</exception>
|
||||
/// <exception cref="ArgumentNullException"><paramref name="obj"/> must not be <see langword="null"/>.</exception>
|
||||
public static void NotNullOrWhitespace(string obj, string name, string msg = null)
|
||||
{
|
||||
if (obj == null) throw CreateNotNullException(name, msg);
|
||||
if (obj.Trim().Length == 0) throw CreateNotEmptyException(name, msg);
|
||||
}
|
||||
/// <exception cref="ArgumentException"><paramref name="obj"/> cannot be blank.</exception>
|
||||
/// <exception cref="ArgumentNullException"><paramref name="obj"/> must not be <see langword="null"/>.</exception>
|
||||
public static void NotNullOrWhitespace(Optional<string> obj, string name, string msg = null)
|
||||
{
|
||||
if (obj.IsSpecified)
|
||||
@@ -48,121 +60,217 @@ namespace Discord
|
||||
=> new ArgumentException(message: msg ?? "Argument cannot be blank.", paramName: name);
|
||||
|
||||
//Numerics
|
||||
/// <exception cref="ArgumentException">Value may not be equal to <paramref name="value"/>.</exception>
|
||||
public static void NotEqual(sbyte obj, sbyte value, string name, string msg = null) { if (obj == value) throw CreateNotEqualException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value may not be equal to <paramref name="value"/>.</exception>
|
||||
public static void NotEqual(byte obj, byte value, string name, string msg = null) { if (obj == value) throw CreateNotEqualException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value may not be equal to <paramref name="value"/>.</exception>
|
||||
public static void NotEqual(short obj, short value, string name, string msg = null) { if (obj == value) throw CreateNotEqualException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value may not be equal to <paramref name="value"/>.</exception>
|
||||
public static void NotEqual(ushort obj, ushort value, string name, string msg = null) { if (obj == value) throw CreateNotEqualException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value may not be equal to <paramref name="value"/>.</exception>
|
||||
public static void NotEqual(int obj, int value, string name, string msg = null) { if (obj == value) throw CreateNotEqualException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value may not be equal to <paramref name="value"/>.</exception>
|
||||
public static void NotEqual(uint obj, uint value, string name, string msg = null) { if (obj == value) throw CreateNotEqualException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value may not be equal to <paramref name="value"/>.</exception>
|
||||
public static void NotEqual(long obj, long value, string name, string msg = null) { if (obj == value) throw CreateNotEqualException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value may not be equal to <paramref name="value"/>.</exception>
|
||||
public static void NotEqual(ulong obj, ulong value, string name, string msg = null) { if (obj == value) throw CreateNotEqualException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value may not be equal to <paramref name="value"/>.</exception>
|
||||
public static void NotEqual(Optional<sbyte> obj, sbyte value, string name, string msg = null) { if (obj.IsSpecified && obj.Value == value) throw CreateNotEqualException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value may not be equal to <paramref name="value"/>.</exception>
|
||||
public static void NotEqual(Optional<byte> obj, byte value, string name, string msg = null) { if (obj.IsSpecified && obj.Value == value) throw CreateNotEqualException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value may not be equal to <paramref name="value"/>.</exception>
|
||||
public static void NotEqual(Optional<short> obj, short value, string name, string msg = null) { if (obj.IsSpecified && obj.Value == value) throw CreateNotEqualException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value may not be equal to <paramref name="value"/>.</exception>
|
||||
public static void NotEqual(Optional<ushort> obj, ushort value, string name, string msg = null) { if (obj.IsSpecified && obj.Value == value) throw CreateNotEqualException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value may not be equal to <paramref name="value"/>.</exception>
|
||||
public static void NotEqual(Optional<int> obj, int value, string name, string msg = null) { if (obj.IsSpecified && obj.Value == value) throw CreateNotEqualException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value may not be equal to <paramref name="value"/>.</exception>
|
||||
public static void NotEqual(Optional<uint> obj, uint value, string name, string msg = null) { if (obj.IsSpecified && obj.Value == value) throw CreateNotEqualException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value may not be equal to <paramref name="value"/>.</exception>
|
||||
public static void NotEqual(Optional<long> obj, long value, string name, string msg = null) { if (obj.IsSpecified && obj.Value == value) throw CreateNotEqualException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value may not be equal to <paramref name="value"/>.</exception>
|
||||
public static void NotEqual(Optional<ulong> obj, ulong value, string name, string msg = null) { if (obj.IsSpecified && obj.Value == value) throw CreateNotEqualException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value may not be equal to <paramref name="value"/>.</exception>
|
||||
public static void NotEqual(sbyte? obj, sbyte value, string name, string msg = null) { if (obj == value) throw CreateNotEqualException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value may not be equal to <paramref name="value"/>.</exception>
|
||||
public static void NotEqual(byte? obj, byte value, string name, string msg = null) { if (obj == value) throw CreateNotEqualException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value may not be equal to <paramref name="value"/>.</exception>
|
||||
public static void NotEqual(short? obj, short value, string name, string msg = null) { if (obj == value) throw CreateNotEqualException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value may not be equal to <paramref name="value"/>.</exception>
|
||||
public static void NotEqual(ushort? obj, ushort value, string name, string msg = null) { if (obj == value) throw CreateNotEqualException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value may not be equal to <paramref name="value"/>.</exception>
|
||||
public static void NotEqual(int? obj, int value, string name, string msg = null) { if (obj == value) throw CreateNotEqualException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value may not be equal to <paramref name="value"/>.</exception>
|
||||
public static void NotEqual(uint? obj, uint value, string name, string msg = null) { if (obj == value) throw CreateNotEqualException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value may not be equal to <paramref name="value"/>.</exception>
|
||||
public static void NotEqual(long? obj, long value, string name, string msg = null) { if (obj == value) throw CreateNotEqualException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value may not be equal to <paramref name="value"/>.</exception>
|
||||
public static void NotEqual(ulong? obj, ulong value, string name, string msg = null) { if (obj == value) throw CreateNotEqualException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value may not be equal to <paramref name="value"/>.</exception>
|
||||
public static void NotEqual(Optional<sbyte?> obj, sbyte value, string name, string msg = null) { if (obj.IsSpecified && obj.Value == value) throw CreateNotEqualException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value may not be equal to <paramref name="value"/>.</exception>
|
||||
public static void NotEqual(Optional<byte?> obj, byte value, string name, string msg = null) { if (obj.IsSpecified && obj.Value == value) throw CreateNotEqualException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value may not be equal to <paramref name="value"/>.</exception>
|
||||
public static void NotEqual(Optional<short?> obj, short value, string name, string msg = null) { if (obj.IsSpecified && obj.Value == value) throw CreateNotEqualException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value may not be equal to <paramref name="value"/>.</exception>
|
||||
public static void NotEqual(Optional<ushort?> obj, ushort value, string name, string msg = null) { if (obj.IsSpecified && obj.Value == value) throw CreateNotEqualException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value may not be equal to <paramref name="value"/>.</exception>
|
||||
public static void NotEqual(Optional<int?> obj, int value, string name, string msg = null) { if (obj.IsSpecified && obj.Value == value) throw CreateNotEqualException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value may not be equal to <paramref name="value"/>.</exception>
|
||||
public static void NotEqual(Optional<uint?> obj, uint value, string name, string msg = null) { if (obj.IsSpecified && obj.Value == value) throw CreateNotEqualException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value may not be equal to <paramref name="value"/>.</exception>
|
||||
public static void NotEqual(Optional<long?> obj, long value, string name, string msg = null) { if (obj.IsSpecified && obj.Value == value) throw CreateNotEqualException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value may not be equal to <paramref name="value"/>.</exception>
|
||||
public static void NotEqual(Optional<ulong?> obj, ulong value, string name, string msg = null) { if (obj.IsSpecified && obj.Value == value) throw CreateNotEqualException(name, msg, value); }
|
||||
|
||||
private static ArgumentException CreateNotEqualException<T>(string name, string msg, T value)
|
||||
=> new ArgumentException(message: msg ?? $"Value may not be equal to {value}", paramName: name);
|
||||
=> new ArgumentException(message: msg ?? $"Value may not be equal to {value}.", paramName: name);
|
||||
|
||||
/// <exception cref="ArgumentException">Value must be at least <paramref name="value"/>.</exception>
|
||||
public static void AtLeast(sbyte obj, sbyte value, string name, string msg = null) { if (obj < value) throw CreateAtLeastException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be at least <paramref name="value"/>.</exception>
|
||||
public static void AtLeast(byte obj, byte value, string name, string msg = null) { if (obj < value) throw CreateAtLeastException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be at least <paramref name="value"/>.</exception>
|
||||
public static void AtLeast(short obj, short value, string name, string msg = null) { if (obj < value) throw CreateAtLeastException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be at least <paramref name="value"/>.</exception>
|
||||
public static void AtLeast(ushort obj, ushort value, string name, string msg = null) { if (obj < value) throw CreateAtLeastException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be at least <paramref name="value"/>.</exception>
|
||||
public static void AtLeast(int obj, int value, string name, string msg = null) { if (obj < value) throw CreateAtLeastException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be at least <paramref name="value"/>.</exception>
|
||||
public static void AtLeast(uint obj, uint value, string name, string msg = null) { if (obj < value) throw CreateAtLeastException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be at least <paramref name="value"/>.</exception>
|
||||
public static void AtLeast(long obj, long value, string name, string msg = null) { if (obj < value) throw CreateAtLeastException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be at least <paramref name="value"/>.</exception>
|
||||
public static void AtLeast(ulong obj, ulong value, string name, string msg = null) { if (obj < value) throw CreateAtLeastException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be at least <paramref name="value"/>.</exception>
|
||||
public static void AtLeast(Optional<sbyte> obj, sbyte value, string name, string msg = null) { if (obj.IsSpecified && obj.Value < value) throw CreateAtLeastException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be at least <paramref name="value"/>.</exception>
|
||||
public static void AtLeast(Optional<byte> obj, byte value, string name, string msg = null) { if (obj.IsSpecified && obj.Value < value) throw CreateAtLeastException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be at least <paramref name="value"/>.</exception>
|
||||
public static void AtLeast(Optional<short> obj, short value, string name, string msg = null) { if (obj.IsSpecified && obj.Value < value) throw CreateAtLeastException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be at least <paramref name="value"/>.</exception>
|
||||
public static void AtLeast(Optional<ushort> obj, ushort value, string name, string msg = null) { if (obj.IsSpecified && obj.Value < value) throw CreateAtLeastException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be at least <paramref name="value"/>.</exception>
|
||||
public static void AtLeast(Optional<int> obj, int value, string name, string msg = null) { if (obj.IsSpecified && obj.Value < value) throw CreateAtLeastException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be at least <paramref name="value"/>.</exception>
|
||||
public static void AtLeast(Optional<uint> obj, uint value, string name, string msg = null) { if (obj.IsSpecified && obj.Value < value) throw CreateAtLeastException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be at least <paramref name="value"/>.</exception>
|
||||
public static void AtLeast(Optional<long> obj, long value, string name, string msg = null) { if (obj.IsSpecified && obj.Value < value) throw CreateAtLeastException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be at least <paramref name="value"/>.</exception>
|
||||
public static void AtLeast(Optional<ulong> obj, ulong value, string name, string msg = null) { if (obj.IsSpecified && obj.Value < value) throw CreateAtLeastException(name, msg, value); }
|
||||
|
||||
private static ArgumentException CreateAtLeastException<T>(string name, string msg, T value)
|
||||
=> new ArgumentException(message: msg ?? $"Value must be at least {value}", paramName: name);
|
||||
|
||||
=> new ArgumentException(message: msg ?? $"Value must be at least {value}.", paramName: name);
|
||||
|
||||
/// <exception cref="ArgumentException">Value must be greater than <paramref name="value"/>.</exception>
|
||||
public static void GreaterThan(sbyte obj, sbyte value, string name, string msg = null) { if (obj <= value) throw CreateGreaterThanException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be greater than <paramref name="value"/>.</exception>
|
||||
public static void GreaterThan(byte obj, byte value, string name, string msg = null) { if (obj <= value) throw CreateGreaterThanException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be greater than <paramref name="value"/>.</exception>
|
||||
public static void GreaterThan(short obj, short value, string name, string msg = null) { if (obj <= value) throw CreateGreaterThanException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be greater than <paramref name="value"/>.</exception>
|
||||
public static void GreaterThan(ushort obj, ushort value, string name, string msg = null) { if (obj <= value) throw CreateGreaterThanException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be greater than <paramref name="value"/>.</exception>
|
||||
public static void GreaterThan(int obj, int value, string name, string msg = null) { if (obj <= value) throw CreateGreaterThanException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be greater than <paramref name="value"/>.</exception>
|
||||
public static void GreaterThan(uint obj, uint value, string name, string msg = null) { if (obj <= value) throw CreateGreaterThanException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be greater than <paramref name="value"/>.</exception>
|
||||
public static void GreaterThan(long obj, long value, string name, string msg = null) { if (obj <= value) throw CreateGreaterThanException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be greater than <paramref name="value"/>.</exception>
|
||||
public static void GreaterThan(ulong obj, ulong value, string name, string msg = null) { if (obj <= value) throw CreateGreaterThanException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be greater than <paramref name="value"/>.</exception>
|
||||
public static void GreaterThan(Optional<sbyte> obj, sbyte value, string name, string msg = null) { if (obj.IsSpecified && obj.Value <= value) throw CreateGreaterThanException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be greater than <paramref name="value"/>.</exception>
|
||||
public static void GreaterThan(Optional<byte> obj, byte value, string name, string msg = null) { if (obj.IsSpecified && obj.Value <= value) throw CreateGreaterThanException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be greater than <paramref name="value"/>.</exception>
|
||||
public static void GreaterThan(Optional<short> obj, short value, string name, string msg = null) { if (obj.IsSpecified && obj.Value <= value) throw CreateGreaterThanException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be greater than <paramref name="value"/>.</exception>
|
||||
public static void GreaterThan(Optional<ushort> obj, ushort value, string name, string msg = null) { if (obj.IsSpecified && obj.Value <= value) throw CreateGreaterThanException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be greater than <paramref name="value"/>.</exception>
|
||||
public static void GreaterThan(Optional<int> obj, int value, string name, string msg = null) { if (obj.IsSpecified && obj.Value <= value) throw CreateGreaterThanException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be greater than <paramref name="value"/>.</exception>
|
||||
public static void GreaterThan(Optional<uint> obj, uint value, string name, string msg = null) { if (obj.IsSpecified && obj.Value <= value) throw CreateGreaterThanException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be greater than <paramref name="value"/>.</exception>
|
||||
public static void GreaterThan(Optional<long> obj, long value, string name, string msg = null) { if (obj.IsSpecified && obj.Value <= value) throw CreateGreaterThanException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be greater than <paramref name="value"/>.</exception>
|
||||
public static void GreaterThan(Optional<ulong> obj, ulong value, string name, string msg = null) { if (obj.IsSpecified && obj.Value <= value) throw CreateGreaterThanException(name, msg, value); }
|
||||
|
||||
private static ArgumentException CreateGreaterThanException<T>(string name, string msg, T value)
|
||||
=> new ArgumentException(message: msg ?? $"Value must be greater than {value}", paramName: name);
|
||||
|
||||
=> new ArgumentException(message: msg ?? $"Value must be greater than {value}.", paramName: name);
|
||||
|
||||
/// <exception cref="ArgumentException">Value must be at most <paramref name="value"/>.</exception>
|
||||
public static void AtMost(sbyte obj, sbyte value, string name, string msg = null) { if (obj > value) throw CreateAtMostException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be at most <paramref name="value"/>.</exception>
|
||||
public static void AtMost(byte obj, byte value, string name, string msg = null) { if (obj > value) throw CreateAtMostException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be at most <paramref name="value"/>.</exception>
|
||||
public static void AtMost(short obj, short value, string name, string msg = null) { if (obj > value) throw CreateAtMostException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be at most <paramref name="value"/>.</exception>
|
||||
public static void AtMost(ushort obj, ushort value, string name, string msg = null) { if (obj > value) throw CreateAtMostException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be at most <paramref name="value"/>.</exception>
|
||||
public static void AtMost(int obj, int value, string name, string msg = null) { if (obj > value) throw CreateAtMostException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be at most <paramref name="value"/>.</exception>
|
||||
public static void AtMost(uint obj, uint value, string name, string msg = null) { if (obj > value) throw CreateAtMostException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be at most <paramref name="value"/>.</exception>
|
||||
public static void AtMost(long obj, long value, string name, string msg = null) { if (obj > value) throw CreateAtMostException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be at most <paramref name="value"/>.</exception>
|
||||
public static void AtMost(ulong obj, ulong value, string name, string msg = null) { if (obj > value) throw CreateAtMostException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be at most <paramref name="value"/>.</exception>
|
||||
public static void AtMost(Optional<sbyte> obj, sbyte value, string name, string msg = null) { if (obj.IsSpecified && obj.Value > value) throw CreateAtMostException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be at most <paramref name="value"/>.</exception>
|
||||
public static void AtMost(Optional<byte> obj, byte value, string name, string msg = null) { if (obj.IsSpecified && obj.Value > value) throw CreateAtMostException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be at most <paramref name="value"/>.</exception>
|
||||
public static void AtMost(Optional<short> obj, short value, string name, string msg = null) { if (obj.IsSpecified && obj.Value > value) throw CreateAtMostException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be at most <paramref name="value"/>.</exception>
|
||||
public static void AtMost(Optional<ushort> obj, ushort value, string name, string msg = null) { if (obj.IsSpecified && obj.Value > value) throw CreateAtMostException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be at most <paramref name="value"/>.</exception>
|
||||
public static void AtMost(Optional<int> obj, int value, string name, string msg = null) { if (obj.IsSpecified && obj.Value > value) throw CreateAtMostException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be at most <paramref name="value"/>.</exception>
|
||||
public static void AtMost(Optional<uint> obj, uint value, string name, string msg = null) { if (obj.IsSpecified && obj.Value > value) throw CreateAtMostException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be at most <paramref name="value"/>.</exception>
|
||||
public static void AtMost(Optional<long> obj, long value, string name, string msg = null) { if (obj.IsSpecified && obj.Value > value) throw CreateAtMostException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be at most <paramref name="value"/>.</exception>
|
||||
public static void AtMost(Optional<ulong> obj, ulong value, string name, string msg = null) { if (obj.IsSpecified && obj.Value > value) throw CreateAtMostException(name, msg, value); }
|
||||
|
||||
private static ArgumentException CreateAtMostException<T>(string name, string msg, T value)
|
||||
=> new ArgumentException(message: msg ?? $"Value must be at most {value}", paramName: name);
|
||||
|
||||
=> new ArgumentException(message: msg ?? $"Value must be at most {value}.", paramName: name);
|
||||
|
||||
/// <exception cref="ArgumentException">Value must be less than <paramref name="value"/>.</exception>
|
||||
public static void LessThan(sbyte obj, sbyte value, string name, string msg = null) { if (obj >= value) throw CreateLessThanException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be less than <paramref name="value"/>.</exception>
|
||||
public static void LessThan(byte obj, byte value, string name, string msg = null) { if (obj >= value) throw CreateLessThanException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be less than <paramref name="value"/>.</exception>
|
||||
public static void LessThan(short obj, short value, string name, string msg = null) { if (obj >= value) throw CreateLessThanException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be less than <paramref name="value"/>.</exception>
|
||||
public static void LessThan(ushort obj, ushort value, string name, string msg = null) { if (obj >= value) throw CreateLessThanException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be less than <paramref name="value"/>.</exception>
|
||||
public static void LessThan(int obj, int value, string name, string msg = null) { if (obj >= value) throw CreateLessThanException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be less than <paramref name="value"/>.</exception>
|
||||
public static void LessThan(uint obj, uint value, string name, string msg = null) { if (obj >= value) throw CreateLessThanException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be less than <paramref name="value"/>.</exception>
|
||||
public static void LessThan(long obj, long value, string name, string msg = null) { if (obj >= value) throw CreateLessThanException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be less than <paramref name="value"/>.</exception>
|
||||
public static void LessThan(ulong obj, ulong value, string name, string msg = null) { if (obj >= value) throw CreateLessThanException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be less than <paramref name="value"/>.</exception>
|
||||
public static void LessThan(Optional<sbyte> obj, sbyte value, string name, string msg = null) { if (obj.IsSpecified && obj.Value >= value) throw CreateLessThanException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be less than <paramref name="value"/>.</exception>
|
||||
public static void LessThan(Optional<byte> obj, byte value, string name, string msg = null) { if (obj.IsSpecified && obj.Value >= value) throw CreateLessThanException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be less than <paramref name="value"/>.</exception>
|
||||
public static void LessThan(Optional<short> obj, short value, string name, string msg = null) { if (obj.IsSpecified && obj.Value >= value) throw CreateLessThanException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be less than <paramref name="value"/>.</exception>
|
||||
public static void LessThan(Optional<ushort> obj, ushort value, string name, string msg = null) { if (obj.IsSpecified && obj.Value >= value) throw CreateLessThanException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be less than <paramref name="value"/>.</exception>
|
||||
public static void LessThan(Optional<int> obj, int value, string name, string msg = null) { if (obj.IsSpecified && obj.Value >= value) throw CreateLessThanException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be less than <paramref name="value"/>.</exception>
|
||||
public static void LessThan(Optional<uint> obj, uint value, string name, string msg = null) { if (obj.IsSpecified && obj.Value >= value) throw CreateLessThanException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be less than <paramref name="value"/>.</exception>
|
||||
public static void LessThan(Optional<long> obj, long value, string name, string msg = null) { if (obj.IsSpecified && obj.Value >= value) throw CreateLessThanException(name, msg, value); }
|
||||
/// <exception cref="ArgumentException">Value must be less than <paramref name="value"/>.</exception>
|
||||
public static void LessThan(Optional<ulong> obj, ulong value, string name, string msg = null) { if (obj.IsSpecified && obj.Value >= value) throw CreateLessThanException(name, msg, value); }
|
||||
|
||||
private static ArgumentException CreateLessThanException<T>(string name, string msg, T value)
|
||||
=> new ArgumentException(message: msg ?? $"Value must be less than {value}", paramName: name);
|
||||
=> new ArgumentException(message: msg ?? $"Value must be less than {value}.", paramName: name);
|
||||
|
||||
// Bulk Delete
|
||||
/// <exception cref="ArgumentOutOfRangeException">Messages are younger than 2 weeks.</exception>
|
||||
@@ -182,7 +290,7 @@ namespace Discord
|
||||
for (var i = 0; i < roles.Length; i++)
|
||||
{
|
||||
if (roles[i] == guildId)
|
||||
throw new ArgumentException(message: "The everyone role cannot be assigned to a user", paramName: name);
|
||||
throw new ArgumentException(message: "The everyone role cannot be assigned to a user.", paramName: name);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user