summaryrefslogtreecommitdiff
path: root/src/SMAPI.Web/Framework/ModInfoModel.cs
diff options
context:
space:
mode:
Diffstat (limited to 'src/SMAPI.Web/Framework/ModInfoModel.cs')
-rw-r--r--src/SMAPI.Web/Framework/ModInfoModel.cs81
1 files changed, 81 insertions, 0 deletions
diff --git a/src/SMAPI.Web/Framework/ModInfoModel.cs b/src/SMAPI.Web/Framework/ModInfoModel.cs
new file mode 100644
index 00000000..7845b8c5
--- /dev/null
+++ b/src/SMAPI.Web/Framework/ModInfoModel.cs
@@ -0,0 +1,81 @@
+using StardewModdingAPI.Web.Framework.Clients;
+
+namespace StardewModdingAPI.Web.Framework
+{
+ /// <summary>Generic metadata about a mod.</summary>
+ internal class ModInfoModel
+ {
+ /*********
+ ** Accessors
+ *********/
+ /// <summary>The mod name.</summary>
+ public string Name { get; set; }
+
+ /// <summary>The mod's latest version.</summary>
+ public ISemanticVersion Version { get; set; }
+
+ /// <summary>The mod's latest optional or prerelease version, if newer than <see cref="Version"/>.</summary>
+ public ISemanticVersion PreviewVersion { get; set; }
+
+ /// <summary>The mod's web URL.</summary>
+ public string Url { get; set; }
+
+ /// <summary>The mod availability status on the remote site.</summary>
+ public RemoteModStatus Status { get; set; } = RemoteModStatus.Ok;
+
+ /// <summary>The error message indicating why the mod is invalid (if applicable).</summary>
+ public string Error { get; set; }
+
+
+ /*********
+ ** Public methods
+ *********/
+ /// <summary>Construct an empty instance.</summary>
+ public ModInfoModel() { }
+
+ /// <summary>Construct an instance.</summary>
+ /// <param name="name">The mod name.</param>
+ /// <param name="version">The semantic version for the mod's latest release.</param>
+ /// <param name="previewVersion">The semantic version for the mod's latest preview release, if available and different from <see cref="Version"/>.</param>
+ /// <param name="url">The mod's web URL.</param>
+ public ModInfoModel(string name, ISemanticVersion version, string url, ISemanticVersion previewVersion = null)
+ {
+ this
+ .SetBasicInfo(name, url)
+ .SetVersions(version, previewVersion);
+ }
+
+ /// <summary>Set the basic mod info.</summary>
+ /// <param name="name">The mod name.</param>
+ /// <param name="url">The mod's web URL.</param>
+ public ModInfoModel SetBasicInfo(string name, string url)
+ {
+ this.Name = name;
+ this.Url = url;
+
+ return this;
+ }
+
+ /// <summary>Set the mod version info.</summary>
+ /// <param name="version">The semantic version for the mod's latest release.</param>
+ /// <param name="previewVersion">The semantic version for the mod's latest preview release, if available and different from <see cref="Version"/>.</param>
+ public ModInfoModel SetVersions(ISemanticVersion version, ISemanticVersion previewVersion = null)
+ {
+ this.Version = version;
+ this.PreviewVersion = previewVersion;
+
+ return this;
+ }
+
+ /// <summary>Set a mod error.</summary>
+ /// <param name="status">The mod availability status on the remote site.</param>
+ /// <param name="error">The error message indicating why the mod is invalid (if applicable).</param>
+ public ModInfoModel SetError(RemoteModStatus status, string error)
+ {
+ this.Status = status;
+ this.Error = error;
+
+ return this;
+ }
+ }
+}