Browse Source

Add further documentation for MessageActivity and MessageApplication

pull/1218/head
Still Hsu 6 years ago
parent
commit
10aa922b89
No known key found for this signature in database GPG Key ID: 8601A145FDA95209
3 changed files with 14 additions and 13 deletions
  1. +4
    -3
      src/Discord.Net.Core/Entities/Messages/IMessage.cs
  2. +10
    -5
      src/Discord.Net.Core/Entities/Messages/MessageActivity.cs
  3. +0
    -5
      src/Discord.Net.Core/Entities/Messages/MessageApplication.cs

+ 4
- 3
src/Discord.Net.Core/Entities/Messages/IMessage.cs View File

@@ -111,17 +111,18 @@ namespace Discord
/// </returns> /// </returns>
IReadOnlyCollection<ulong> MentionedUserIds { get; } IReadOnlyCollection<ulong> MentionedUserIds { get; }
/// <summary> /// <summary>
/// Returns the Activity associated with a message.
/// Gets the activity associated with a message.
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// Sent with Rich Presence-related chat embeds.
/// Sent with Rich Presence-related chat embeds. This often refers to activity that requires end-user's
/// interaction, such as a Spotify Invite activity.
/// </remarks> /// </remarks>
/// <returns> /// <returns>
/// A message's activity, if any is associated. /// A message's activity, if any is associated.
/// </returns> /// </returns>
MessageActivity Activity { get; } MessageActivity Activity { get; }
/// <summary> /// <summary>
/// Returns the Application associated with a messsage.
/// Gets the application associated with a message.
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// Sent with Rich-Presence-related chat embeds. /// Sent with Rich-Presence-related chat embeds.


+ 10
- 5
src/Discord.Net.Core/Entities/Messages/MessageActivity.cs View File

@@ -1,12 +1,17 @@
using System;
using System.Collections.Generic;
using System.Diagnostics; using System.Diagnostics;
using System.Linq;
using System.Text;
using System.Threading.Tasks;


namespace Discord namespace Discord
{ {
/// <summary>
/// An activity object found in a sent message.
/// </summary>
/// <remarks>
/// <para>
/// This class refers to an activity object, visually similar to an embed within a message. However, a message
/// activity is interactive as opposed to a standard static embed.
/// </para>
/// <para>For example, a Spotify party invitation counts as a message activity.</para>
/// </remarks>
[DebuggerDisplay(@"{DebuggerDisplay,nq}")] [DebuggerDisplay(@"{DebuggerDisplay,nq}")]
public class MessageActivity public class MessageActivity
{ {


+ 0
- 5
src/Discord.Net.Core/Entities/Messages/MessageApplication.cs View File

@@ -1,9 +1,4 @@
using System;
using System.Collections.Generic;
using System.Diagnostics; using System.Diagnostics;
using System.Linq;
using System.Text;
using System.Threading.Tasks;


namespace Discord namespace Discord
{ {


Loading…
Cancel
Save