Still Hsu 7 years ago
parent
commit
9cc4f13456
No known key found for this signature in database GPG Key ID: 8601A145FDA95209
2 changed files with 42 additions and 16 deletions
  1. +41
    -15
      src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs
  2. +1
    -1
      src/Discord.Net.Core/Entities/Guilds/IntegrationAccount.cs

+ 41
- 15
src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs View File

@@ -2,30 +2,56 @@ using System;

namespace Discord
{
/// <summary>
/// Holds information for a guild integration feature.
/// </summary>
public interface IGuildIntegration
{
/// <summary> Gets the integration ID. </summary>
/// <returns> An <see cref="ulong"/> representing the unique identifier value of this integration. </returns>
/// <summary>
/// Gets the integration ID.
/// </summary>
/// <returns>
/// An <see cref="UInt64"/> representing the unique identifier value of this integration.
/// </returns>
ulong Id { get; }
/// <summary> Gets the integration name. </summary>
/// <returns> A string containing the name of this integration. </returns>
/// <summary>
/// Gets the integration name.
/// </summary>
/// <returns>
/// A string containing the name of this integration.
/// </returns>
string Name { get; }
/// <summary> Gets the integration type (twitch, youtube, etc). </summary>
/// <returns> A string containing the name of the type of integration. </returns>
/// <summary>
/// Gets the integration type (Twitch, YouTube, etc).
/// </summary>
/// <returns>
/// A string containing the name of the type of integration.
/// </returns>
string Type { get; }
/// <summary> Gets if this integration is enabled or not. </summary>
/// <summary> A value indicating if this integration is enabled. </returns>
/// <summary>
/// Gets a value that indicates whether this integration is enabled or not.
/// </summary>
/// <returns>
/// <c>true</c> if this integration is enabled; otherwise <c>false</c>.
/// </returns>
bool IsEnabled { get; }
/// <summary> Gets if this integration is syncing or not. </summary>
/// <returns> A value indicating if this integration is syncing. </returns>
/// <summary>
/// Gets a value that indicates whether this integration is syncing or not.
/// </summary>
/// <remarks>
/// An integration with syncing enabled will update its "subscribers" on
/// an interval, while one with syncing disabled will not.
/// A user must manually choose when sync the integration
/// if syncing is disabled.
/// An integration with syncing enabled will update its "subscribers" on an interval, while one with syncing
/// disabled will not. A user must manually choose when sync the integration if syncing is disabled.
/// </remarks>
/// <returns>
/// <c>true</c> if this integration is syncing; otherwise <c>false</c>.
/// </returns>
bool IsSyncing { get; }
/// <summary> Gets the ID that this integration uses for "subscribers". </summary>
/// <summary>
/// Gets the ID that this integration uses for "subscribers".
/// </summary>
/// <returns>
/// A
/// </returns>
ulong ExpireBehavior { get; }
/// <summary> Gets the grace period before expiring "subscribers". </summary>
ulong ExpireGracePeriod { get; }


+ 1
- 1
src/Discord.Net.Core/Entities/Guilds/IntegrationAccount.cs View File

@@ -6,7 +6,7 @@ namespace Discord
public struct IntegrationAccount
{
/// <summary> Gets the ID of the account. </summary>
/// <returns> A <see cref="string"> unique identifier of this integration account. </returns>
/// <returns> A <see cref="string"/> unique identifier of this integration account. </returns>
public string Id { get; }
/// <summary> Gets the name of the account. </summary>
/// <returns> A string containing the name of this integration account. </returns>


Loading…
Cancel
Save