src/SMAPI.Web/Framework/ModRepositories/IModRepository.cs


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

using System;
using System.Threading.Tasks;
using StardewModdingAPI.Common.Models;

namespace StardewModdingAPI.Web.Framework.ModRepositories
{
    /// <summary>A repository which provides mod metadata.</summary>
    internal interface IModRepository : IDisposable
    {
        /*********
        ** Accessors
        *********/
        /// <summary>The unique key for this vendor.</summary>
        string VendorKey { get; }


        /*********
        ** Public methods
        *********/
        /// <summary>Get metadata about a mod in the repository.</summary>
        /// <param name="id">The mod ID in this repository.</param>
        Task<ModInfoModel> GetModInfoAsync(string id);
    }
}