pepperdash/Essentials
1
0
Fork 0
mirror of https://github.com/PepperDash/Essentials.git synced 2026-02-11 02:35:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: complete XML documentation for all projects with inheritdoc tags

Browse Source 
Co-authored-by: andrew-welker <1765622+andrew-welker@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot]
2025-07-22 15:53:01 +00:00
parent 260677a37f
commit 7987eb8f9b
485 changed files with 8099 additions and 2490 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
src/PepperDash.Essentials.MobileControl/Touchpanel/ITheme.cs
View File

@@ -2,6 +2,9 @@
namespace PepperDash.Essentials.Touchpanel
{
/// <summary>
/// Defines the contract for ITheme
/// </summary>
public interface ITheme : IKeyed
{
string Theme { get; }

6
src/PepperDash.Essentials.MobileControl/Touchpanel/ITswAppControl.cs
View File

@@ -3,6 +3,9 @@ using PepperDash.Essentials.Core;
namespace PepperDash.Essentials.Touchpanel
{
/// <summary>
/// Defines the contract for ITswAppControl
/// </summary>
public interface ITswAppControl : IKeyed
{
BoolFeedback AppOpenFeedback { get; }
@@ -14,6 +17,9 @@ namespace PepperDash.Essentials.Touchpanel
void OpenApp();
}
/// <summary>
/// Defines the contract for ITswZoomControl
/// </summary>
public interface ITswZoomControl : IKeyed
{
BoolFeedback ZoomIncomingCallFeedback { get; }

6
src/PepperDash.Essentials.MobileControl/Touchpanel/ITswAppControlMessenger.cs
View File

@@ -6,6 +6,9 @@ using PepperDash.Essentials.AppServer.Messengers;
namespace PepperDash.Essentials.Touchpanel
{
/// <summary>
/// Represents a ITswAppControlMessenger
/// </summary>
public class ITswAppControlMessenger : MessengerBase
{
private readonly ITswAppControl _appControl;
@@ -51,6 +54,9 @@ namespace PepperDash.Essentials.Touchpanel
}
}
/// <summary>
/// Represents a TswAppStateMessage
/// </summary>
public class TswAppStateMessage : DeviceStateMessageBase
{
[JsonProperty("appOpen", NullValueHandling = NullValueHandling.Ignore)]

6
src/PepperDash.Essentials.MobileControl/Touchpanel/ITswZoomControlMessenger.cs
View File

@@ -7,6 +7,9 @@ using PepperDash.Essentials.AppServer.Messengers;
namespace PepperDash.Essentials.Touchpanel
{
/// <summary>
/// Represents a ITswZoomControlMessenger
/// </summary>
public class ITswZoomControlMessenger : MessengerBase
{
private readonly ITswZoomControl _zoomControl;
@@ -62,6 +65,9 @@ namespace PepperDash.Essentials.Touchpanel
}
}
/// <summary>
/// Represents a TswZoomStateMessage
/// </summary>
public class TswZoomStateMessage : DeviceStateMessageBase
{
[JsonProperty("inCall", NullValueHandling = NullValueHandling.Ignore)]

34
src/PepperDash.Essentials.MobileControl/Touchpanel/MobileControlTouchpanelController.cs
View File

@@ -30,7 +30,7 @@ namespace PepperDash.Essentials.Touchpanel
private string _appUrl;
/// <summary>
/// Gets feedback for the current application URL.
/// Gets or sets the AppUrlFeedback
/// </summary>
public StringFeedback AppUrlFeedback { get; private set; }
@@ -65,12 +65,12 @@ namespace PepperDash.Essentials.Touchpanel
public BoolFeedback ZoomInCallFeedback => _zoomInCallFeedback;
/// <summary>
/// Gets the collection of feedback objects for this touchpanel controller.
/// Gets or sets the Feedbacks
/// </summary>
public FeedbackCollection<Feedback> Feedbacks { get; private set; }
/// <summary>
/// Gets the collection of Zoom-related feedback objects.
/// Gets or sets the ZoomFeedbacks
/// </summary>
public FeedbackCollection<Feedback> ZoomFeedbacks { get; private set; }
@@ -95,7 +95,7 @@ namespace PepperDash.Essentials.Touchpanel
public string Theme => localConfig.Theme;
/// <summary>
/// Gets feedback for the current theme setting.
/// Gets or sets the ThemeFeedback
/// </summary>
public StringFeedback ThemeFeedback { get; private set; }
@@ -188,6 +188,9 @@ namespace PepperDash.Essentials.Touchpanel
/// Updates the theme setting for this touchpanel controller and persists the change to configuration.
/// </summary>
/// <param name="theme">The new theme identifier to apply.</param>
/// <summary>
/// UpdateTheme method
/// </summary>
public void UpdateTheme(string theme)
{
localConfig.Theme = theme;
@@ -325,6 +328,9 @@ namespace PepperDash.Essentials.Touchpanel
/// registering messengers and linking to mobile control.
/// </summary>
/// <returns>True if activation was successful; otherwise, false.</returns>
/// <summary>
/// CustomActivate method
/// </summary>
public override bool CustomActivate()
{
var appMessenger = new ITswAppControlMessenger($"appControlMessenger-{Key}", $"/device/{Key}", this);
@@ -432,6 +438,9 @@ namespace PepperDash.Essentials.Touchpanel
/// Sets the application URL and updates the corresponding feedback.
/// </summary>
/// <param name="url">The new application URL to set.</param>
/// <summary>
/// SetAppUrl method
/// </summary>
public void SetAppUrl(string url)
{
_appUrl = url;
@@ -458,7 +467,7 @@ namespace PepperDash.Essentials.Touchpanel
}
/// <summary>
/// Hides the currently open application on the touchpanel.
/// HideOpenApp method
/// </summary>
public void HideOpenApp()
{
@@ -476,7 +485,7 @@ namespace PepperDash.Essentials.Touchpanel
}
/// <summary>
/// Opens an application on the touchpanel. Note: X60 panels do not support Zoom app opening.
/// OpenApp method
/// </summary>
public void OpenApp()
{
@@ -494,7 +503,7 @@ namespace PepperDash.Essentials.Touchpanel
}
/// <summary>
/// Closes the currently open application on the touchpanel.
/// CloseOpenApp method
/// </summary>
public void CloseOpenApp()
{
@@ -512,7 +521,7 @@ namespace PepperDash.Essentials.Touchpanel
}
/// <summary>
/// Ends the current Zoom call on the touchpanel.
/// EndZoomCall method
/// </summary>
public void EndZoomCall()
{
@@ -530,8 +539,7 @@ namespace PepperDash.Essentials.Touchpanel
}
/// <summary>
/// Updates the device information (MAC address and IP address) from the touchpanel
/// and raises the DeviceInfoChanged event.
/// UpdateDeviceInfo method
/// </summary>
public void UpdateDeviceInfo()
{
@@ -570,8 +578,7 @@ namespace PepperDash.Essentials.Touchpanel
}
/// <summary>
/// Factory class for creating MobileControlTouchpanelController instances from device configuration.
/// Supports various Crestron touchpanel models including TSW, TS, CrestronApp, XPanel, and DGE series.
/// Represents a MobileControlTouchpanelControllerFactory
/// </summary>
public class MobileControlTouchpanelControllerFactory : EssentialsPluginDeviceFactory<MobileControlTouchpanelController>
{
@@ -590,6 +597,9 @@ namespace PepperDash.Essentials.Touchpanel
/// </summary>
/// <param name="dc">The device configuration containing the device properties and settings.</param>
/// <returns>A configured MobileControlTouchpanelController instance.</returns>
/// <summary>
/// BuildDevice method
/// </summary>
public override EssentialsDevice BuildDevice(DeviceConfig dc)
{
var comm = CommFactory.GetControlPropertiesConfig(dc);

15
src/PepperDash.Essentials.MobileControl/Touchpanel/MobileControlTouchpanelProperties.cs
View File

@@ -3,18 +3,33 @@ using PepperDash.Essentials.Core;
namespace PepperDash.Essentials.Touchpanel
{
/// <summary>
/// Represents a MobileControlTouchpanelProperties
/// </summary>
public class MobileControlTouchpanelProperties : CrestronTouchpanelPropertiesConfig
{
[JsonProperty("useDirectServer")]
/// <summary>
/// Gets or sets the UseDirectServer
/// </summary>
public bool UseDirectServer { get; set; } = false;
[JsonProperty("zoomRoomController")]
/// <summary>
/// Gets or sets the ZoomRoomController
/// </summary>
public bool ZoomRoomController { get; set; } = false;
[JsonProperty("buttonToolbarTimeoutInS")]
/// <summary>
/// Gets or sets the ButtonToolbarTimoutInS
/// </summary>
public ushort ButtonToolbarTimoutInS { get; set; } = 0;
[JsonProperty("theme")]
/// <summary>
/// Gets or sets the Theme
/// </summary>
public string Theme { get; set; } = "light";
}
}

9
src/PepperDash.Essentials.MobileControl/Touchpanel/ThemeMessenger.cs
View File

@@ -6,6 +6,9 @@ using PepperDash.Essentials.AppServer.Messengers;
namespace PepperDash.Essentials.Touchpanel
{
/// <summary>
/// Represents a ThemeMessenger
/// </summary>
public class ThemeMessenger : MessengerBase
{
private readonly ITheme _tpDevice;
@@ -34,9 +37,15 @@ namespace PepperDash.Essentials.Touchpanel
}
}
/// <summary>
/// Represents a ThemeUpdateMessage
/// </summary>
public class ThemeUpdateMessage : DeviceStateMessageBase
{
[JsonProperty("theme")]
/// <summary>
/// Gets or sets the Theme
/// </summary>
public string Theme { get; set; }
}
}