diff options
Diffstat (limited to 'src/SMAPI.Web/Framework/Clients/GitHub/IGitHubClient.cs')
-rw-r--r-- | src/SMAPI.Web/Framework/Clients/GitHub/IGitHubClient.cs | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/src/SMAPI.Web/Framework/Clients/GitHub/IGitHubClient.cs b/src/SMAPI.Web/Framework/Clients/GitHub/IGitHubClient.cs new file mode 100644 index 00000000..6e8eadff --- /dev/null +++ b/src/SMAPI.Web/Framework/Clients/GitHub/IGitHubClient.cs @@ -0,0 +1,17 @@ +using System; +using System.Threading.Tasks; + +namespace StardewModdingAPI.Web.Framework.Clients.GitHub +{ + /// <summary>An HTTP client for fetching metadata from GitHub.</summary> + internal interface IGitHubClient : IDisposable + { + /********* + ** Methods + *********/ + /// <summary>Get the latest release for a GitHub repository.</summary> + /// <param name="repo">The repository key (like <c>Pathoschild/SMAPI</c>).</param> + /// <returns>Returns the latest release if found, else <c>null</c>.</returns> + Task<GitRelease> GetLatestReleaseAsync(string repo); + } +} |