src/SMAPI.Web/Framework/IModDownload.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
25
26
27
28
29

namespace StardewModdingAPI.Web.Framework
{
    /// <summary>Generic metadata about a file download on a mod page.</summary>
    internal interface IModDownload
    {
        /*********
        ** Accessors
        *********/
        /// <summary>The download's display name.</summary>
        string Name { get; }

        /// <summary>The download's description.</summary>
        string? Description { get; }

        /// <summary>The download's file version.</summary>
        string? Version { get; }

        /// <summary>The mod URL page from which to download this update, if different from the URL of the mod page it was fetched from.</summary>
        string? ModPageUrl { get; }


        /*********
        ** Methods
        *********/
        /// <summary>Get whether the subkey matches this download.</summary>
        /// <param name="subkey">The update subkey to check.</param>
        bool MatchesSubkey(string subkey);
    }
}