diff --git a/src/PepperDash.Essentials.Core/License/EssentialsLicenseManager.cs b/src/PepperDash.Essentials.Core/License/EssentialsLicenseManager.cs index f8500996..ded7f699 100644 --- a/src/PepperDash.Essentials.Core/License/EssentialsLicenseManager.cs +++ b/src/PepperDash.Essentials.Core/License/EssentialsLicenseManager.cs @@ -13,21 +13,29 @@ using Serilog.Events; namespace PepperDash.Essentials.License { + /// + /// Abstract base class for License Managers + /// public abstract class LicenseManager { - /// - /// Gets or sets the LicenseIsValid - /// + /// + /// Gets or sets the LicenseIsValid + /// public BoolFeedback LicenseIsValid { get; protected set; } - /// - /// Gets or sets the LicenseMessage - /// + + /// + /// Gets or sets the LicenseMessage + /// public StringFeedback LicenseMessage { get; protected set; } - /// - /// Gets or sets the LicenseLog - /// + + /// + /// Gets or sets the LicenseLog + /// public StringFeedback LicenseLog { get; protected set; } + /// + /// Constructor + /// protected LicenseManager() { CrestronConsole.AddNewConsoleCommand( @@ -36,12 +44,15 @@ namespace PepperDash.Essentials.License ConsoleAccessLevelEnum.AccessOperator); } + /// + /// Gets the status string for console command + /// protected abstract string GetStatusString(); } - /// - /// Represents a MockEssentialsLicenseManager - /// + /// + /// Represents a MockEssentialsLicenseManager + /// public class MockEssentialsLicenseManager : LicenseManager { /// @@ -91,6 +102,10 @@ namespace PepperDash.Essentials.License SetIsValid(isValid); } + /// + /// Gets the status string for console command + /// + /// license status valid or invalid protected override string GetStatusString() { return string.Format("License Status: {0}", IsValid ? "Valid" : "Not Valid"); diff --git a/src/PepperDash.Essentials.Core/Plugins/PluginLoader.cs b/src/PepperDash.Essentials.Core/Plugins/PluginLoader.cs index a1dd9413..2f195ba9 100644 --- a/src/PepperDash.Essentials.Core/Plugins/PluginLoader.cs +++ b/src/PepperDash.Essentials.Core/Plugins/PluginLoader.cs @@ -174,9 +174,6 @@ namespace PepperDash.Essentials /// /// /// - /// - /// GetAssemblyVersion method - /// public static string GetAssemblyVersion(Assembly assembly) { var ver = assembly.GetCustomAttributes(typeof(AssemblyInformationalVersionAttribute), false); @@ -198,11 +195,8 @@ namespace PepperDash.Essentials /// /// Checks if the filename matches an already loaded assembly file's name /// - /// + /// name of loaded assembly /// True if file already matches loaded assembly file. - /// - /// CheckIfAssemblyLoaded method - /// public static bool CheckIfAssemblyLoaded(string name) { Debug.LogMessage(LogEventLevel.Verbose, "Checking if assembly: {0} is loaded...", name); @@ -238,9 +232,6 @@ namespace PepperDash.Essentials /// Used by console command to report the currently loaded assemblies and versions /// /// - /// - /// ReportAssemblyVersions method - /// public static void ReportAssemblyVersions(string command) { CrestronConsole.ConsoleCommandResponse("Essentials Version: {0}" + CrestronEnvironment.NewLine, Global.AssemblyVersion); @@ -257,6 +248,7 @@ namespace PepperDash.Essentials // CrestronConsole.ConsoleCommandResponse("{0} Version: {1}" + CrestronEnvironment.NewLine, assembly.Name, assembly.Version); //} } + /// /// Moves any .dll assemblies not already loaded from the plugins folder to loadedPlugins folder /// diff --git a/src/PepperDash.Essentials.Core/Room/Config/EssentialsHuddleVtc1PropertiesConfig.cs b/src/PepperDash.Essentials.Core/Room/Config/EssentialsHuddleVtc1PropertiesConfig.cs index 72286cec..c41ed3c2 100644 --- a/src/PepperDash.Essentials.Core/Room/Config/EssentialsHuddleVtc1PropertiesConfig.cs +++ b/src/PepperDash.Essentials.Core/Room/Config/EssentialsHuddleVtc1PropertiesConfig.cs @@ -4,16 +4,16 @@ using Newtonsoft.Json; namespace PepperDash.Essentials.Room.Config { - /// - /// Represents a EssentialsHuddleVtc1PropertiesConfig - /// - public class EssentialsHuddleVtc1PropertiesConfig : EssentialsConferenceRoomPropertiesConfig - { - [JsonProperty("defaultDisplayKey")] /// - /// Gets or sets the DefaultDisplayKey + /// Represents a EssentialsHuddleVtc1PropertiesConfig /// - public string DefaultDisplayKey { get; set; } + public class EssentialsHuddleVtc1PropertiesConfig : EssentialsConferenceRoomPropertiesConfig + { + /// + /// Gets or sets the DefaultDisplayKey + /// + [JsonProperty("defaultDisplayKey")] + public string DefaultDisplayKey { get; set; } - } + } } \ No newline at end of file diff --git a/src/PepperDash.Essentials.Core/Room/Config/EssentialsNDisplayRoomPropertiesConfig.cs b/src/PepperDash.Essentials.Core/Room/Config/EssentialsNDisplayRoomPropertiesConfig.cs index 0d5670a9..f65864b8 100644 --- a/src/PepperDash.Essentials.Core/Room/Config/EssentialsNDisplayRoomPropertiesConfig.cs +++ b/src/PepperDash.Essentials.Core/Room/Config/EssentialsNDisplayRoomPropertiesConfig.cs @@ -11,13 +11,27 @@ namespace PepperDash.Essentials.Room.Config /// public class EssentialsNDisplayRoomPropertiesConfig : EssentialsConferenceRoomPropertiesConfig { + /// + /// Gets or sets the DefaultAudioBehavior + /// [JsonProperty("defaultAudioBehavior")] public string DefaultAudioBehavior { get; set; } + + /// + /// Gets or sets the DefaultVideoBehavior + /// [JsonProperty("defaultVideoBehavior")] public string DefaultVideoBehavior { get; set; } + + /// + /// Gets or sets the Displays + /// [JsonProperty("displays")] public Dictionary Displays { get; set; } + /// + /// Constructor + /// public EssentialsNDisplayRoomPropertiesConfig() { Displays = new Dictionary(); @@ -34,6 +48,7 @@ namespace PepperDash.Essentials.Room.Config /// Gets or sets the Key /// public string Key { get; set; } + /// /// Gets or sets the Name /// diff --git a/src/PepperDash.Essentials.Core/Room/Config/EssentialsPresentationPropertiesConfig.cs b/src/PepperDash.Essentials.Core/Room/Config/EssentialsPresentationPropertiesConfig.cs index 74a8813e..8bd47197 100644 --- a/src/PepperDash.Essentials.Core/Room/Config/EssentialsPresentationPropertiesConfig.cs +++ b/src/PepperDash.Essentials.Core/Room/Config/EssentialsPresentationPropertiesConfig.cs @@ -11,15 +11,35 @@ namespace PepperDash.Essentials.Room.Config /// Gets or sets the DefaultAudioBehavior /// public string DefaultAudioBehavior { get; set; } + /// /// Gets or sets the DefaultAudioKey /// public string DefaultAudioKey { get; set; } + + /// + /// Gets or sets the DefaultVideoBehavior + /// public string DefaultVideoBehavior { get; set; } + + /// + /// Gets or sets the DisplayKeys + /// public List DisplayKeys { get; set; } + + /// + /// Gets or sets the SourceListKey + /// public string SourceListKey { get; set; } + + /// + /// Gets or sets a value indicating whether the room has a DSP + /// public bool HasDsp { get; set; } + /// + /// Constructor + /// public EssentialsPresentationRoomPropertiesConfig() { DisplayKeys = new List(); diff --git a/src/PepperDash.Essentials.Core/Room/Config/EssentialsRoomEmergencyConfig.cs b/src/PepperDash.Essentials.Core/Room/Config/EssentialsRoomEmergencyConfig.cs index ff5b0e5a..349f44b8 100644 --- a/src/PepperDash.Essentials.Core/Room/Config/EssentialsRoomEmergencyConfig.cs +++ b/src/PepperDash.Essentials.Core/Room/Config/EssentialsRoomEmergencyConfig.cs @@ -25,11 +25,15 @@ /// contact,versiport /// public string Type { get; set; } + /// /// Input number if contact /// public int Number { get; set; } + /// + /// TriggerOnClose indicates if the trigger is on close + /// public bool TriggerOnClose { get; set; } } diff --git a/src/PepperDash.Essentials.Core/Room/Config/EssentialsRoomScheduledEventsConfig.cs b/src/PepperDash.Essentials.Core/Room/Config/EssentialsRoomScheduledEventsConfig.cs index bb1ec94d..d7cb0514 100644 --- a/src/PepperDash.Essentials.Core/Room/Config/EssentialsRoomScheduledEventsConfig.cs +++ b/src/PepperDash.Essentials.Core/Room/Config/EssentialsRoomScheduledEventsConfig.cs @@ -13,10 +13,10 @@ namespace PepperDash.Essentials.Room.Config /// public class EssentialsRoomScheduledEventsConfig { - [JsonProperty("scheduledEvents")] /// /// Gets or sets the ScheduledEvents /// + [JsonProperty("scheduledEvents")] public List ScheduledEvents; } @@ -25,49 +25,52 @@ namespace PepperDash.Essentials.Room.Config /// public class ScheduledEventConfig { - [JsonProperty("key")] /// /// Gets or sets the Key /// + [JsonProperty("key")] public string Key; - [JsonProperty("name")] /// /// Gets or sets the Name /// + [JsonProperty("name")] public string Name; + /// + /// Gets or sets the Days + /// [JsonProperty("days")] public ScheduledEventCommon.eWeekDays Days; - [JsonProperty("time")] /// /// Gets or sets the Time /// + [JsonProperty("time")] public string Time; - [JsonProperty("actions")] /// /// Gets or sets the Actions /// + [JsonProperty("actions")] public List Actions; - [JsonProperty("persistent")] /// /// Gets or sets the Persistent /// + [JsonProperty("persistent")] public bool Persistent; - [JsonProperty("acknowledgeable")] /// /// Gets or sets the Acknowledgeable /// + [JsonProperty("acknowledgeable")] public bool Acknowledgeable; - [JsonProperty("enable")] /// /// Gets or sets the Enable /// + [JsonProperty("enable")] public bool Enable; } } \ No newline at end of file diff --git a/src/PepperDash.Essentials.Core/Room/Config/EssentialsTechRoomConfig.cs b/src/PepperDash.Essentials.Core/Room/Config/EssentialsTechRoomConfig.cs index bca77725..dfc3d7a6 100644 --- a/src/PepperDash.Essentials.Core/Room/Config/EssentialsTechRoomConfig.cs +++ b/src/PepperDash.Essentials.Core/Room/Config/EssentialsTechRoomConfig.cs @@ -14,9 +14,6 @@ namespace PepperDash.Essentials.Room.Config /// The key of the dummy device used to enable routing /// [JsonProperty("dummySourceKey")] - /// - /// Gets or sets the DummySourceKey - /// public string DummySourceKey { get; set; } /// @@ -26,7 +23,7 @@ namespace PepperDash.Essentials.Room.Config public List Displays { get; set; } /// - /// The keys of the tuners assinged to this room + /// The keys of the tuners assigned to this room /// [JsonProperty("tuners")] public List Tuners { get; set; } @@ -49,19 +46,16 @@ namespace PepperDash.Essentials.Room.Config [JsonProperty("presetsFileName")] public string PresetsFileName { get; set; } - [JsonProperty("scheduledEvents")] /// /// Gets or sets the ScheduledEvents /// + [JsonProperty("scheduledEvents")] public List ScheduledEvents { get; set; } /// /// Indicates that the room is the primary when true /// [JsonProperty("isPrimary")] - /// - /// Gets or sets the IsPrimary - /// public bool IsPrimary { get; set; } /// @@ -70,21 +64,21 @@ namespace PepperDash.Essentials.Room.Config [JsonProperty("mirroredTuners")] public Dictionary MirroredTuners { get; set; } - [JsonProperty("helpMessage")] /// /// Gets or sets the HelpMessage /// + [JsonProperty("helpMessage")] public string HelpMessage { get; set; } - /// - /// Indicates the room - /// - [JsonProperty("isTvPresetsProvider")] /// /// Gets or sets the IsTvPresetsProvider /// + [JsonProperty("isTvPresetsProvider")] public bool IsTvPresetsProvider; + /// + /// Constructor + /// public EssentialsTechRoomConfig() { Displays = new List(); diff --git a/src/PepperDash.Essentials.Core/Room/Config/EssentialsVolumeLevelConfig.cs b/src/PepperDash.Essentials.Core/Room/Config/EssentialsVolumeLevelConfig.cs index 4e3d502f..51172130 100644 --- a/src/PepperDash.Essentials.Core/Room/Config/EssentialsVolumeLevelConfig.cs +++ b/src/PepperDash.Essentials.Core/Room/Config/EssentialsVolumeLevelConfig.cs @@ -12,8 +12,20 @@ namespace PepperDash.Essentials.Room.Config /// Gets or sets the Master /// public EssentialsVolumeLevelConfig Master { get; set; } + + /// + /// Gets or sets the Program + /// public EssentialsVolumeLevelConfig Program { get; set; } + + /// + /// Gets or sets the AudioCallRx + /// public EssentialsVolumeLevelConfig AudioCallRx { get; set; } + + /// + /// Gets or sets the AudioCallTx + /// public EssentialsVolumeLevelConfig AudioCallTx { get; set; } } diff --git a/src/PepperDash.Essentials.Core/Room/Config/SimplRoomPropertiesConfig.cs b/src/PepperDash.Essentials.Core/Room/Config/SimplRoomPropertiesConfig.cs index b37335b9..59628aed 100644 --- a/src/PepperDash.Essentials.Core/Room/Config/SimplRoomPropertiesConfig.cs +++ b/src/PepperDash.Essentials.Core/Room/Config/SimplRoomPropertiesConfig.cs @@ -8,42 +8,46 @@ namespace PepperDash.Essentials.Room.Config /// public class SimplRoomPropertiesConfig : EssentialsHuddleVtc1PropertiesConfig { + /// + /// Gets or sets the RoomPhoneNumber + /// [JsonProperty("roomPhoneNumber")] - /// - /// Gets or sets the RoomPhoneNumber - /// public string RoomPhoneNumber { get; set; } + + /// + /// Gets or sets the RoomURI + /// [JsonProperty("roomURI")] - /// - /// Gets or sets the RoomURI - /// public string RoomURI { get; set; } + + /// + /// Gets or sets the SpeedDials + /// [JsonProperty("speedDials")] - /// - /// Gets or sets the SpeedDials - /// public List SpeedDials { get; set; } + + /// + /// Gets or sets the VolumeSliderNames + /// [JsonProperty("volumeSliderNames")] - /// - /// Gets or sets the VolumeSliderNames - /// public List VolumeSliderNames { get; set; } } - /// - /// Represents a SimplSpeedDial - /// + /// + /// Represents a SimplSpeedDial + /// public class SimplSpeedDial { + /// + /// Gets or sets the Name + /// [JsonProperty("name")] - /// - /// Gets or sets the Name - /// public string Name { get; set; } + + /// + /// Gets or sets the Number + /// [JsonProperty("number")] - /// - /// Gets or sets the Number - /// public string Number { get; set; } } } \ No newline at end of file diff --git a/src/PepperDash.Essentials.Core/Utilities/ActionSequence.cs b/src/PepperDash.Essentials.Core/Utilities/ActionSequence.cs index cc83f171..22c9297c 100644 --- a/src/PepperDash.Essentials.Core/Utilities/ActionSequence.cs +++ b/src/PepperDash.Essentials.Core/Utilities/ActionSequence.cs @@ -30,6 +30,11 @@ namespace PepperDash.Essentials.Core.Utilities private bool _allowActionsToExecute; + /// + /// Constructor + /// + /// + /// public ActionSequence(string key, DeviceConfig config) : base(key, config.Name) { @@ -126,9 +131,15 @@ namespace PepperDash.Essentials.Core.Utilities /// public class ActionSequencePropertiesConfig { + /// + /// Gets or sets the ActionSequence + /// [JsonProperty("actionSequence")] public List ActionSequence { get; set; } + /// + /// Constructor + /// public ActionSequencePropertiesConfig() { ActionSequence = new List(); @@ -140,10 +151,10 @@ namespace PepperDash.Essentials.Core.Utilities /// public class SequencedDeviceActionWrapper : DeviceActionWrapper { - [JsonProperty("delayMs")] /// /// Gets or sets the DelayMs /// + [JsonProperty("delayMs")] public int DelayMs { get; set; } } @@ -152,11 +163,19 @@ namespace PepperDash.Essentials.Core.Utilities /// public class ActionSequenceFactory : EssentialsDeviceFactory { + /// + /// Constructor + /// public ActionSequenceFactory() { TypeNames = new List() { "actionsequence" }; } + /// + /// BuildDevice method + /// + /// device config + /// public override EssentialsDevice BuildDevice(DeviceConfig dc) { Debug.LogMessage(LogEventLevel.Debug, "Factory Attempting to create new ActionSequence Device"); diff --git a/src/PepperDash.Essentials.Core/VideoStatus/VideoStatusOutputs.cs b/src/PepperDash.Essentials.Core/VideoStatus/VideoStatusOutputs.cs index 9a929234..b5151f79 100644 --- a/src/PepperDash.Essentials.Core/VideoStatus/VideoStatusOutputs.cs +++ b/src/PepperDash.Essentials.Core/VideoStatus/VideoStatusOutputs.cs @@ -14,12 +14,34 @@ namespace PepperDash.Essentials.Core /// public class VideoStatusFuncsWrapper { + /// + /// Gets or sets the HasVideoStatusFunc + /// public Func HasVideoStatusFunc { get; set; } + + /// + /// Gets or sets the HdcpActiveFeedbackFunc + /// public Func HdcpActiveFeedbackFunc { get; set; } + + /// + /// Gets or sets the HdcpStateFeedbackFunc + /// public Func HdcpStateFeedbackFunc { get; set; } + + /// + /// Gets or sets the VideoResolutionFeedbackFunc + /// public Func VideoResolutionFeedbackFunc { get; set; } + + /// + /// Gets or sets the VideoSyncFeedbackFunc + /// public Func VideoSyncFeedbackFunc { get; set; } + /// + /// Constructor + /// public VideoStatusFuncsWrapper() { HasVideoStatusFunc = () => true; @@ -30,32 +52,50 @@ namespace PepperDash.Essentials.Core } } - /// - /// Represents a VideoStatusOutputs - /// + /// + /// Represents a VideoStatusOutputs + /// public class VideoStatusOutputs { - /// - /// Gets or sets the HasVideoStatusFeedback - /// + /// + /// Gets or sets the HasVideoStatusFeedback + /// public BoolFeedback HasVideoStatusFeedback { get; private set; } - /// - /// Gets or sets the HdcpActiveFeedback - /// + + /// + /// Gets or sets the HdcpActiveFeedback + /// public BoolFeedback HdcpActiveFeedback { get; private set; } + + /// + /// Gets or sets the HdcpStateFeedback + /// public StringFeedback HdcpStateFeedback { get; private set; } + + /// + /// Gets or sets the VideoResolutionFeedback + /// public StringFeedback VideoResolutionFeedback { get; private set; } + + /// + /// Gets or sets the VideoSyncFeedback + /// public BoolFeedback VideoSyncFeedback { get; private set; } - /// - /// Gets or sets the NoStatus - /// + /// + /// Gets or sets the NoStatus + /// public static VideoStatusOutputs NoStatus { get { return _Default; } } + static VideoStatusOutputs _Default = new VideoStatusOutputs(new VideoStatusFuncsWrapper { HasVideoStatusFunc = () => false }); + /// + /// Constructor + /// + /// public VideoStatusOutputs(VideoStatusFuncsWrapper funcs) { HasVideoStatusFeedback = new BoolFeedback("HasVideoStatusFeedback", funcs.HasVideoStatusFunc); @@ -66,9 +106,9 @@ namespace PepperDash.Essentials.Core VideoSyncFeedback = new BoolFeedback("VideoSyncFeedback", funcs.VideoSyncFeedbackFunc); } - /// - /// FireAll method - /// + /// + /// FireAll method + /// public void FireAll() { HasVideoStatusFeedback.FireUpdate(); @@ -78,9 +118,9 @@ namespace PepperDash.Essentials.Core VideoSyncFeedback.FireUpdate(); } - /// - /// ToList method - /// + /// + /// ToList method + /// public List ToList() { return new List @@ -94,9 +134,9 @@ namespace PepperDash.Essentials.Core } } - /// - /// Wraps up the common video statuses exposed on a video input port - /// + // /// + // /// Wraps up the common video statuses exposed on a video input port + // /// //public class BasicVideoStatus : IBasicVideoStatus //{ // public event VideoStatusChangeHandler VideoStatusChange; diff --git a/src/PepperDash.Essentials.Core/Web/EssentialsWebApiFactory.cs b/src/PepperDash.Essentials.Core/Web/EssentialsWebApiFactory.cs index 49a7eb80..16abd349 100644 --- a/src/PepperDash.Essentials.Core/Web/EssentialsWebApiFactory.cs +++ b/src/PepperDash.Essentials.Core/Web/EssentialsWebApiFactory.cs @@ -10,15 +10,18 @@ namespace PepperDash.Essentials.Core.Web /// public class EssentialsWebApiFactory : EssentialsDeviceFactory { + /// + /// Constructor + /// public EssentialsWebApiFactory() { TypeNames = new List { "EssentialsWebApi" }; } - /// - /// BuildDevice method - /// - /// + /// + /// BuildDevice method + /// + /// public override EssentialsDevice BuildDevice(DeviceConfig dc) { Debug.LogMessage(LogEventLevel.Debug, "Factory Attempting to create new Essentials Web API Server"); diff --git a/src/PepperDash.Essentials.Core/Web/EssentialsWebApiHelpers.cs b/src/PepperDash.Essentials.Core/Web/EssentialsWebApiHelpers.cs index b9411a35..75f90189 100644 --- a/src/PepperDash.Essentials.Core/Web/EssentialsWebApiHelpers.cs +++ b/src/PepperDash.Essentials.Core/Web/EssentialsWebApiHelpers.cs @@ -7,11 +7,14 @@ using PepperDash.Core; namespace PepperDash.Essentials.Core.Web { + /// + /// EssentialsWebApiHelpers class + /// public static class EssentialsWebApiHelpers { - /// - /// GetRequestBody method - /// + /// + /// GetRequestBody method + /// public static string GetRequestBody(this HttpCwsRequest request) { var bytes = new byte[request.ContentLength]; @@ -21,9 +24,9 @@ namespace PepperDash.Essentials.Core.Web return Encoding.UTF8.GetString(bytes, 0, bytes.Length); } - /// - /// MapToAssemblyObject method - /// + /// + /// MapToAssemblyObject method + /// public static object MapToAssemblyObject(LoadedAssembly assembly) { return new @@ -33,9 +36,9 @@ namespace PepperDash.Essentials.Core.Web }; } - /// - /// MapToDeviceListObject method - /// + /// + /// MapToDeviceListObject method + /// public static object MapToDeviceListObject(IKeyed device) { return new @@ -47,9 +50,9 @@ namespace PepperDash.Essentials.Core.Web }; } - /// - /// MapJoinToObject method - /// + /// + /// MapJoinToObject method + /// public static object MapJoinToObject(string key, JoinMapBaseAdvanced join) { var kp = new KeyValuePair(key, join); @@ -57,9 +60,9 @@ namespace PepperDash.Essentials.Core.Web return MapJoinToObject(kp); } - /// - /// MapJoinToObject method - /// + /// + /// MapJoinToObject method + /// public static object MapJoinToObject(KeyValuePair join) { return new @@ -69,9 +72,9 @@ namespace PepperDash.Essentials.Core.Web }; } - /// - /// MapJoinDataCompleteToObject method - /// + /// + /// MapJoinDataCompleteToObject method + /// public static object MapJoinDataCompleteToObject(KeyValuePair joinData) { return new @@ -85,9 +88,9 @@ namespace PepperDash.Essentials.Core.Web }; } - /// - /// MapDeviceTypeToObject method - /// + /// + /// MapDeviceTypeToObject method + /// public static object MapDeviceTypeToObject(string key, DeviceFactoryWrapper device) { var kp = new KeyValuePair(key, device); @@ -95,9 +98,9 @@ namespace PepperDash.Essentials.Core.Web return MapDeviceTypeToObject(kp); } - /// - /// MapDeviceTypeToObject method - /// + /// + /// MapDeviceTypeToObject method + /// public static object MapDeviceTypeToObject(KeyValuePair device) { return new diff --git a/src/PepperDash.Essentials.Core/Web/EssentialsWebApiPropertiesConfig.cs b/src/PepperDash.Essentials.Core/Web/EssentialsWebApiPropertiesConfig.cs index c20aa07a..9c00fd93 100644 --- a/src/PepperDash.Essentials.Core/Web/EssentialsWebApiPropertiesConfig.cs +++ b/src/PepperDash.Essentials.Core/Web/EssentialsWebApiPropertiesConfig.cs @@ -2,15 +2,15 @@ namespace PepperDash.Essentials.Core.Web { - /// - /// Represents a EssentialsWebApiPropertiesConfig - /// + /// + /// Represents a EssentialsWebApiPropertiesConfig + /// public class EssentialsWebApiPropertiesConfig { + /// + /// Gets or sets the BasePath + /// [JsonProperty("basePath")] - /// - /// Gets or sets the BasePath - /// public string BasePath { get; set; } } } \ No newline at end of file diff --git a/src/PepperDash.Essentials.Core/Web/RequestHandlers/AppDebugRequestHandler.cs b/src/PepperDash.Essentials.Core/Web/RequestHandlers/AppDebugRequestHandler.cs index ac95525e..3d3302cc 100644 --- a/src/PepperDash.Essentials.Core/Web/RequestHandlers/AppDebugRequestHandler.cs +++ b/src/PepperDash.Essentials.Core/Web/RequestHandlers/AppDebugRequestHandler.cs @@ -80,16 +80,16 @@ namespace PepperDash.Essentials.Core.Web.RequestHandlers } } - /// - /// Represents a AppDebug - /// + /// + /// Represents a AppDebug + /// public class AppDebug { - [JsonProperty("minimumLevel", NullValueHandling = NullValueHandling.Ignore)] - [JsonConverter(typeof(StringEnumConverter))] /// /// Gets or sets the MinimumLevel /// + [JsonProperty("minimumLevel", NullValueHandling = NullValueHandling.Ignore)] + [JsonConverter(typeof(StringEnumConverter))] public LogEventLevel MinimumLevel { get; set; } } } \ No newline at end of file diff --git a/src/PepperDash.Essentials.Core/Web/RequestHandlers/DebugSessionRequestHandler.cs b/src/PepperDash.Essentials.Core/Web/RequestHandlers/DebugSessionRequestHandler.cs index e7d0c69c..01e38834 100644 --- a/src/PepperDash.Essentials.Core/Web/RequestHandlers/DebugSessionRequestHandler.cs +++ b/src/PepperDash.Essentials.Core/Web/RequestHandlers/DebugSessionRequestHandler.cs @@ -18,6 +18,9 @@ namespace PepperDash.Essentials.Core.Web.RequestHandlers /// public class DebugSessionRequestHandler : WebApiBaseRequestHandler { + /// + /// Constructor + /// public DebugSessionRequestHandler() : base(true) { diff --git a/src/PepperDash.Essentials.Core/Web/RequestHandlers/DoNotLoadConfigOnNextBootRequestHandler.cs b/src/PepperDash.Essentials.Core/Web/RequestHandlers/DoNotLoadConfigOnNextBootRequestHandler.cs index 5c17e342..593ce4e7 100644 --- a/src/PepperDash.Essentials.Core/Web/RequestHandlers/DoNotLoadConfigOnNextBootRequestHandler.cs +++ b/src/PepperDash.Essentials.Core/Web/RequestHandlers/DoNotLoadConfigOnNextBootRequestHandler.cs @@ -5,9 +5,9 @@ using PepperDash.Core.Web.RequestHandlers; namespace PepperDash.Essentials.Core.Web.RequestHandlers { - /// - /// Represents a DoNotLoadConfigOnNextBootRequestHandler - /// + /// + /// Represents a DoNotLoadConfigOnNextBootRequestHandler + /// public class DoNotLoadConfigOnNextBootRequestHandler : WebApiBaseRequestHandler { /// @@ -79,15 +79,15 @@ namespace PepperDash.Essentials.Core.Web.RequestHandlers } } - /// - /// Represents a Data - /// + /// + /// Represents a Data + /// public class Data { + /// + /// Gets or sets the DoNotLoadConfigOnNextBoot + /// [JsonProperty("doNotLoadConfigOnNextBoot", NullValueHandling = NullValueHandling.Ignore)] - /// - /// Gets or sets the DoNotLoadConfigOnNextBoot - /// public bool DoNotLoadConfigOnNextBoot { get; set; } } } \ No newline at end of file diff --git a/src/PepperDash.Essentials.Core/Web/RequestHandlers/GetRoutesHandler.cs b/src/PepperDash.Essentials.Core/Web/RequestHandlers/GetRoutesHandler.cs index cc450e11..bd264a7a 100644 --- a/src/PepperDash.Essentials.Core/Web/RequestHandlers/GetRoutesHandler.cs +++ b/src/PepperDash.Essentials.Core/Web/RequestHandlers/GetRoutesHandler.cs @@ -13,11 +13,20 @@ namespace PepperDash.Essentials.Core.Web.RequestHandlers private HttpCwsRouteCollection routeCollection; private string basePath; + /// + /// Constructor + /// + /// + /// public GetRoutesHandler(HttpCwsRouteCollection routeCollection, string basePath) { this.routeCollection = routeCollection; this.basePath = basePath; } + /// + /// Handles GET method requests + /// + /// protected override void HandleGet(HttpCwsContext context) { var currentIp = CrestronEthernetHelper.GetEthernetParameter( @@ -49,16 +58,16 @@ namespace PepperDash.Essentials.Core.Web.RequestHandlers /// public class RoutesResponseObject { - [JsonProperty("url")] /// /// Gets or sets the Url /// + [JsonProperty("url")] public string Url { set; get; } - [JsonProperty("routes")] /// /// Gets or sets the Routes /// + [JsonProperty("routes")] public HttpCwsRouteCollection Routes { get; set; } } } diff --git a/src/PepperDash.Essentials.Core/Web/RequestHandlers/GetRoutingPortsHandler.cs b/src/PepperDash.Essentials.Core/Web/RequestHandlers/GetRoutingPortsHandler.cs index f11e6dd2..8cee7e9e 100644 --- a/src/PepperDash.Essentials.Core/Web/RequestHandlers/GetRoutingPortsHandler.cs +++ b/src/PepperDash.Essentials.Core/Web/RequestHandlers/GetRoutingPortsHandler.cs @@ -12,8 +12,15 @@ namespace PepperDash.Essentials.Core.Web.RequestHandlers /// public class GetRoutingPortsHandler : WebApiBaseRequestHandler { + /// + /// Constructor + /// public GetRoutingPortsHandler() : base(true) { } + /// + /// Handles the GET request + /// + /// protected override void HandleGet(HttpCwsContext context) { var routeData = context.Request.RouteData; @@ -63,17 +70,18 @@ namespace PepperDash.Essentials.Core.Web.RequestHandlers } } - internal class ReturnValue { - [JsonProperty("inputPorts", NullValueHandling = NullValueHandling.Ignore)] + internal class ReturnValue + { /// /// Gets or sets the InputPorts /// + [JsonProperty("inputPorts", NullValueHandling = NullValueHandling.Ignore)] public List InputPorts { get; set; } - [JsonProperty("outputPorts", NullValueHandling = NullValueHandling.Ignore)] /// /// Gets or sets the OutputPorts /// + [JsonProperty("outputPorts", NullValueHandling = NullValueHandling.Ignore)] public List OutputPorts { get; set; } } } diff --git a/src/PepperDash.Essentials.Core/Web/RequestHandlers/GetTieLinesRequestHandler.cs b/src/PepperDash.Essentials.Core/Web/RequestHandlers/GetTieLinesRequestHandler.cs index bc6fb623..f7088cb2 100644 --- a/src/PepperDash.Essentials.Core/Web/RequestHandlers/GetTieLinesRequestHandler.cs +++ b/src/PepperDash.Essentials.Core/Web/RequestHandlers/GetTieLinesRequestHandler.cs @@ -11,8 +11,15 @@ namespace PepperDash.Essentials.Core.Web.RequestHandlers /// public class GetTieLinesRequestHandler : WebApiBaseRequestHandler { + /// + /// Constructor + /// public GetTieLinesRequestHandler() : base(true) { } + /// + /// Handles the GET request + /// + /// protected override void HandleGet(HttpCwsContext context) { var tieLineString = JsonConvert.SerializeObject(TieLineCollection.Default.Select((tl) => new diff --git a/src/PepperDash.Essentials.Core/Web/RequestHandlers/SetDeviceStreamDebugRequestHandler.cs b/src/PepperDash.Essentials.Core/Web/RequestHandlers/SetDeviceStreamDebugRequestHandler.cs index 7c6aea26..dd4f416f 100644 --- a/src/PepperDash.Essentials.Core/Web/RequestHandlers/SetDeviceStreamDebugRequestHandler.cs +++ b/src/PepperDash.Essentials.Core/Web/RequestHandlers/SetDeviceStreamDebugRequestHandler.cs @@ -195,26 +195,32 @@ namespace PepperDash.Essentials.Core.Web.RequestHandlers } + /// + /// Configuration class for SetDeviceStreamDebugRequestHandler + /// public class SetDeviceStreamDebugConfig { - [JsonProperty("deviceKey", NullValueHandling = NullValueHandling.Include)] /// /// Gets or sets the DeviceKey /// + [JsonProperty("deviceKey", NullValueHandling = NullValueHandling.Include)] public string DeviceKey { get; set; } - [JsonProperty("setting", NullValueHandling = NullValueHandling.Include)] /// /// Gets or sets the Setting /// + [JsonProperty("setting", NullValueHandling = NullValueHandling.Include)] public string Setting { get; set; } - [JsonProperty("timeout")] /// /// Gets or sets the Timeout /// + [JsonProperty("timeout")] public int Timeout { get; set; } + /// + /// Constructor + /// public SetDeviceStreamDebugConfig() { DeviceKey = null;