Added Message documentation
This commit is contained in:
@@ -18,28 +18,43 @@ namespace Discord
|
|||||||
|
|
||||||
private readonly DiscordClient _client;
|
private readonly DiscordClient _client;
|
||||||
|
|
||||||
|
/// <summary> Returns the unique identifier for this message. </summary>
|
||||||
public string Id { get; }
|
public string Id { get; }
|
||||||
|
|
||||||
|
/// <summary> Returns true if the logged-in user was mentioned. </summary>
|
||||||
|
/// <remarks> This is not set to true if the user was mentioned with @everyone (see IsMentioningEverone). </remarks>
|
||||||
public bool IsMentioningMe { get; internal set; }
|
public bool IsMentioningMe { get; internal set; }
|
||||||
|
/// <summary> Returns true if @everyone was mentioned by someone with permissions to do so. </summary>
|
||||||
public bool IsMentioningEveryone { get; internal set; }
|
public bool IsMentioningEveryone { get; internal set; }
|
||||||
|
/// <summary> Returns true if the message was sent as text-to-speech by someone with permissions to do so. </summary>
|
||||||
public bool IsTTS { get; internal set; }
|
public bool IsTTS { get; internal set; }
|
||||||
|
/// <summary> Returns the content of this message. </summary>
|
||||||
public string Text { get; internal set; }
|
public string Text { get; internal set; }
|
||||||
|
/// <summary> Returns the timestamp of this message. </summary>
|
||||||
public DateTime Timestamp { get; internal set; }
|
public DateTime Timestamp { get; internal set; }
|
||||||
|
/// <summary> Returns the attachments included in this message. </summary>
|
||||||
public Attachment[] Attachments { get; internal set; }
|
public Attachment[] Attachments { get; internal set; }
|
||||||
|
|
||||||
|
/// <summary> Returns a collection of all user ids mentioned in this message. </summary>
|
||||||
public string[] MentionIds { get; internal set; }
|
public string[] MentionIds { get; internal set; }
|
||||||
|
/// <summary> Returns a collection of all users mentioned in this message. </summary>
|
||||||
[JsonIgnore]
|
[JsonIgnore]
|
||||||
public IEnumerable<User> Mentions => MentionIds.Select(x => _client.GetUser(x)).Where(x => x != null);
|
public IEnumerable<User> Mentions => MentionIds.Select(x => _client.GetUser(x)).Where(x => x != null);
|
||||||
|
|
||||||
|
/// <summary> Returns the id of the channel this message was sent in. </summary>
|
||||||
public string ChannelId { get; }
|
public string ChannelId { get; }
|
||||||
|
/// <summary> Returns the the channel this message was sent in. </summary>
|
||||||
[JsonIgnore]
|
[JsonIgnore]
|
||||||
public Channel Channel => _client.GetChannel(ChannelId);
|
public Channel Channel => _client.GetChannel(ChannelId);
|
||||||
|
|
||||||
|
/// <summary> Returns the id of the author of this message. </summary>
|
||||||
public string UserId { get; internal set; }
|
public string UserId { get; internal set; }
|
||||||
|
/// <summary> Returns the author of this message. </summary>
|
||||||
[JsonIgnore]
|
[JsonIgnore]
|
||||||
public User User => _client.GetUser(UserId);
|
public User User => _client.GetUser(UserId);
|
||||||
|
|
||||||
//Not Implemented
|
//TODO: Not Implemented
|
||||||
|
/// <summary> Not implemented, stored for reference. </summary>
|
||||||
public object[] Embeds { get; internal set; }
|
public object[] Embeds { get; internal set; }
|
||||||
|
|
||||||
internal Message(string id, string channelId, DiscordClient client)
|
internal Message(string id, string channelId, DiscordClient client)
|
||||||
|
|||||||
Reference in New Issue
Block a user