Browse Source

Changed some xml docs

pull/1573/head
Paulo 4 years ago
parent
commit
8a7e533533
2 changed files with 51 additions and 51 deletions
  1. +24
    -24
      src/Discord.Net.Rest/Entities/Guilds/RestGuild.cs
  2. +27
    -27
      src/Discord.Net.WebSocket/Entities/Guilds/SocketGuild.cs

+ 24
- 24
src/Discord.Net.Rest/Entities/Guilds/RestGuild.cs View File

@@ -235,7 +235,7 @@ namespace Discord.Rest
=> GuildHelper.DeleteAsync(this, Discord, options); => GuildHelper.DeleteAsync(this, Discord, options);


/// <inheritdoc /> /// <inheritdoc />
/// <exception cref="ArgumentNullException"><paramref name="func"/> is <c>null</c>.</exception>
/// <exception cref="ArgumentNullException"><paramref name="func"/> is <see langword="null"/>.</exception>
public async Task ModifyAsync(Action<GuildProperties> func, RequestOptions options = null) public async Task ModifyAsync(Action<GuildProperties> func, RequestOptions options = null)
{ {
var model = await GuildHelper.ModifyAsync(this, Discord, func, options).ConfigureAwait(false); var model = await GuildHelper.ModifyAsync(this, Discord, func, options).ConfigureAwait(false);
@@ -243,7 +243,7 @@ namespace Discord.Rest
} }


/// <inheritdoc /> /// <inheritdoc />
/// <exception cref="ArgumentNullException"><paramref name="func"/> is <c>null</c>.</exception>
/// <exception cref="ArgumentNullException"><paramref name="func"/> is <see langword="null"/>.</exception>
[Obsolete("This endpoint is deprecated, use ModifyWidgetAsync instead.")] [Obsolete("This endpoint is deprecated, use ModifyWidgetAsync instead.")]
public async Task ModifyEmbedAsync(Action<GuildEmbedProperties> func, RequestOptions options = null) public async Task ModifyEmbedAsync(Action<GuildEmbedProperties> func, RequestOptions options = null)
{ {
@@ -252,7 +252,7 @@ namespace Discord.Rest
} }


/// <inheritdoc /> /// <inheritdoc />
/// <exception cref="ArgumentNullException"><paramref name="func"/> is <c>null</c>.</exception>
/// <exception cref="ArgumentNullException"><paramref name="func"/> is <see langword="null"/>.</exception>
public async Task ModifyWidgetAsync(Action<GuildWidgetProperties> func, RequestOptions options = null) public async Task ModifyWidgetAsync(Action<GuildWidgetProperties> func, RequestOptions options = null)
{ {
var model = await GuildHelper.ModifyWidgetAsync(this, Discord, func, options).ConfigureAwait(false); var model = await GuildHelper.ModifyWidgetAsync(this, Discord, func, options).ConfigureAwait(false);
@@ -260,7 +260,7 @@ namespace Discord.Rest
} }


/// <inheritdoc /> /// <inheritdoc />
/// <exception cref="ArgumentNullException"><paramref name="args" /> is <c>null</c>.</exception>
/// <exception cref="ArgumentNullException"><paramref name="args" /> is <see langword="null"/>.</exception>
public async Task ReorderChannelsAsync(IEnumerable<ReorderChannelProperties> args, RequestOptions options = null) public async Task ReorderChannelsAsync(IEnumerable<ReorderChannelProperties> args, RequestOptions options = null)
{ {
var arr = args.ToArray(); var arr = args.ToArray();
@@ -301,7 +301,7 @@ namespace Discord.Rest
/// <param name="options">The options to be used when sending the request.</param> /// <param name="options">The options to be used when sending the request.</param>
/// <returns> /// <returns>
/// A task that represents the asynchronous get operation. The task result contains a ban object, which /// A task that represents the asynchronous get operation. The task result contains a ban object, which
/// contains the user information and the reason for the ban; <c>null</c> if the ban entry cannot be found.
/// contains the user information and the reason for the ban; <see langword="null"/> if the ban entry cannot be found.
/// </returns> /// </returns>
public Task<RestBan> GetBanAsync(IUser user, RequestOptions options = null) public Task<RestBan> GetBanAsync(IUser user, RequestOptions options = null)
=> GuildHelper.GetBanAsync(this, Discord, user.Id, options); => GuildHelper.GetBanAsync(this, Discord, user.Id, options);
@@ -312,7 +312,7 @@ namespace Discord.Rest
/// <param name="options">The options to be used when sending the request.</param> /// <param name="options">The options to be used when sending the request.</param>
/// <returns> /// <returns>
/// A task that represents the asynchronous get operation. The task result contains a ban object, which /// A task that represents the asynchronous get operation. The task result contains a ban object, which
/// contains the user information and the reason for the ban; <c>null</c> if the ban entry cannot be found.
/// contains the user information and the reason for the ban; <see langword="null"/> if the ban entry cannot be found.
/// </returns> /// </returns>
public Task<RestBan> GetBanAsync(ulong userId, RequestOptions options = null) public Task<RestBan> GetBanAsync(ulong userId, RequestOptions options = null)
=> GuildHelper.GetBanAsync(this, Discord, userId, options); => GuildHelper.GetBanAsync(this, Discord, userId, options);
@@ -350,7 +350,7 @@ namespace Discord.Rest
/// <param name="options">The options to be used when sending the request.</param> /// <param name="options">The options to be used when sending the request.</param>
/// <returns> /// <returns>
/// A task that represents the asynchronous get operation. The task result contains the generic channel /// A task that represents the asynchronous get operation. The task result contains the generic channel
/// associated with the specified <paramref name="id"/>; <c>null</c> if none is found.
/// associated with the specified <paramref name="id"/>; <see langword="null"/> if none is found.
/// </returns> /// </returns>
public Task<RestGuildChannel> GetChannelAsync(ulong id, RequestOptions options = null) public Task<RestGuildChannel> GetChannelAsync(ulong id, RequestOptions options = null)
=> GuildHelper.GetChannelAsync(this, Discord, id, options); => GuildHelper.GetChannelAsync(this, Discord, id, options);
@@ -362,7 +362,7 @@ namespace Discord.Rest
/// <param name="options">The options to be used when sending the request.</param> /// <param name="options">The options to be used when sending the request.</param>
/// <returns> /// <returns>
/// A task that represents the asynchronous get operation. The task result contains the text channel /// A task that represents the asynchronous get operation. The task result contains the text channel
/// associated with the specified <paramref name="id"/>; <c>null</c> if none is found.
/// associated with the specified <paramref name="id"/>; <see langword="null"/> if none is found.
/// </returns> /// </returns>
public async Task<RestTextChannel> GetTextChannelAsync(ulong id, RequestOptions options = null) public async Task<RestTextChannel> GetTextChannelAsync(ulong id, RequestOptions options = null)
{ {
@@ -391,7 +391,7 @@ namespace Discord.Rest
/// <param name="options">The options to be used when sending the request.</param> /// <param name="options">The options to be used when sending the request.</param>
/// <returns> /// <returns>
/// A task that represents the asynchronous get operation. The task result contains the voice channel associated /// A task that represents the asynchronous get operation. The task result contains the voice channel associated
/// with the specified <paramref name="id"/>; <c>null</c> if none is found.
/// with the specified <paramref name="id"/>; <see langword="null"/> if none is found.
/// </returns> /// </returns>
public async Task<RestVoiceChannel> GetVoiceChannelAsync(ulong id, RequestOptions options = null) public async Task<RestVoiceChannel> GetVoiceChannelAsync(ulong id, RequestOptions options = null)
{ {
@@ -433,7 +433,7 @@ namespace Discord.Rest
/// <param name="options">The options to be used when sending the request.</param> /// <param name="options">The options to be used when sending the request.</param>
/// <returns> /// <returns>
/// A task that represents the asynchronous get operation. The task result contains the voice channel that the /// A task that represents the asynchronous get operation. The task result contains the voice channel that the
/// AFK users will be moved to after they have idled for too long; <c>null</c> if none is set.
/// AFK users will be moved to after they have idled for too long; <see langword="null"/> if none is set.
/// </returns> /// </returns>
public async Task<RestVoiceChannel> GetAFKChannelAsync(RequestOptions options = null) public async Task<RestVoiceChannel> GetAFKChannelAsync(RequestOptions options = null)
{ {
@@ -452,7 +452,7 @@ namespace Discord.Rest
/// <param name="options">The options to be used when sending the request.</param> /// <param name="options">The options to be used when sending the request.</param>
/// <returns> /// <returns>
/// A task that represents the asynchronous get operation. The task result contains the first viewable text /// A task that represents the asynchronous get operation. The task result contains the first viewable text
/// channel in this guild; <c>null</c> if none is found.
/// channel in this guild; <see langword="null"/> if none is found.
/// </returns> /// </returns>
public async Task<RestTextChannel> GetDefaultChannelAsync(RequestOptions options = null) public async Task<RestTextChannel> GetDefaultChannelAsync(RequestOptions options = null)
{ {
@@ -470,7 +470,7 @@ namespace Discord.Rest
/// <param name="options">The options to be used when sending the request.</param> /// <param name="options">The options to be used when sending the request.</param>
/// <returns> /// <returns>
/// A task that represents the asynchronous get operation. The task result contains the embed channel set /// A task that represents the asynchronous get operation. The task result contains the embed channel set
/// within the server's widget settings; <c>null</c> if none is set.
/// within the server's widget settings; <see langword="null"/> if none is set.
/// </returns> /// </returns>
[Obsolete("This endpoint is deprecated, use GetWidgetChannelAsync instead.")] [Obsolete("This endpoint is deprecated, use GetWidgetChannelAsync instead.")]
public async Task<RestGuildChannel> GetEmbedChannelAsync(RequestOptions options = null) public async Task<RestGuildChannel> GetEmbedChannelAsync(RequestOptions options = null)
@@ -487,7 +487,7 @@ namespace Discord.Rest
/// <param name="options">The options to be used when sending the request.</param> /// <param name="options">The options to be used when sending the request.</param>
/// <returns> /// <returns>
/// A task that represents the asynchronous get operation. The task result contains the widget channel set /// A task that represents the asynchronous get operation. The task result contains the widget channel set
/// within the server's widget settings; <c>null</c> if none is set.
/// within the server's widget settings; <see langword="null"/> if none is set.
/// </returns> /// </returns>
public async Task<RestGuildChannel> GetWidgetChannelAsync(RequestOptions options = null) public async Task<RestGuildChannel> GetWidgetChannelAsync(RequestOptions options = null)
{ {
@@ -503,7 +503,7 @@ namespace Discord.Rest
/// <param name="options">The options to be used when sending the request.</param> /// <param name="options">The options to be used when sending the request.</param>
/// <returns> /// <returns>
/// A task that represents the asynchronous get operation. The task result contains the text channel /// A task that represents the asynchronous get operation. The task result contains the text channel
/// where guild notices such as welcome messages and boost events are poste; <c>null</c> if none is found.
/// where guild notices such as welcome messages and boost events are poste; <see langword="null"/> if none is found.
/// </returns> /// </returns>
public async Task<RestTextChannel> GetSystemChannelAsync(RequestOptions options = null) public async Task<RestTextChannel> GetSystemChannelAsync(RequestOptions options = null)
{ {
@@ -517,12 +517,12 @@ namespace Discord.Rest
} }


/// <summary> /// <summary>
/// Gets the text channel where guilds with the "PUBLIC" feature can display rules and/or guidelines.
/// Gets the text channel where Community guilds can display rules and/or guidelines.
/// </summary> /// </summary>
/// <param name="options">The options to be used when sending the request.</param> /// <param name="options">The options to be used when sending the request.</param>
/// <returns> /// <returns>
/// A task that represents the asynchronous get operation. The task result contains the text channel /// A task that represents the asynchronous get operation. The task result contains the text channel
/// where guilds with the "PUBLIC" feature can display rules and/or guidelines; <c>null</c> if none is set.
/// where Community guilds can display rules and/or guidelines; <see langword="null"/> if none is set.
/// </returns> /// </returns>
public async Task<RestTextChannel> GetRulesChannelAsync(RequestOptions options = null) public async Task<RestTextChannel> GetRulesChannelAsync(RequestOptions options = null)
{ {
@@ -536,12 +536,12 @@ namespace Discord.Rest
} }


/// <summary> /// <summary>
/// Gets the text channel channel where admins and moderators of guilds with the "PUBLIC" feature receive notices from Discord.
/// Gets the text channel channel where admins and moderators of Community guilds receive notices from Discord.
/// </summary> /// </summary>
/// <param name="options">The options to be used when sending the request.</param> /// <param name="options">The options to be used when sending the request.</param>
/// <returns> /// <returns>
/// A task that represents the asynchronous get operation. The task result contains the text channel channel where /// A task that represents the asynchronous get operation. The task result contains the text channel channel where
/// admins and moderators of guilds with the "PUBLIC" feature receive notices from Discord; <c>null</c> if none is set.
/// admins and moderators of Community guilds receive notices from Discord; <see langword="null"/> if none is set.
/// </returns> /// </returns>
public async Task<RestTextChannel> GetPublicUpdatesChannelAsync(RequestOptions options = null) public async Task<RestTextChannel> GetPublicUpdatesChannelAsync(RequestOptions options = null)
{ {
@@ -585,7 +585,7 @@ namespace Discord.Rest
/// <param name="name">The name of the new channel.</param> /// <param name="name">The name of the new channel.</param>
/// <param name="func">The delegate containing the properties to be applied to the channel upon its creation.</param> /// <param name="func">The delegate containing the properties to be applied to the channel upon its creation.</param>
/// <param name="options">The options to be used when sending the request.</param> /// <param name="options">The options to be used when sending the request.</param>
/// <exception cref="ArgumentNullException"><paramref name="name" /> is <c>null</c>.</exception>
/// <exception cref="ArgumentNullException"><paramref name="name" /> is <see langword="null"/>.</exception>
/// <returns> /// <returns>
/// The created voice channel. /// The created voice channel.
/// </returns> /// </returns>
@@ -597,7 +597,7 @@ namespace Discord.Rest
/// <param name="name">The name of the new channel.</param> /// <param name="name">The name of the new channel.</param>
/// <param name="func">The delegate containing the properties to be applied to the channel upon its creation.</param> /// <param name="func">The delegate containing the properties to be applied to the channel upon its creation.</param>
/// <param name="options">The options to be used when sending the request.</param> /// <param name="options">The options to be used when sending the request.</param>
/// <exception cref="ArgumentNullException"><paramref name="name" /> is <c>null</c>.</exception>
/// <exception cref="ArgumentNullException"><paramref name="name" /> is <see langword="null"/>.</exception>
/// <returns> /// <returns>
/// The created category channel. /// The created category channel.
/// </returns> /// </returns>
@@ -648,7 +648,7 @@ namespace Discord.Rest
/// </summary> /// </summary>
/// <param name="id">The snowflake identifier for the role.</param> /// <param name="id">The snowflake identifier for the role.</param>
/// <returns> /// <returns>
/// A role that is associated with the specified <paramref name="id"/>; <c>null</c> if none is found.
/// A role that is associated with the specified <paramref name="id"/>; <see langword="null"/> if none is found.
/// </returns> /// </returns>
public RestRole GetRole(ulong id) public RestRole GetRole(ulong id)
{ {
@@ -712,7 +712,7 @@ namespace Discord.Rest
/// <param name="options">The options to be used when sending the request.</param> /// <param name="options">The options to be used when sending the request.</param>
/// <returns> /// <returns>
/// A task that represents the asynchronous get operation. The task result contains the guild user /// A task that represents the asynchronous get operation. The task result contains the guild user
/// associated with the specified <paramref name="id"/>; <c>null</c> if none is found.
/// associated with the specified <paramref name="id"/>; <see langword="null"/> if none is found.
/// </returns> /// </returns>
public Task<RestGuildUser> GetUserAsync(ulong id, RequestOptions options = null) public Task<RestGuildUser> GetUserAsync(ulong id, RequestOptions options = null)
=> GuildHelper.GetUserAsync(this, Discord, id, options); => GuildHelper.GetUserAsync(this, Discord, id, options);
@@ -802,7 +802,7 @@ namespace Discord.Rest
/// <param name="options">The options to be used when sending the request.</param> /// <param name="options">The options to be used when sending the request.</param>
/// <returns> /// <returns>
/// A task that represents the asynchronous get operation. The task result contains the webhook with the /// A task that represents the asynchronous get operation. The task result contains the webhook with the
/// specified <paramref name="id"/>; <c>null</c> if none is found.
/// specified <paramref name="id"/>; <see langword="null"/> if none is found.
/// </returns> /// </returns>
public Task<RestWebhook> GetWebhookAsync(ulong id, RequestOptions options = null) public Task<RestWebhook> GetWebhookAsync(ulong id, RequestOptions options = null)
=> GuildHelper.GetWebhookAsync(this, Discord, id, options); => GuildHelper.GetWebhookAsync(this, Discord, id, options);
@@ -835,7 +835,7 @@ namespace Discord.Rest
public Task<GuildEmote> CreateEmoteAsync(string name, Image image, Optional<IEnumerable<IRole>> roles = default(Optional<IEnumerable<IRole>>), RequestOptions options = null) public Task<GuildEmote> CreateEmoteAsync(string name, Image image, Optional<IEnumerable<IRole>> roles = default(Optional<IEnumerable<IRole>>), RequestOptions options = null)
=> GuildHelper.CreateEmoteAsync(this, Discord, name, image, roles, options); => GuildHelper.CreateEmoteAsync(this, Discord, name, image, roles, options);
/// <inheritdoc /> /// <inheritdoc />
/// <exception cref="ArgumentNullException"><paramref name="func"/> is <c>null</c>.</exception>
/// <exception cref="ArgumentNullException"><paramref name="func"/> is <see langword="null"/>.</exception>
public Task<GuildEmote> ModifyEmoteAsync(GuildEmote emote, Action<EmoteProperties> func, RequestOptions options = null) public Task<GuildEmote> ModifyEmoteAsync(GuildEmote emote, Action<EmoteProperties> func, RequestOptions options = null)
=> GuildHelper.ModifyEmoteAsync(this, Discord, emote.Id, func, options); => GuildHelper.ModifyEmoteAsync(this, Discord, emote.Id, func, options);
/// <inheritdoc /> /// <inheritdoc />


+ 27
- 27
src/Discord.Net.WebSocket/Entities/Guilds/SocketGuild.cs View File

@@ -167,7 +167,7 @@ namespace Discord.WebSocket
/// </summary> /// </summary>
/// <returns> /// <returns>
/// A <see cref="SocketVoiceChannel" /> that the AFK users will be moved to after they have idled for too /// A <see cref="SocketVoiceChannel" /> that the AFK users will be moved to after they have idled for too
/// long; <c>null</c> if none is set.
/// long; <see langword="null"/> if none is set.
/// </returns> /// </returns>
public SocketVoiceChannel AFKChannel public SocketVoiceChannel AFKChannel
{ {
@@ -181,7 +181,7 @@ namespace Discord.WebSocket
/// Gets the embed channel (i.e. the channel set in the guild's widget settings) in this guild. /// Gets the embed channel (i.e. the channel set in the guild's widget settings) in this guild.
/// </summary> /// </summary>
/// <returns> /// <returns>
/// A channel set within the server's widget settings; <c>null</c> if none is set.
/// A channel set within the server's widget settings; <see langword="null"/> if none is set.
/// </returns> /// </returns>
[Obsolete("This property is deprecated, use WidgetChannel instead.")] [Obsolete("This property is deprecated, use WidgetChannel instead.")]
public SocketGuildChannel EmbedChannel public SocketGuildChannel EmbedChannel
@@ -196,7 +196,7 @@ namespace Discord.WebSocket
/// Gets the widget channel (i.e. the channel set in the guild's widget settings) in this guild. /// Gets the widget channel (i.e. the channel set in the guild's widget settings) in this guild.
/// </summary> /// </summary>
/// <returns> /// <returns>
/// A channel set within the server's widget settings; <c>null</c> if none is set.
/// A channel set within the server's widget settings; <see langword="null"/> if none is set.
/// </returns> /// </returns>
public SocketGuildChannel WidgetChannel public SocketGuildChannel WidgetChannel
{ {
@@ -210,7 +210,7 @@ namespace Discord.WebSocket
/// Gets the system channel where randomized welcome messages are sent in this guild. /// Gets the system channel where randomized welcome messages are sent in this guild.
/// </summary> /// </summary>
/// <returns> /// <returns>
/// A text channel where randomized welcome messages will be sent to; <c>null</c> if none is set.
/// A text channel where randomized welcome messages will be sent to; <see langword="null"/> if none is set.
/// </returns> /// </returns>
public SocketTextChannel SystemChannel public SocketTextChannel SystemChannel
{ {
@@ -224,7 +224,7 @@ namespace Discord.WebSocket
/// Gets the channel with the guild rules. /// Gets the channel with the guild rules.
/// </summary> /// </summary>
/// <returns> /// <returns>
/// A text channel with the guild rules; <c>null</c> if none is set.
/// A text channel with the guild rules; <see langword="null"/> if none is set.
/// </returns> /// </returns>
public SocketTextChannel RulesChannel public SocketTextChannel RulesChannel
{ {
@@ -235,12 +235,12 @@ namespace Discord.WebSocket
} }
} }
/// <summary> /// <summary>
/// Gets the channel where admins and moderators of guilds with the "PUBLIC"
/// feature receive notices from Discord.
/// Gets the channel where admins and moderators of Community guilds receive
/// notices from Discord.
/// </summary> /// </summary>
/// <returns> /// <returns>
/// A text channel where admins and moderators of guilds with the "PUBLIC"
/// feature receive notices from Discord; <c>null</c> if none is set.
/// A text channel where admins and moderators of Community guilds receive
/// notices from Discord; <see langword="null"/> if none is set.
/// </returns> /// </returns>
public SocketTextChannel PublicUpdatesChannel public SocketTextChannel PublicUpdatesChannel
{ {
@@ -523,17 +523,17 @@ namespace Discord.WebSocket
=> GuildHelper.DeleteAsync(this, Discord, options); => GuildHelper.DeleteAsync(this, Discord, options);


/// <inheritdoc /> /// <inheritdoc />
/// <exception cref="ArgumentNullException"><paramref name="func"/> is <c>null</c>.</exception>
/// <exception cref="ArgumentNullException"><paramref name="func"/> is <see langword="null"/>.</exception>
public Task ModifyAsync(Action<GuildProperties> func, RequestOptions options = null) public Task ModifyAsync(Action<GuildProperties> func, RequestOptions options = null)
=> GuildHelper.ModifyAsync(this, Discord, func, options); => GuildHelper.ModifyAsync(this, Discord, func, options);


/// <inheritdoc /> /// <inheritdoc />
/// <exception cref="ArgumentNullException"><paramref name="func"/> is <c>null</c>.</exception>
/// <exception cref="ArgumentNullException"><paramref name="func"/> is <see langword="null"/>.</exception>
[Obsolete("This endpoint is deprecated, use ModifyWidgetAsync instead.")] [Obsolete("This endpoint is deprecated, use ModifyWidgetAsync instead.")]
public Task ModifyEmbedAsync(Action<GuildEmbedProperties> func, RequestOptions options = null) public Task ModifyEmbedAsync(Action<GuildEmbedProperties> func, RequestOptions options = null)
=> GuildHelper.ModifyEmbedAsync(this, Discord, func, options); => GuildHelper.ModifyEmbedAsync(this, Discord, func, options);
/// <inheritdoc /> /// <inheritdoc />
/// <exception cref="ArgumentNullException"><paramref name="func"/> is <c>null</c>.</exception>
/// <exception cref="ArgumentNullException"><paramref name="func"/> is <see langword="null"/>.</exception>
public Task ModifyWidgetAsync(Action<GuildWidgetProperties> func, RequestOptions options = null) public Task ModifyWidgetAsync(Action<GuildWidgetProperties> func, RequestOptions options = null)
=> GuildHelper.ModifyWidgetAsync(this, Discord, func, options); => GuildHelper.ModifyWidgetAsync(this, Discord, func, options);
/// <inheritdoc /> /// <inheritdoc />
@@ -566,7 +566,7 @@ namespace Discord.WebSocket
/// <param name="options">The options to be used when sending the request.</param> /// <param name="options">The options to be used when sending the request.</param>
/// <returns> /// <returns>
/// A task that represents the asynchronous get operation. The task result contains a ban object, which /// A task that represents the asynchronous get operation. The task result contains a ban object, which
/// contains the user information and the reason for the ban; <c>null</c> if the ban entry cannot be found.
/// contains the user information and the reason for the ban; <see langword="null"/> if the ban entry cannot be found.
/// </returns> /// </returns>
public Task<RestBan> GetBanAsync(IUser user, RequestOptions options = null) public Task<RestBan> GetBanAsync(IUser user, RequestOptions options = null)
=> GuildHelper.GetBanAsync(this, Discord, user.Id, options); => GuildHelper.GetBanAsync(this, Discord, user.Id, options);
@@ -577,7 +577,7 @@ namespace Discord.WebSocket
/// <param name="options">The options to be used when sending the request.</param> /// <param name="options">The options to be used when sending the request.</param>
/// <returns> /// <returns>
/// A task that represents the asynchronous get operation. The task result contains a ban object, which /// A task that represents the asynchronous get operation. The task result contains a ban object, which
/// contains the user information and the reason for the ban; <c>null</c> if the ban entry cannot be found.
/// contains the user information and the reason for the ban; <see langword="null"/> if the ban entry cannot be found.
/// </returns> /// </returns>
public Task<RestBan> GetBanAsync(ulong userId, RequestOptions options = null) public Task<RestBan> GetBanAsync(ulong userId, RequestOptions options = null)
=> GuildHelper.GetBanAsync(this, Discord, userId, options); => GuildHelper.GetBanAsync(this, Discord, userId, options);
@@ -602,7 +602,7 @@ namespace Discord.WebSocket
/// </summary> /// </summary>
/// <param name="id">The snowflake identifier for the channel.</param> /// <param name="id">The snowflake identifier for the channel.</param>
/// <returns> /// <returns>
/// A generic channel associated with the specified <paramref name="id" />; <c>null</c> if none is found.
/// A generic channel associated with the specified <paramref name="id" />; <see langword="null"/> if none is found.
/// </returns> /// </returns>
public SocketGuildChannel GetChannel(ulong id) public SocketGuildChannel GetChannel(ulong id)
{ {
@@ -616,7 +616,7 @@ namespace Discord.WebSocket
/// </summary> /// </summary>
/// <param name="id">The snowflake identifier for the text channel.</param> /// <param name="id">The snowflake identifier for the text channel.</param>
/// <returns> /// <returns>
/// A text channel associated with the specified <paramref name="id" />; <c>null</c> if none is found.
/// A text channel associated with the specified <paramref name="id" />; <see langword="null"/> if none is found.
/// </returns> /// </returns>
public SocketTextChannel GetTextChannel(ulong id) public SocketTextChannel GetTextChannel(ulong id)
=> GetChannel(id) as SocketTextChannel; => GetChannel(id) as SocketTextChannel;
@@ -625,7 +625,7 @@ namespace Discord.WebSocket
/// </summary> /// </summary>
/// <param name="id">The snowflake identifier for the voice channel.</param> /// <param name="id">The snowflake identifier for the voice channel.</param>
/// <returns> /// <returns>
/// A voice channel associated with the specified <paramref name="id" />; <c>null</c> if none is found.
/// A voice channel associated with the specified <paramref name="id" />; <see langword="null"/> if none is found.
/// </returns> /// </returns>
public SocketVoiceChannel GetVoiceChannel(ulong id) public SocketVoiceChannel GetVoiceChannel(ulong id)
=> GetChannel(id) as SocketVoiceChannel; => GetChannel(id) as SocketVoiceChannel;
@@ -634,7 +634,7 @@ namespace Discord.WebSocket
/// </summary> /// </summary>
/// <param name="id">The snowflake identifier for the category channel.</param> /// <param name="id">The snowflake identifier for the category channel.</param>
/// <returns> /// <returns>
/// A category channel associated with the specified <paramref name="id" />; <c>null</c> if none is found.
/// A category channel associated with the specified <paramref name="id" />; <see langword="null"/> if none is found.
/// </returns> /// </returns>
public SocketCategoryChannel GetCategoryChannel(ulong id) public SocketCategoryChannel GetCategoryChannel(ulong id)
=> GetChannel(id) as SocketCategoryChannel; => GetChannel(id) as SocketCategoryChannel;
@@ -670,7 +670,7 @@ namespace Discord.WebSocket
/// <param name="name">The new name for the voice channel.</param> /// <param name="name">The new name for the voice channel.</param>
/// <param name="func">The delegate containing the properties to be applied to the channel upon its creation.</param> /// <param name="func">The delegate containing the properties to be applied to the channel upon its creation.</param>
/// <param name="options">The options to be used when sending the request.</param> /// <param name="options">The options to be used when sending the request.</param>
/// <exception cref="ArgumentNullException"><paramref name="name"/> is <c>null</c>.</exception>
/// <exception cref="ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
/// <returns> /// <returns>
/// A task that represents the asynchronous creation operation. The task result contains the newly created /// A task that represents the asynchronous creation operation. The task result contains the newly created
/// voice channel. /// voice channel.
@@ -683,7 +683,7 @@ namespace Discord.WebSocket
/// <param name="name">The new name for the category.</param> /// <param name="name">The new name for the category.</param>
/// <param name="func">The delegate containing the properties to be applied to the channel upon its creation.</param> /// <param name="func">The delegate containing the properties to be applied to the channel upon its creation.</param>
/// <param name="options">The options to be used when sending the request.</param> /// <param name="options">The options to be used when sending the request.</param>
/// <exception cref="ArgumentNullException"><paramref name="name"/> is <c>null</c>.</exception>
/// <exception cref="ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
/// <returns> /// <returns>
/// A task that represents the asynchronous creation operation. The task result contains the newly created /// A task that represents the asynchronous creation operation. The task result contains the newly created
/// category channel. /// category channel.
@@ -747,7 +747,7 @@ namespace Discord.WebSocket
/// <param name="options">The options to be used when sending the request.</param> /// <param name="options">The options to be used when sending the request.</param>
/// <returns> /// <returns>
/// A task that represents the asynchronous get operation. The task result contains the partial metadata of /// A task that represents the asynchronous get operation. The task result contains the partial metadata of
/// the vanity invite found within this guild; <c>null</c> if none is found.
/// the vanity invite found within this guild; <see langword="null"/> if none is found.
/// </returns> /// </returns>
public Task<RestInviteMetadata> GetVanityInviteAsync(RequestOptions options = null) public Task<RestInviteMetadata> GetVanityInviteAsync(RequestOptions options = null)
=> GuildHelper.GetVanityInviteAsync(this, Discord, options); => GuildHelper.GetVanityInviteAsync(this, Discord, options);
@@ -758,7 +758,7 @@ namespace Discord.WebSocket
/// </summary> /// </summary>
/// <param name="id">The snowflake identifier for the role.</param> /// <param name="id">The snowflake identifier for the role.</param>
/// <returns> /// <returns>
/// A role that is associated with the specified <paramref name="id"/>; <c>null</c> if none is found.
/// A role that is associated with the specified <paramref name="id"/>; <see langword="null"/> if none is found.
/// </returns> /// </returns>
public SocketRole GetRole(ulong id) public SocketRole GetRole(ulong id)
{ {
@@ -780,7 +780,7 @@ namespace Discord.WebSocket
/// <param name="isHoisted">Whether the role is separated from others on the sidebar.</param> /// <param name="isHoisted">Whether the role is separated from others on the sidebar.</param>
/// <param name="isMentionable">Whether the role can be mentioned.</param> /// <param name="isMentionable">Whether the role can be mentioned.</param>
/// <param name="options">The options to be used when sending the request.</param> /// <param name="options">The options to be used when sending the request.</param>
/// <exception cref="ArgumentNullException"><paramref name="name"/> is <c>null</c>.</exception>
/// <exception cref="ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
/// <returns> /// <returns>
/// A task that represents the asynchronous creation operation. The task result contains the newly created /// A task that represents the asynchronous creation operation. The task result contains the newly created
/// role. /// role.
@@ -812,13 +812,13 @@ namespace Discord.WebSocket
/// <remarks> /// <remarks>
/// This method retrieves a user found within this guild. /// This method retrieves a user found within this guild.
/// <note> /// <note>
/// This may return <c>null</c> in the WebSocket implementation due to incomplete user collection in
/// This may return <see langword="null"/> in the WebSocket implementation due to incomplete user collection in
/// large guilds. /// large guilds.
/// </note> /// </note>
/// </remarks> /// </remarks>
/// <param name="id">The snowflake identifier of the user.</param> /// <param name="id">The snowflake identifier of the user.</param>
/// <returns> /// <returns>
/// A guild user associated with the specified <paramref name="id"/>; <c>null</c> if none is found.
/// A guild user associated with the specified <paramref name="id"/>; <see langword="null"/> if none is found.
/// </returns> /// </returns>
public SocketGuildUser GetUser(ulong id) public SocketGuildUser GetUser(ulong id)
{ {
@@ -972,7 +972,7 @@ namespace Discord.WebSocket
/// <param name="options">The options to be used when sending the request.</param> /// <param name="options">The options to be used when sending the request.</param>
/// <returns> /// <returns>
/// A task that represents the asynchronous get operation. The task result contains the webhook with the /// A task that represents the asynchronous get operation. The task result contains the webhook with the
/// specified <paramref name="id"/>; <c>null</c> if none is found.
/// specified <paramref name="id"/>; <see langword="null"/> if none is found.
/// </returns> /// </returns>
public Task<RestWebhook> GetWebhookAsync(ulong id, RequestOptions options = null) public Task<RestWebhook> GetWebhookAsync(ulong id, RequestOptions options = null)
=> GuildHelper.GetWebhookAsync(this, Discord, id, options); => GuildHelper.GetWebhookAsync(this, Discord, id, options);
@@ -995,7 +995,7 @@ namespace Discord.WebSocket
public Task<GuildEmote> CreateEmoteAsync(string name, Image image, Optional<IEnumerable<IRole>> roles = default(Optional<IEnumerable<IRole>>), RequestOptions options = null) public Task<GuildEmote> CreateEmoteAsync(string name, Image image, Optional<IEnumerable<IRole>> roles = default(Optional<IEnumerable<IRole>>), RequestOptions options = null)
=> GuildHelper.CreateEmoteAsync(this, Discord, name, image, roles, options); => GuildHelper.CreateEmoteAsync(this, Discord, name, image, roles, options);
/// <inheritdoc /> /// <inheritdoc />
/// <exception cref="ArgumentNullException"><paramref name="func"/> is <c>null</c>.</exception>
/// <exception cref="ArgumentNullException"><paramref name="func"/> is <see langword="null"/>.</exception>
public Task<GuildEmote> ModifyEmoteAsync(GuildEmote emote, Action<EmoteProperties> func, RequestOptions options = null) public Task<GuildEmote> ModifyEmoteAsync(GuildEmote emote, Action<EmoteProperties> func, RequestOptions options = null)
=> GuildHelper.ModifyEmoteAsync(this, Discord, emote.Id, func, options); => GuildHelper.ModifyEmoteAsync(this, Discord, emote.Id, func, options);
/// <inheritdoc /> /// <inheritdoc />


Loading…
Cancel
Save