summaryrefslogtreecommitdiff
path: root/src/SMAPI.Web/Framework/IModPage.cs
diff options
context:
space:
mode:
Diffstat (limited to 'src/SMAPI.Web/Framework/IModPage.cs')
-rw-r--r--src/SMAPI.Web/Framework/IModPage.cs16
1 files changed, 11 insertions, 5 deletions
diff --git a/src/SMAPI.Web/Framework/IModPage.cs b/src/SMAPI.Web/Framework/IModPage.cs
index e66d401f..4d0a8d61 100644
--- a/src/SMAPI.Web/Framework/IModPage.cs
+++ b/src/SMAPI.Web/Framework/IModPage.cs
@@ -1,4 +1,5 @@
using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
using StardewModdingAPI.Toolkit.Framework.UpdateData;
namespace StardewModdingAPI.Web.Framework
@@ -16,13 +17,13 @@ namespace StardewModdingAPI.Web.Framework
string Id { get; }
/// <summary>The mod name.</summary>
- string Name { get; }
+ string? Name { get; }
/// <summary>The mod's semantic version number.</summary>
- string Version { get; }
+ string? Version { get; }
/// <summary>The mod's web URL.</summary>
- string Url { get; }
+ string? Url { get; }
/// <summary>The mod downloads.</summary>
IModDownload[] Downloads { get; }
@@ -31,7 +32,12 @@ namespace StardewModdingAPI.Web.Framework
RemoteModStatus Status { get; }
/// <summary>A user-friendly error which indicates why fetching the mod info failed (if applicable).</summary>
- string Error { get; }
+ string? Error { get; }
+
+ /// <summary>Whether the mod data is valid.</summary>
+ [MemberNotNullWhen(true, nameof(IModPage.Name), nameof(IModPage.Url))]
+ [MemberNotNullWhen(false, nameof(IModPage.Error))]
+ bool IsValid { get; }
/*********
@@ -42,7 +48,7 @@ namespace StardewModdingAPI.Web.Framework
/// <param name="version">The mod's semantic version number.</param>
/// <param name="url">The mod's web URL.</param>
/// <param name="downloads">The mod downloads.</param>
- IModPage SetInfo(string name, string version, string url, IEnumerable<IModDownload> downloads);
+ IModPage SetInfo(string name, string? version, string url, IEnumerable<IModDownload> downloads);
/// <summary>Set a mod fetch error.</summary>
/// <param name="status">The mod availability status on the remote site.</param>