summaryrefslogtreecommitdiff
path: root/src/SMAPI.Web/Framework/Clients/IModSiteClient.cs
blob: 2cd1f635079b3e90ed3d8f6c4808386650ef3000 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
#nullable disable

using System.Threading.Tasks;
using StardewModdingAPI.Toolkit.Framework.UpdateData;

namespace StardewModdingAPI.Web.Framework.Clients
{
    /// <summary>A client for fetching update check info from a mod site.</summary>
    internal interface IModSiteClient
    {
        /*********
        ** Accessors
        *********/
        /// <summary>The unique key for the mod site.</summary>
        public ModSiteKey SiteKey { get; }


        /*********
        ** Methods
        *********/
        /// <summary>Get update check info about a mod.</summary>
        /// <param name="id">The mod ID.</param>
        Task<IModPage> GetModData(string id);
    }
}