Browse Source

Added minimal descriptions from the API documentation for Integration types

pull/1161/head
Chris Johnston 7 years ago
parent
commit
8dc6f2efad
2 changed files with 35 additions and 2 deletions
  1. +28
    -1
      src/Discord.Net.Core/Entities/Guilds/IGuildIntegration.cs
  2. +7
    -1
      src/Discord.Net.Core/Entities/Guilds/IntegrationAccount.cs

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

@@ -1,17 +1,44 @@
using System;
using System;


namespace Discord namespace Discord
{ {
public interface IGuildIntegration public interface IGuildIntegration
{ {
/// <summary>
/// The integration ID.
/// </summary>
ulong Id { get; } ulong Id { get; }
/// <summary>
/// The integration name.
/// </summary>
string Name { get; } string Name { get; }
/// <summary>
/// The integration type (twich, youtube, etc).
/// </summary>
string Type { get; } string Type { get; }
/// <summary>
/// Is this integration enabled?
/// </summary>
bool IsEnabled { get; } bool IsEnabled { get; }
/// <summary>
/// Is this integration syncing?
/// </summary>
bool IsSyncing { get; } bool IsSyncing { get; }
/// <summary>
/// ID that this integration uses for "subscribers".
/// </summary>
ulong ExpireBehavior { get; } ulong ExpireBehavior { get; }
/// <summary>
/// The grace period before expiring subscribers.
/// </summary>
ulong ExpireGracePeriod { get; } ulong ExpireGracePeriod { get; }
/// <summary>
/// When this integration was last synced.
/// </summary>
DateTimeOffset SyncedAt { get; } DateTimeOffset SyncedAt { get; }
/// <summary>
/// Integration account information. See <see cref="IntegrationAccount"/>.
/// </summary>
IntegrationAccount Account { get; } IntegrationAccount Account { get; }


IGuild Guild { get; } IGuild Guild { get; }


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

@@ -1,11 +1,17 @@
using System.Diagnostics;
using System.Diagnostics;


namespace Discord namespace Discord
{ {
[DebuggerDisplay("{DebuggerDisplay,nq}")] [DebuggerDisplay("{DebuggerDisplay,nq}")]
public struct IntegrationAccount public struct IntegrationAccount
{ {
/// <summary>
/// ID of the account.
/// </summary>
public string Id { get; } public string Id { get; }
/// <summary>
/// Name of the account.
/// </summary>
public string Name { get; private set; } public string Name { get; private set; }


public override string ToString() => Name; public override string ToString() => Name;


Loading…
Cancel
Save