feat: mark deprecated classes and methods for future removal

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

View file

@ -11,6 +11,7 @@ namespace PepperDash.Core
/// <summary> /// <summary>
/// Represents a debugging context /// Represents a debugging context
/// </summary> /// </summary>
[Obsolete("DebugContext is no longer supported and will be removed in a future release.")]
public class DebugContext public class DebugContext
{ {
/// <summary> /// <summary>

View file

@ -13,6 +13,7 @@ namespace PepperDash.Core.WebApi.Presets
/// <summary> /// <summary>
/// Passcode client for the WebApi /// Passcode client for the WebApi
/// </summary> /// </summary>
[Obsolete("WebApiPasscodeClient is no longer supported and will be removed in a future release.")]
public class WebApiPasscodeClient : IKeyed public class WebApiPasscodeClient : IKeyed
{ {
/// <summary> /// <summary>

View file

@ -19,6 +19,7 @@ namespace PepperDash.Essentials.Core.Config
/// <summary> /// <summary>
/// ConfigUpdater class /// ConfigUpdater class
/// </summary> /// </summary>
[Obsolete("ConfigUpdater is no longer supported and will be removed in a future release.")]
public static class ConfigUpdater public static class ConfigUpdater
{ {
/// <summary> /// <summary>
@ -81,7 +82,7 @@ namespace PepperDash.Essentials.Core.Config
{ {
var handler = ConfigStatusChanged; var handler = ConfigStatusChanged;
if(handler != null) if (handler != null)
{ {
handler(typeof(ConfigUpdater), new ConfigStatusEventArgs(status)); handler(typeof(ConfigUpdater), new ConfigStatusEventArgs(status));
} }
@ -89,7 +90,7 @@ namespace PepperDash.Essentials.Core.Config
static void WriteConfigToFile(string configData) static void WriteConfigToFile(string configData)
{ {
var filePath = Global.FilePathPrefix+ "configurationFile-updated.json"; var filePath = Global.FilePathPrefix + "configurationFile-updated.json";
try try
{ {
@ -149,11 +150,11 @@ namespace PepperDash.Essentials.Core.Config
// Directory exists, first clear any contents // Directory exists, first clear any contents
var archivedConfigFiles = ConfigReader.GetConfigFiles(archiveDirectoryPath + Global.DirectorySeparator + Global.ConfigFileName + ".bak"); 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); 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]; var file = archivedConfigFiles[i];
Debug.LogMessage(LogEventLevel.Information, "Deleting archived file: '{0}'", file.FullName); Debug.LogMessage(LogEventLevel.Information, "Deleting archived file: '{0}'", file.FullName);
@ -170,7 +171,7 @@ namespace PepperDash.Essentials.Core.Config
// Moves the file and appends the .bak extension // Moves the file and appends the .bak extension
var fileDest = archiveDirectoryPath + "/" + file.Name + ".bak"; var fileDest = archiveDirectoryPath + "/" + file.Name + ".bak";
if(!File.Exists(fileDest)) if (!File.Exists(fileDest))
{ {
file.MoveTo(fileDest); file.MoveTo(fileDest);
} }

View file

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

View file

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

View file

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

View file

@ -17,6 +17,8 @@ namespace PepperDash.Essentials.Devices.Common.Cameras
/// <summary> /// <summary>
/// Represents a CameraVisca /// Represents a CameraVisca
/// </summary> /// </summary>
[Obsolete("CameraVisca is no longer supported and will be removed in a future release. Use the CameraVisca plugin instead.")]
public class CameraVisca : CameraBase, IHasCameraPtzControl, ICommunicationMonitor, IHasCameraPresets, IHasPowerControlWithFeedback, IBridgeAdvanced, IHasCameraFocusControl, IHasAutoFocusMode public class CameraVisca : CameraBase, IHasCameraPtzControl, ICommunicationMonitor, IHasCameraPresets, IHasPowerControlWithFeedback, IBridgeAdvanced, IHasCameraFocusControl, IHasAutoFocusMode
{ {
private readonly CameraViscaPropertiesConfig PropertiesConfig; private readonly CameraViscaPropertiesConfig PropertiesConfig;

View file

@ -1,3 +1,4 @@
using System;
using System.Collections.Generic; using System.Collections.Generic;
using Newtonsoft.Json; using Newtonsoft.Json;
@ -18,6 +19,7 @@ namespace PepperDash.Essentials.AppServer.Messengers
/// Sets the interfaces implemented by the device sending the message /// Sets the interfaces implemented by the device sending the message
/// </summary> /// </summary>
/// <param name="interfaces"></param> /// <param name="interfaces"></param>
[Obsolete("SetInterfaces is no longer supported and will be removed in a future release. Interfaces for all devices are now retrieved via the /joinroom endpoint in the MobileControlWebsocketServer")]
public void SetInterfaces(List<string> interfaces) public void SetInterfaces(List<string> interfaces)
{ {
Interfaces = interfaces; Interfaces = interfaces;

View file

@ -801,6 +801,7 @@ namespace PepperDash.Essentials
/// <summary> /// <summary>
/// Fires up a logo server if not already running /// Fires up a logo server if not already running
/// </summary> /// </summary>
[Obsolete("Logo server is no longer supported and will be removed in a future release.")]
void LoadLogoServer() void LoadLogoServer()
{ {
if (ConfigReader.ConfigObject?.Rooms == null) if (ConfigReader.ConfigObject?.Rooms == null)