@@ -63,12 +63,12 @@ namespace Discord.WebSocket | |||||
/// </returns> | /// </returns> | ||||
public abstract Task<RestApplication> GetApplicationInfoAsync(RequestOptions options = null); | public abstract Task<RestApplication> GetApplicationInfoAsync(RequestOptions options = null); | ||||
/// <summary> | /// <summary> | ||||
/// Gets a user. | |||||
/// Gets a generic user. | |||||
/// </summary> | /// </summary> | ||||
/// <param name="id">The user snowflake ID.</param> | /// <param name="id">The user snowflake ID.</param> | ||||
/// <remarks> | /// <remarks> | ||||
/// This method gets the user present in the WebSocket cache with the given condition. | /// This method gets the user present in the WebSocket cache with the given condition. | ||||
/// <note> | |||||
/// <note type="warning"> | |||||
/// Sometimes a user may return <c>null</c> due to Discord not sending offline users in large | /// Sometimes a user may return <c>null</c> due to Discord not sending offline users in large | ||||
/// guilds (i.e. guild with 100+ members) actively. To download users on startup, consider enabling | /// guilds (i.e. guild with 100+ members) actively. To download users on startup, consider enabling | ||||
/// <see cref="DiscordSocketConfig.AlwaysDownloadUsers"/>. | /// <see cref="DiscordSocketConfig.AlwaysDownloadUsers"/>. | ||||
@@ -90,7 +90,7 @@ namespace Discord.WebSocket | |||||
/// <param name="discriminator">The discriminator value of the user.</param> | /// <param name="discriminator">The discriminator value of the user.</param> | ||||
/// <remarks> | /// <remarks> | ||||
/// This method gets the user present in the WebSocket cache with the given condition. | /// This method gets the user present in the WebSocket cache with the given condition. | ||||
/// <note> | |||||
/// <note type="warning"> | |||||
/// Sometimes a user may return <c>null</c> due to Discord not sending offline users in large | /// Sometimes a user may return <c>null</c> due to Discord not sending offline users in large | ||||
/// guilds (i.e. guild with 100+ members) actively. To download users on startup, consider enabling | /// guilds (i.e. guild with 100+ members) actively. To download users on startup, consider enabling | ||||
/// <see cref="DiscordSocketConfig.AlwaysDownloadUsers"/>. | /// <see cref="DiscordSocketConfig.AlwaysDownloadUsers"/>. | ||||
@@ -44,15 +44,11 @@ namespace Discord.WebSocket | |||||
//User | //User | ||||
/// <summary> | /// <summary> | ||||
/// Gets the user from the WebSocket cache. | |||||
/// Gets a generic user from this channel. | |||||
/// </summary> | /// </summary> | ||||
/// <remarks> | |||||
/// This method does NOT attempt to fetch the user if they don't exist in the cache. To guarantee a return | |||||
/// from an existing user that doesn't exist in cache, use <see cref="Rest.DiscordRestClient.GetUserAsync"/>. | |||||
/// </remarks> | |||||
/// <param name="id">The snowflake identifier of the user.</param> | /// <param name="id">The snowflake identifier of the user.</param> | ||||
/// <returns> | /// <returns> | ||||
/// A user object associated with the snowflake identifier. | |||||
/// A generic WebSocket-based user associated with the snowflake identifier. | |||||
/// </returns> | /// </returns> | ||||
public SocketUser GetUser(ulong id) => GetUserInternal(id); | public SocketUser GetUser(ulong id) => GetUserInternal(id); | ||||
internal abstract SocketUser GetUserInternal(ulong id); | internal abstract SocketUser GetUserInternal(ulong id); | ||||
@@ -138,15 +138,11 @@ namespace Discord.WebSocket | |||||
//Users | //Users | ||||
/// <summary> | /// <summary> | ||||
/// Gets the group user from the WebSocket cache. | |||||
/// Gets a user from this group. | |||||
/// </summary> | /// </summary> | ||||
/// <remarks> | |||||
/// This method does NOT attempt to fetch the user if they don't exist in the cache. To guarantee a return | |||||
/// from an existing user that doesn't exist in cache, use <see cref="DiscordRestClient.GetUserAsync"/>. | |||||
/// </remarks> | |||||
/// <param name="id">The snowflake identifier of the user.</param> | /// <param name="id">The snowflake identifier of the user.</param> | ||||
/// <returns> | /// <returns> | ||||
/// The user in the group. | |||||
/// A WebSocket-based group user associated with the snowflake identifier. | |||||
/// </returns> | /// </returns> | ||||
public new SocketGroupUser GetUser(ulong id) | public new SocketGroupUser GetUser(ulong id) | ||||
{ | { | ||||
@@ -582,11 +582,11 @@ namespace Discord.WebSocket | |||||
//Users | //Users | ||||
/// <summary> | /// <summary> | ||||
/// Gets the user with the provided ID. | |||||
/// Gets a user from this guild. | |||||
/// </summary> | /// </summary> | ||||
/// <param name="id">The ID of the user.</param> | |||||
/// <param name="id">The snowflake identifier of the user (e.g. `168693960628371456`).</param> | |||||
/// <returns> | /// <returns> | ||||
/// The user associated with the ID. | |||||
/// A WebSocket-based guild user associated with the snowflake identifier. | |||||
/// </returns> | /// </returns> | ||||
public SocketGuildUser GetUser(ulong id) | public SocketGuildUser GetUser(ulong id) | ||||
{ | { | ||||
@@ -18,8 +18,9 @@ namespace Discord.WebSocket | |||||
/// Gets the user who added the reaction if possible. | /// Gets the user who added the reaction if possible. | ||||
/// </summary> | /// </summary> | ||||
/// <returns> | /// <returns> | ||||
/// A user object where possible. This value is not always returned. | |||||
/// A user object where possible; a value is not always returned. | |||||
/// </returns> | /// </returns> | ||||
/// <seealso cref="Optional{T}"/> | |||||
public Optional<IUser> User { get; } | public Optional<IUser> User { get; } | ||||
/// <summary> | /// <summary> | ||||
/// Gets the ID of the message that has been reacted to. | /// Gets the ID of the message that has been reacted to. | ||||