Browse Source

meta: merge upstream

pull/1923/head
quin lynch 3 years ago
parent
commit
005cacc352
3 changed files with 95 additions and 2 deletions
  1. +55
    -1
      src/Discord.Net.Core/Discord.Net.Core.xml
  2. +28
    -1
      src/Discord.Net.Rest/Discord.Net.Rest.xml
  3. +12
    -0
      src/Discord.Net.WebSocket/Discord.Net.WebSocket.xml

+ 55
- 1
src/Discord.Net.Core/Discord.Net.Core.xml View File

@@ -1743,7 +1743,7 @@
Gets the parent (category) ID of this channel in the guild's channel list. Gets the parent (category) ID of this channel in the guild's channel list.
</summary> </summary>
<returns> <returns>
A <see cref="T:System.UInt64"/> representing the snowflake identifier of the parent of this channel;
A <see cref="T:System.UInt64"/> representing the snowflake identifier of the parent of this channel;
<c>null</c> if none is set. <c>null</c> if none is set.
</returns> </returns>
</member> </member>
@@ -1788,6 +1788,50 @@
metadata object containing information for the created invite. metadata object containing information for the created invite.
</returns> </returns>
</member> </member>
<member name="M:Discord.INestedChannel.CreateInviteToApplicationAsync(System.UInt64,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Boolean,System.Boolean,Discord.RequestOptions)">
<summary>
Creates a new invite to this channel.
</summary>
<example>
<para>The following example creates a new invite to this channel; the invite lasts for 12 hours and can only
be used 3 times throughout its lifespan.</para>
<code language="cs">
await guildChannel.CreateInviteAsync(maxAge: 43200, maxUses: 3);
</code>
</example>
<param name="applicationId">The id of the embedded application to open for this invite</param>
<param name="maxAge">The time (in seconds) until the invite expires. Set to <c>null</c> to never expire.</param>
<param name="maxUses">The max amount of times this invite may be used. Set to <c>null</c> to have unlimited uses.</param>
<param name="isTemporary">If <c>true</c>, the user accepting this invite will be kicked from the guild after closing their client.</param>
<param name="isUnique">If <c>true</c>, don't try to reuse a similar invite (useful for creating many unique one time use invites).</param>
<param name="options">The options to be used when sending the request.</param>
<returns>
A task that represents the asynchronous invite creation operation. The task result contains an invite
metadata object containing information for the created invite.
</returns>
</member>
<member name="M:Discord.INestedChannel.CreateInviteToStreamAsync(Discord.IUser,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Boolean,System.Boolean,Discord.RequestOptions)">
<summary>
Creates a new invite to this channel.
</summary>
<example>
<para>The following example creates a new invite to this channel; the invite lasts for 12 hours and can only
be used 3 times throughout its lifespan.</para>
<code language="cs">
await guildChannel.CreateInviteAsync(maxAge: 43200, maxUses: 3);
</code>
</example>
<param name="user">The id of the user whose stream to display for this invite</param>
<param name="maxAge">The time (in seconds) until the invite expires. Set to <c>null</c> to never expire.</param>
<param name="maxUses">The max amount of times this invite may be used. Set to <c>null</c> to have unlimited uses.</param>
<param name="isTemporary">If <c>true</c>, the user accepting this invite will be kicked from the guild after closing their client.</param>
<param name="isUnique">If <c>true</c>, don't try to reuse a similar invite (useful for creating many unique one time use invites).</param>
<param name="options">The options to be used when sending the request.</param>
<returns>
A task that represents the asynchronous invite creation operation. The task result contains an invite
metadata object containing information for the created invite.
</returns>
</member>
<member name="M:Discord.INestedChannel.GetInvitesAsync(Discord.RequestOptions)"> <member name="M:Discord.INestedChannel.GetInvitesAsync(Discord.RequestOptions)">
<summary> <summary>
Gets a collection of all invites to this channel. Gets a collection of all invites to this channel.
@@ -5297,6 +5341,11 @@
The invite is for a Go Live stream. The invite is for a Go Live stream.
</summary> </summary>
</member> </member>
<member name="F:Discord.TargetUserType.EmbeddedApplication">
<summary>
The invite is for embedded application.
</summary>
</member>
<member name="T:Discord.ISnowflakeEntity"> <member name="T:Discord.ISnowflakeEntity">
<summary> Represents a Discord snowflake entity. </summary> <summary> Represents a Discord snowflake entity. </summary>
</member> </member>
@@ -8532,6 +8581,11 @@
Gets the members of this team. Gets the members of this team.
</summary> </summary>
</member> </member>
<member name="P:Discord.ITeam.Name">
<summary>
Gets the name of this team.
</summary>
</member>
<member name="P:Discord.ITeam.OwnerUserId"> <member name="P:Discord.ITeam.OwnerUserId">
<summary> <summary>
Gets the user identifier that owns this team. Gets the user identifier that owns this team.


+ 28
- 1
src/Discord.Net.Rest/Discord.Net.Rest.xml View File

@@ -1656,6 +1656,24 @@
<paramref name="maxAge"/> must be lesser than 86400. <paramref name="maxAge"/> must be lesser than 86400.
</exception> </exception>
</member> </member>
<member name="M:Discord.Rest.ChannelHelper.CreateInviteToStreamAsync(Discord.IGuildChannel,Discord.Rest.BaseDiscordClient,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Boolean,System.Boolean,Discord.IUser,Discord.RequestOptions)">
<exception cref="T:System.ArgumentException">
<paramref name="channel.Id.Id"/> may not be equal to zero.
-and-
<paramref name="maxAge"/> and <paramref name="maxUses"/> must be greater than zero.
-and-
<paramref name="maxAge"/> must be lesser than 86400.
</exception>
</member>
<member name="M:Discord.Rest.ChannelHelper.CreateInviteToApplicationAsync(Discord.IGuildChannel,Discord.Rest.BaseDiscordClient,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Boolean,System.Boolean,System.UInt64,Discord.RequestOptions)">
<exception cref="T:System.ArgumentException">
<paramref name="channel.Id.Id"/> may not be equal to zero.
-and-
<paramref name="maxAge"/> and <paramref name="maxUses"/> must be greater than zero.
-and-
<paramref name="maxAge"/> must be lesser than 86400.
</exception>
</member>
<member name="M:Discord.Rest.ChannelHelper.SendMessageAsync(Discord.IMessageChannel,Discord.Rest.BaseDiscordClient,System.String,System.Boolean,Discord.Embed,Discord.AllowedMentions,Discord.MessageReference,Discord.MessageComponent,Discord.RequestOptions)"> <member name="M:Discord.Rest.ChannelHelper.SendMessageAsync(Discord.IMessageChannel,Discord.Rest.BaseDiscordClient,System.String,System.Boolean,Discord.Embed,Discord.AllowedMentions,Discord.MessageReference,Discord.MessageComponent,Discord.RequestOptions)">
<exception cref="T:System.ArgumentOutOfRangeException">Message content is too long, length must be less or equal to <see cref="F:Discord.DiscordConfig.MaxMessageSize"/>.</exception> <exception cref="T:System.ArgumentOutOfRangeException">Message content is too long, length must be less or equal to <see cref="F:Discord.DiscordConfig.MaxMessageSize"/>.</exception>
</member> </member>
@@ -2313,7 +2331,7 @@
</exception> </exception>
<returns> <returns>
A paged collection containing a collection of guild users that can access this channel. Flattening the A paged collection containing a collection of guild users that can access this channel. Flattening the
paginated response into a collection of users with
paginated response into a collection of users with
<see cref="M:Discord.AsyncEnumerableExtensions.FlattenAsync``1(System.Collections.Generic.IAsyncEnumerable{System.Collections.Generic.IEnumerable{``0}})"/> is required if you wish to access the users. <see cref="M:Discord.AsyncEnumerableExtensions.FlattenAsync``1(System.Collections.Generic.IAsyncEnumerable{System.Collections.Generic.IEnumerable{``0}})"/> is required if you wish to access the users.
</returns> </returns>
</member> </member>
@@ -2524,6 +2542,12 @@
<member name="M:Discord.Rest.RestVoiceChannel.CreateInviteAsync(System.Nullable{System.Int32},System.Nullable{System.Int32},System.Boolean,System.Boolean,Discord.RequestOptions)"> <member name="M:Discord.Rest.RestVoiceChannel.CreateInviteAsync(System.Nullable{System.Int32},System.Nullable{System.Int32},System.Boolean,System.Boolean,Discord.RequestOptions)">
<inheritdoc /> <inheritdoc />
</member> </member>
<member name="M:Discord.Rest.RestVoiceChannel.CreateInviteToApplicationAsync(System.UInt64,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Boolean,System.Boolean,Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.Rest.RestVoiceChannel.CreateInviteToStreamAsync(Discord.IUser,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Boolean,System.Boolean,Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.Rest.RestVoiceChannel.GetInvitesAsync(Discord.RequestOptions)"> <member name="M:Discord.Rest.RestVoiceChannel.GetInvitesAsync(Discord.RequestOptions)">
<inheritdoc /> <inheritdoc />
</member> </member>
@@ -4052,6 +4076,9 @@
<member name="P:Discord.Rest.RestTeam.TeamMembers"> <member name="P:Discord.Rest.RestTeam.TeamMembers">
<inheritdoc /> <inheritdoc />
</member> </member>
<member name="P:Discord.Rest.RestTeam.Name">
<inheritdoc />
</member>
<member name="P:Discord.Rest.RestTeam.OwnerUserId"> <member name="P:Discord.Rest.RestTeam.OwnerUserId">
<inheritdoc /> <inheritdoc />
</member> </member>


+ 12
- 0
src/Discord.Net.WebSocket/Discord.Net.WebSocket.xml View File

@@ -2304,6 +2304,12 @@
<member name="M:Discord.WebSocket.SocketTextChannel.CreateInviteAsync(System.Nullable{System.Int32},System.Nullable{System.Int32},System.Boolean,System.Boolean,Discord.RequestOptions)"> <member name="M:Discord.WebSocket.SocketTextChannel.CreateInviteAsync(System.Nullable{System.Int32},System.Nullable{System.Int32},System.Boolean,System.Boolean,Discord.RequestOptions)">
<inheritdoc /> <inheritdoc />
</member> </member>
<member name="M:Discord.WebSocket.SocketTextChannel.CreateInviteToApplicationAsync(System.UInt64,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Boolean,System.Boolean,Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.WebSocket.SocketTextChannel.CreateInviteToStreamAsync(Discord.IUser,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Boolean,System.Boolean,Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.WebSocket.SocketTextChannel.GetInvitesAsync(Discord.RequestOptions)"> <member name="M:Discord.WebSocket.SocketTextChannel.GetInvitesAsync(Discord.RequestOptions)">
<inheritdoc /> <inheritdoc />
</member> </member>
@@ -2400,6 +2406,12 @@
<member name="M:Discord.WebSocket.SocketVoiceChannel.CreateInviteAsync(System.Nullable{System.Int32},System.Nullable{System.Int32},System.Boolean,System.Boolean,Discord.RequestOptions)"> <member name="M:Discord.WebSocket.SocketVoiceChannel.CreateInviteAsync(System.Nullable{System.Int32},System.Nullable{System.Int32},System.Boolean,System.Boolean,Discord.RequestOptions)">
<inheritdoc /> <inheritdoc />
</member> </member>
<member name="M:Discord.WebSocket.SocketVoiceChannel.CreateInviteToApplicationAsync(System.UInt64,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Boolean,System.Boolean,Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.WebSocket.SocketVoiceChannel.CreateInviteToStreamAsync(Discord.IUser,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Boolean,System.Boolean,Discord.RequestOptions)">
<inheritdoc />
</member>
<member name="M:Discord.WebSocket.SocketVoiceChannel.GetInvitesAsync(Discord.RequestOptions)"> <member name="M:Discord.WebSocket.SocketVoiceChannel.GetInvitesAsync(Discord.RequestOptions)">
<inheritdoc /> <inheritdoc />
</member> </member>


Loading…
Cancel
Save