summaryrefslogtreecommitdiff
path: root/src/SMAPI.Web/Framework/Caching/Mods/IModCacheRepository.cs
diff options
context:
space:
mode:
authorJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2019-07-24 18:33:26 -0400
committerJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2019-09-14 18:58:54 -0400
commit17c6ae7ed995344111513ca91b18ec6598ec2399 (patch)
tree11eecb3fc870ab67c8644fc7014b7b9c87c59f91 /src/SMAPI.Web/Framework/Caching/Mods/IModCacheRepository.cs
parent03a082297a750dace586dc2d15d17c840d96d95f (diff)
downloadSMAPI-17c6ae7ed995344111513ca91b18ec6598ec2399.tar.gz
SMAPI-17c6ae7ed995344111513ca91b18ec6598ec2399.tar.bz2
SMAPI-17c6ae7ed995344111513ca91b18ec6598ec2399.zip
migrate update check caching to MongoDB (#651)
Diffstat (limited to 'src/SMAPI.Web/Framework/Caching/Mods/IModCacheRepository.cs')
-rw-r--r--src/SMAPI.Web/Framework/Caching/Mods/IModCacheRepository.cs26
1 files changed, 26 insertions, 0 deletions
diff --git a/src/SMAPI.Web/Framework/Caching/Mods/IModCacheRepository.cs b/src/SMAPI.Web/Framework/Caching/Mods/IModCacheRepository.cs
new file mode 100644
index 00000000..23929d1d
--- /dev/null
+++ b/src/SMAPI.Web/Framework/Caching/Mods/IModCacheRepository.cs
@@ -0,0 +1,26 @@
+using StardewModdingAPI.Toolkit.Framework.UpdateData;
+using StardewModdingAPI.Web.Framework.ModRepositories;
+
+namespace StardewModdingAPI.Web.Framework.Caching.Mods
+{
+ /// <summary>Encapsulates logic for accessing the mod data cache.</summary>
+ internal interface IModCacheRepository : ICacheRepository
+ {
+ /*********
+ ** Methods
+ *********/
+ /// <summary>Get the cached mod data.</summary>
+ /// <param name="site">The mod site to search.</param>
+ /// <param name="id">The mod's unique ID within the <paramref name="site"/>.</param>
+ /// <param name="mod">The fetched mod.</param>
+ /// <param name="markRequested">Whether to update the mod's 'last requested' date.</param>
+ bool TryGetMod(ModRepositoryKey site, string id, out CachedMod mod, bool markRequested = true);
+
+ /// <summary>Save data fetched for a mod.</summary>
+ /// <param name="site">The mod site on which the mod is found.</param>
+ /// <param name="id">The mod's unique ID within the <paramref name="site"/>.</param>
+ /// <param name="mod">The mod data.</param>
+ /// <param name="cachedMod">The stored mod record.</param>
+ void SaveMod(ModRepositoryKey site, string id, ModInfoModel mod, out CachedMod cachedMod);
+ }
+}