summaryrefslogtreecommitdiff
path: root/src/SMAPI.Web/Framework/Clients/Chucklefish/IChucklefishClient.cs
blob: 1d8b256e67e6501016998e5d26da437ad6a972dd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
using System;
using System.Threading.Tasks;

namespace StardewModdingAPI.Web.Framework.Clients.Chucklefish
{
    /// <summary>An HTTP client for fetching mod metadata from the Chucklefish mod site.</summary>
    internal interface IChucklefishClient : IDisposable
    {
        /*********
        ** Methods
        *********/
        /// <summary>Get metadata about a mod.</summary>
        /// <param name="id">The Chucklefish mod ID.</param>
        /// <returns>Returns the mod info if found, else <c>null</c>.</returns>
        Task<ChucklefishMod> GetModAsync(uint id);
    }
}