@@ -100,6 +100,18 @@
A URL pointing to the user's avatar in the specified size.
</returns>
</member>
<member name="M:Discord.CDN.GetUserBannerUrl(System.UInt64,System.String,System.UInt16,Discord.ImageFormat)">
<summary>
Returns a user banner URL.
</summary>
<param name="userId">The user snowflake identifier.</param>
<param name="bannerId">The banner identifier.</param>
<param name="size">The size of the image to return in horizontal pixels. This can be any power of two between 16 and 2048.</param>
<param name="format">The format to return.</param>
<returns>
A URL pointing to the user's banner in the specified size.
</returns>
</member>
<member name="M:Discord.CDN.GetDefaultUserAvatarUrl(System.UInt16)">
<summary>
Returns the default user avatar URL.
@@ -4782,11 +4794,6 @@
Represents a builder for creating a <see cref="T:Discord.MessageComponent"/>.
</summary>
</member>
<member name="F:Discord.ComponentBuilder.MaxLabelLength">
<summary>
The max length of a <see cref="P:Discord.ButtonComponent.Label"/>.
</summary>
</member>
<member name="F:Discord.ComponentBuilder.MaxCustomIdLength">
<summary>
The max length of a <see cref="P:Discord.ButtonComponent.CustomId"/>.
@@ -4905,11 +4912,16 @@
Represents a class used to build <see cref="T:Discord.ButtonComponent"/>'s.
</summary>
</member>
<member name="F:Discord.ButtonBuilder.MaxLabelLength">
<summary>
The max length of a <see cref="P:Discord.ButtonComponent.Label"/>.
</summary>
</member>
<member name="P:Discord.ButtonBuilder.Label">
<summary>
Gets or sets the label of the current button.
</summary>
<exception cref="T:System.ArgumentException" accessor="set"><see cref="P:Discord.ButtonBuilder.Label"/> length exceeds <see cref="F:Discord.ComponentBuilder.MaxLabelLength"/>.</exception>
<exception cref="T:System.ArgumentException" accessor="set"><see cref="P:Discord.ButtonBuilder.Label"/> length exceeds <see cref="F:Discord.Button Builder.MaxLabelLength"/>.</exception>
</member>
<member name="P:Discord.ButtonBuilder.CustomId">
<summary>
@@ -5229,6 +5241,11 @@
Represents a class used to build <see cref="T:Discord.SelectMenuOption"/>'s.
</summary>
</member>
<member name="F:Discord.SelectMenuOptionBuilder.MaxLabelLength">
<summary>
The maximum length of a <see cref="P:Discord.SelectMenuOption.Label"/>.
</summary>
</member>
<member name="F:Discord.SelectMenuOptionBuilder.MaxDescriptionLength">
<summary>
The maximum length of a <see cref="P:Discord.SelectMenuOption.Description"/>.
@@ -5238,7 +5255,7 @@
<summary>
Gets or sets the label of the current select menu.
</summary>
<exception cref="T:System.ArgumentException" accessor="set"><see cref="P:Discord.SelectMenuOptionBuilder.Label"/> length exceeds <see cref="F:Discord.Component Builder.MaxLabelLength"/></exception>
<exception cref="T:System.ArgumentException" accessor="set"><see cref="P:Discord.SelectMenuOptionBuilder.Label"/> length exceeds <see cref="F:Discord.SelectMenuOption Builder.MaxLabelLength"/></exception>
</member>
<member name="P:Discord.SelectMenuOptionBuilder.Value">
<summary>
@@ -8645,7 +8662,25 @@
<summary> If <c>true</c>, a user may edit the webhooks for this guild. </summary>
</member>
<member name="P:Discord.GuildPermissions.ManageEmojisAndStickers">
<summary> If <c>true</c>, a user may edit the emojis for this guild. </summary>
<summary> If <c>true</c>, a user may edit the emojis and stickers for this guild. </summary>
</member>
<member name="P:Discord.GuildPermissions.UseSlashCommands">
<summary> If <c>true</c>, a user may use slash commands in this guild. </summary>
</member>
<member name="P:Discord.GuildPermissions.RequestToSpeak">
<summary> If <c>true</c>, a user may request to speak in stage channels. </summary>
</member>
<member name="P:Discord.GuildPermissions.ManageThreads">
<summary> If <c>true</c>, a user may manage threads in this guild. </summary>
</member>
<member name="P:Discord.GuildPermissions.UsePublicThreads">
<summary> If <c>true</c>, a user may create public threads in this guild. </summary>
</member>
<member name="P:Discord.GuildPermissions.UsePrivateThreads">
<summary> If <c>true</c>, a user may create private threads in this guild. </summary>
</member>
<member name="P:Discord.GuildPermissions.UseExternalStickers">
<summary> If <c>true</c>, a user may use external stickers in this guild. </summary>
</member>
<member name="M:Discord.GuildPermissions.#ctor(System.UInt64)">
<summary> Creates a new <see cref="T:Discord.GuildPermissions"/> with the provided packed value. </summary>
@@ -8653,10 +8688,10 @@
<member name="M:Discord.GuildPermissions.#ctor(System.String)">
<summary> Creates a new <see cref="T:Discord.GuildPermissions"/> with the provided packed value after converting to ulong. </summary>
</member>
<member name="M:Discord.GuildPermissions.#ctor(System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean)">
<member name="M:Discord.GuildPermissions.#ctor(System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean )">
<summary> Creates a new <see cref="T:Discord.GuildPermissions"/> structure with the provided permissions. </summary>
</member>
<member name="M:Discord.GuildPermissions.Modify(System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean})">
<member name="M:Discord.GuildPermissions.Modify(System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean} )">
<summary> Creates a new <see cref="T:Discord.GuildPermissions"/> from this one, changing the provided non-null permissions. </summary>
</member>
<member name="M:Discord.GuildPermissions.Has(Discord.GuildPermission)">
@@ -8843,6 +8878,9 @@
Represents a color used in Discord.
</summary>
</member>
<member name="F:Discord.Color.MaxDecimalValue">
<summary> Gets the max decimal value of color. </summary>
</member>
<member name="F:Discord.Color.Default">
<summary> Gets the default user color value. </summary>
</member>
@@ -8947,20 +8985,21 @@
Initializes a <see cref="T:Discord.Color"/> struct with the given raw value.
</summary>
<example>
The following will create a color that has a hex value of
The following will create a color that has a hex value of
<see href="http://www.color-hex.com/color/607d8b">#607D8B</see>.
<code language="cs">
Color darkGrey = new Color(0x607D8B);
</code>
</example>
<param name="rawValue">The raw value of the color (e.g. <c>0x607D8B</c>).</param>
<exception cref="T:System.ArgumentException">Value exceeds <see cref="F:Discord.Color.MaxDecimalValue"/>.</exception>
</member>
<member name="M:Discord.Color.#ctor(System.Byte,System.Byte,System.Byte)">
<summary>
Initializes a <see cref="T:Discord.Color" /> struct with the given RGB bytes.
</summary>
<example>
The following will create a color that has a value of
The following will create a color that has a value of
<see href="http://www.color-hex.com/color/607d8b">#607D8B</see>.
<code language="cs">
Color darkGrey = new Color((byte)0b_01100000, (byte)0b_01111101, (byte)0b_10001011);
@@ -8969,13 +9008,14 @@
<param name="r">The byte that represents the red color.</param>
<param name="g">The byte that represents the green color.</param>
<param name="b">The byte that represents the blue color.</param>
<exception cref="T:System.ArgumentException">Value exceeds <see cref="F:Discord.Color.MaxDecimalValue"/>.</exception>
</member>
<member name="M:Discord.Color.#ctor(System.Int32,System.Int32,System.Int32)">
<summary>
Initializes a <see cref="T:Discord.Color"/> struct with the given RGB value.
</summary>
<example>
The following will create a color that has a value of
The following will create a color that has a value of
<see href="http://www.color-hex.com/color/607d8b">#607D8B</see>.
<code language="cs">
Color darkGrey = new Color(96, 125, 139);
@@ -8991,7 +9031,7 @@
Initializes a <see cref="T:Discord.Color"/> struct with the given RGB float value.
</summary>
<example>
The following will create a color that has a value of
The following will create a color that has a value of
<see href="http://www.color-hex.com/color/607c8c">#607c8c</see>.
<code language="cs">
Color darkGrey = new Color(0.38f, 0.49f, 0.55f);
@@ -9759,19 +9799,33 @@
Gets the identifier of this user's avatar.
</summary>
</member>
<member name="P:Discord.IUser.BannerId">
<summary>
Gets the identifier of this user's banner.
</summary>
</member>
<member name="P:Discord.IUser.AccentColor">
<summary>
Gets the user's banner color.
</summary>
<returns>
A <see cref="T:Discord.Color"/> struct representing the accent color of this user's banner.
</returns>
</member>
<member name="M:Discord.IUser.GetAvatarUrl(Discord.ImageFormat,System.UInt16)">
<summary>
Gets the avatar URL for this user.
</summary>
<remarks>
This property retrieves a URL for this user's avatar. In event that the user does not have a valid avatar
(i.e. their avatar identifier is not set), this property will return <c>null</c>. If you wish to
(i.e. their avatar identifier is not set), this method will return <c>null</c>. If you wish to
retrieve the default avatar for this user, consider using <see cref="M:Discord.IUser.GetDefaultAvatarUrl"/> (see
example).
</remarks>
<example>
<para>The following example attempts to retrieve the user's current avatar and send it to a channel; if one is
not set, a default avatar for this user will be returned instead.</para>
<para
>The following example attempts to retrieve the user's current avatar and send it to a channel; if one is
not set, a default avatar for this user will be returned instead.</para>
<code language="cs" region="GetAvatarUrl"
source="..\..\..\Discord.Net.Examples\Core\Entities\Users\IUser.Examples.cs"/>
</example>
@@ -9782,6 +9836,17 @@
A string representing the user's avatar URL; <c>null</c> if the user does not have an avatar in place.
</returns>
</member>
<member name="M:Discord.IUser.GetBannerUrl(Discord.ImageFormat,System.UInt16)">
<summary>
Gets the banner URL for this user.
</summary>
<param name="format">The format to return.</param>
<param name="size">The size of the image to return in. This can be any power of two between 16 and 2048.
</param>
<returns>
A string representing the user's avatar URL; <c>null</c> if the user does not have an banner in place.
</returns>
</member>
<member name="M:Discord.IUser.GetDefaultAvatarUrl">
<summary>
Gets the default avatar URL for this user.
@@ -9849,8 +9914,8 @@
This method is used to obtain or create a channel used to send a direct message.
<note type="warning">
In event that the current user cannot send a message to the target user, a channel can and will
still be created by Discord. However, attempting to send a message will yield a
<see cref="T:Discord.Net.HttpException"/> with a 403 as its
still be created by Discord. However, attempting to send a message will yield a
<see cref="T:Discord.Net.HttpException"/> with a 403 as its
<see cref="P:Discord.Net.HttpException.HttpCode"/>. There are currently no official workarounds by
Discord.
</note>