pepperdash/Essentials
1
0
Fork 0
mirror of https://github.com/PepperDash/Essentials.git synced 2026-08-31 19:08:29 +00:00
Code Issues Projects Releases Packages Wiki Activity

feat: mark deprecated classes and methods for future removal

Browse source
This commit is contained in:
Neil Dorin 2026-05-08 13:08:58 -06:00
parent f3ea9e1d5a
commit 9fc866741e
9 changed files with 137 additions and 124 deletions
Download patch file Download diff file Expand all files Collapse all files

25
src/PepperDash.Essentials.Core/Config/Essentials/ConfigUpdater.cs
View file

@ -19,6 +19,7 @@ namespace PepperDash.Essentials.Core.Config
/// <summary>
/// ConfigUpdater class
/// </summary>
[Obsolete("ConfigUpdater is no longer supported and will be removed in a future release.")]
public static class ConfigUpdater
{
/// <summary>
@ -81,7 +82,7 @@ namespace PepperDash.Essentials.Core.Config
{
var handler = ConfigStatusChanged;
if(handler != null)
if (handler != null)
{
handler(typeof(ConfigUpdater), new ConfigStatusEventArgs(status));
}
@ -89,7 +90,7 @@ namespace PepperDash.Essentials.Core.Config
static void WriteConfigToFile(string configData)
{
var filePath = Global.FilePathPrefix+ "configurationFile-updated.json";
var filePath = Global.FilePathPrefix + "configurationFile-updated.json";
try
{
@ -104,7 +105,7 @@ namespace PepperDash.Essentials.Core.Config
Debug.LogMessage(LogEventLevel.Debug, "Error parsing new config: {0}", e);
OnStatusUpdate(eUpdateStatus.UpdateFailed);
}
}
}
/// <summary>
@ -149,11 +150,11 @@ namespace PepperDash.Essentials.Core.Config
// Directory exists, first clear any contents
var archivedConfigFiles = ConfigReader.GetConfigFiles(archiveDirectoryPath + Global.DirectorySeparator + Global.ConfigFileName + ".bak");
if(archivedConfigFiles != null || archivedConfigFiles.Length > 0)
if (archivedConfigFiles != null || archivedConfigFiles.Length > 0)
{
Debug.LogMessage(LogEventLevel.Information, "{0} Existing files found in archive folder. Deleting.", archivedConfigFiles.Length);
for (int i = 0; i < archivedConfigFiles.Length; i++ )
for (int i = 0; i < archivedConfigFiles.Length; i++)
{
var file = archivedConfigFiles[i];
Debug.LogMessage(LogEventLevel.Information, "Deleting archived file: '{0}'", file.FullName);
@ -170,9 +171,9 @@ namespace PepperDash.Essentials.Core.Config
// Moves the file and appends the .bak extension
var fileDest = archiveDirectoryPath + "/" + file.Name + ".bak";
if(!File.Exists(fileDest))
if (!File.Exists(fileDest))
{
file.MoveTo(fileDest);
file.MoveTo(fileDest);
}
else
Debug.LogMessage(LogEventLevel.Information, "Cannot move file to archive folder. Existing file already exists with same name: '{0}'", fileDest);
@ -207,15 +208,15 @@ namespace PepperDash.Essentials.Core.Config
CrestronConsole.SendControlSystemCommand(string.Format("progreset -p:{0}", InitialParametersClass.ApplicationNumber), ref response);
Debug.LogMessage(LogEventLevel.Debug, "Console Response: {0}", response);
Debug.LogMessage(LogEventLevel.Debug, "Console Response: {0}", response);
}
}
/// <summary>
/// Enumeration of eUpdateStatus values
/// </summary>
public enum eUpdateStatus
/// <summary>
/// Enumeration of eUpdateStatus values
/// </summary>
public enum eUpdateStatus
{
/// <summary>
/// UpdateStarted status

7
src/PepperDash.Essentials.Core/Interfaces/ILogStrings.cs
View file

@ -7,9 +7,10 @@ using PepperDash.Core;
namespace PepperDash.Essentials.Core.Interfaces
{
/// <summary>
/// Defines the contract for ILogStrings
/// </summary>
/// <summary>
/// Defines the contract for ILogStrings
/// </summary>
[Obsolete("ILogStrings is no longer supported and will be removed in a future release.")]
public interface ILogStrings : IKeyed
{
/// <summary>

9
src/PepperDash.Essentials.Core/Interfaces/ILogStringsWithLevel.cs
View file

@ -7,15 +7,16 @@ using PepperDash.Core;
namespace PepperDash.Essentials.Core.Interfaces
{
/// <summary>
/// Defines the contract for ILogStringsWithLevel
/// </summary>
/// <summary>
/// Defines the contract for ILogStringsWithLevel
/// </summary>
[Obsolete("ILogStringsWithLevel is no longer supported and will be removed in a future release.")]
public interface ILogStringsWithLevel : IKeyed
{
/// <summary>
/// Defines a class that is capable of logging a string with an int level
/// </summary>
void SendToLog(IKeyed device, Debug.ErrorLogLevel level,string logMessage);
void SendToLog(IKeyed device, Debug.ErrorLogLevel level, string logMessage);
}
}

3
src/PepperDash.Essentials.Core/Routing/eRoutingSignalType.cs
View file

@ -27,16 +27,19 @@ namespace PepperDash.Essentials.Core
/// <summary>
/// Control signal type
/// </summary>
[Obsolete("UsbOutput is no longer supported and will be removed in a future release.")]
UsbOutput = 8,
/// <summary>
/// Control signal type
/// </summary>
[Obsolete("UsbInput is no longer supported and will be removed in a future release.")]
UsbInput = 16,
/// <summary>
/// Secondary audio signal type
/// </summary>
[Obsolete("SecondaryAudio is no longer supported and will be removed in a future release.")]
SecondaryAudio = 32
}
}