using System;
using System.Diagnostics.CodeAnalysis;
using System.Linq;
using StardewModdingAPI.Toolkit.Utilities;
namespace StardewModdingAPI.Toolkit.Framework.Clients.WebApi
{
/// Specifies mods whose update-check info to fetch.
public class ModSearchModel
{
/*********
** Accessors
*********/
/// The mods for which to find data.
public ModSearchEntryModel[] Mods { get; set; }
/// Whether to include extended metadata for each mod.
public bool IncludeExtendedMetadata { get; set; }
/// The SMAPI version installed by the player. This is used for version mapping in some cases.
public ISemanticVersion ApiVersion { get; set; }
/// The Stardew Valley version installed by the player.
public ISemanticVersion GameVersion { get; set; }
/// The OS on which the player plays.
public Platform Platform { get; set; }
/*********
** Public methods
*********/
/// Construct an empty instance.
[Obsolete("This constructor only exists to support ASP.NET model binding, and shouldn't be used directly.")]
[SuppressMessage("ReSharper", "UnusedMember.Global", Justification = "Used by ASP.NET model binding.")]
public ModSearchModel()
{
// ASP.NET Web API needs a public empty constructor for top-level request models, and
// it'll fail if the other constructor is marked with [JsonConstructor]. Apparently
// it's fine with non-empty constructors in nested models like ModSearchEntryModel.
this.Mods = Array.Empty();
this.ApiVersion = null!;
this.GameVersion = null!;
}
/// Construct an instance.
/// The mods to search.
/// The SMAPI version installed by the player. If this is null, the API won't provide a recommended update.
/// The Stardew Valley version installed by the player.
/// The OS on which the player plays.
/// Whether to include extended metadata for each mod.
public ModSearchModel(ModSearchEntryModel[] mods, ISemanticVersion apiVersion, ISemanticVersion gameVersion, Platform platform, bool includeExtendedMetadata)
{
this.Mods = mods.ToArray();
this.ApiVersion = apiVersion;
this.GameVersion = gameVersion;
this.Platform = platform;
this.IncludeExtendedMetadata = includeExtendedMetadata;
}
}
}