summaryrefslogtreecommitdiff
path: root/src/SMAPI.Web/Framework/Clients/GenericModDownload.cs
diff options
context:
space:
mode:
Diffstat (limited to 'src/SMAPI.Web/Framework/Clients/GenericModDownload.cs')
-rw-r--r--src/SMAPI.Web/Framework/Clients/GenericModDownload.cs27
1 files changed, 12 insertions, 15 deletions
diff --git a/src/SMAPI.Web/Framework/Clients/GenericModDownload.cs b/src/SMAPI.Web/Framework/Clients/GenericModDownload.cs
index 5cc03aba..6c9c08ef 100644
--- a/src/SMAPI.Web/Framework/Clients/GenericModDownload.cs
+++ b/src/SMAPI.Web/Framework/Clients/GenericModDownload.cs
@@ -17,10 +17,9 @@ namespace StardewModdingAPI.Web.Framework.Clients
/// <summary>The download's file version.</summary>
public string? Version { get; }
- /// <summary>
- /// The URL for this download, if it has one distinct from the mod page's URL.
- /// </summary>
- public string? Url { 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>
+ public string? ModPageUrl { get; }
+
/*********
** Public methods
@@ -29,23 +28,21 @@ namespace StardewModdingAPI.Web.Framework.Clients
/// <param name="name">The download's display name.</param>
/// <param name="description">The download's description.</param>
/// <param name="version">The download's file version.</param>
- /// <param name="url">The download's URL (if different from the mod page's URL).</param>
- public GenericModDownload(string name, string? description, string? version, string? url = null)
+ /// <param name="modPageUrl">The mod URL page from which to download this update, if different from the URL of the mod page it was fetched from.</param>
+ public GenericModDownload(string name, string? description, string? version, string? modPageUrl = null)
{
this.Name = name;
this.Description = description;
this.Version = version;
- this.Url = url;
+ this.ModPageUrl = modPageUrl;
}
- /// <summary>
- /// Return <see langword="true"/> if the subkey matches this download. A subkey matches if it appears as
- /// a substring in the name or description.
- /// </summary>
- /// <param name="subkey">the subkey</param>
- /// <returns><see langword="true"/> if <paramref name="subkey"/> matches this download, otherwise <see langword="false"/></returns>
- public virtual bool MatchesSubkey(string subkey) {
- return this.Name.Contains(subkey, StringComparison.OrdinalIgnoreCase) == true
+ /// <summary>Get whether the subkey matches this download.</summary>
+ /// <param name="subkey">The update subkey to check.</param>
+ public virtual bool MatchesSubkey(string subkey)
+ {
+ return
+ this.Name.Contains(subkey, StringComparison.OrdinalIgnoreCase)
|| this.Description?.Contains(subkey, StringComparison.OrdinalIgnoreCase) == true;
}
}