pepperdash/Essentials
1
0
Fork 0
mirror of https://github.com/PepperDash/Essentials.git synced 2026-02-10 02:05:08 +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

85
src/PepperDash.Essentials.Core/Fusion/EssentialsHuddleSpaceFusionSystemControllerBase.cs
View File

@@ -18,6 +18,9 @@ using System.Text;
namespace PepperDash.Essentials.Core.Fusion
{
/// <summary>
/// Represents a EssentialsHuddleSpaceFusionSystemControllerBase
/// </summary>
public class EssentialsHuddleSpaceFusionSystemControllerBase : Device, IOccupancyStatusProvider
{
private readonly EssentialsHuddleSpaceRoomFusionRoomJoinMap JoinMap;
@@ -196,6 +199,9 @@ namespace PepperDash.Essentials.Core.Fusion
get { return _guiDs.RoomGuid; }
}
/// <summary>
/// Gets or sets the RoomOccupancyRemoteStringFeedback
/// </summary>
public StringFeedback RoomOccupancyRemoteStringFeedback { get; private set; }
protected Func<bool> RoomIsOccupiedFeedbackFunc
@@ -205,6 +211,9 @@ namespace PepperDash.Essentials.Core.Fusion
#region IOccupancyStatusProvider Members
/// <summary>
/// Gets or sets the RoomIsOccupiedFeedback
/// </summary>
public BoolFeedback RoomIsOccupiedFeedback { get; private set; }
#endregion
@@ -580,6 +589,9 @@ namespace PepperDash.Essentials.Core.Fusion
/// Requests the local date and time from the Fusion Server
/// </summary>
/// <param name="callbackObject"></param>
/// <summary>
/// RequestLocalDateTime method
/// </summary>
public void RequestLocalDateTime(object callbackObject)
{
const string timeRequestId = "TimeRequest";
@@ -591,7 +603,7 @@ namespace PepperDash.Essentials.Core.Fusion
}
/// <summary>
/// Generates a room schedule request for this room for the next 24 hours.
/// RequestFullRoomSchedule method
/// </summary>
public void RequestFullRoomSchedule(object callbackObject)
{
@@ -618,6 +630,9 @@ namespace PepperDash.Essentials.Core.Fusion
/// Wrapper method to allow console commands to modify the current meeting end time
/// </summary>
/// <param name="command">meetingID extendTime</param>
/// <summary>
/// ModifyMeetingEndTimeConsoleHelper method
/// </summary>
public void ModifyMeetingEndTimeConsoleHelper(string command)
{
var extendMinutes = -1;
@@ -643,6 +658,9 @@ namespace PepperDash.Essentials.Core.Fusion
/// </summary>
/// <param name="requestId"></param>
/// <param name="extendMinutes">Number of minutes to extend the meeting. A value of 0 will end the meeting.</param>
/// <summary>
/// ModifyMeetingEndTime method
/// </summary>
public void ModifyMeetingEndTime(string requestId, int extendMinutes)
{
if (_currentMeeting == null)
@@ -677,7 +695,7 @@ namespace PepperDash.Essentials.Core.Fusion
}
/// <summary>
/// Creates and Ad Hoc meeting with a duration of 1 hour, or until the next meeting if in less than 1 hour.
/// CreateAdHocMeeting method
/// </summary>
public void CreateAdHocMeeting(string command)
{
@@ -1625,6 +1643,9 @@ namespace PepperDash.Essentials.Core.Fusion
/// FusionRoom.AddSig with join number - 49
/// </summary>
/// <returns>The new attribute</returns>
/// <summary>
/// CreateOffsetBoolSig method
/// </summary>
public static BooleanSigData CreateOffsetBoolSig(this FusionRoom fr, uint number, string name, eSigIoMask mask)
{
if (number < 50)
@@ -1642,6 +1663,9 @@ namespace PepperDash.Essentials.Core.Fusion
/// FusionRoom.AddSig with join number - 49
/// </summary>
/// <returns>The new attribute</returns>
/// <summary>
/// CreateOffsetUshortSig method
/// </summary>
public static UShortSigData CreateOffsetUshortSig(this FusionRoom fr, uint number, string name, eSigIoMask mask)
{
if (number < 50)
@@ -1659,6 +1683,9 @@ namespace PepperDash.Essentials.Core.Fusion
/// FusionRoom.AddSig with join number - 49
/// </summary>
/// <returns>The new attribute</returns>
/// <summary>
/// CreateOffsetStringSig method
/// </summary>
public static StringSigData CreateOffsetStringSig(this FusionRoom fr, uint number, string name, eSigIoMask mask)
{
if (number < 50)
@@ -1674,6 +1701,9 @@ namespace PepperDash.Essentials.Core.Fusion
/// Creates and returns a static asset
/// </summary>
/// <returns>the new asset</returns>
/// <summary>
/// CreateStaticAsset method
/// </summary>
public static FusionStaticAsset CreateStaticAsset(this FusionRoom fr, uint number, string name, string type,
string instanceId)
{
@@ -1696,6 +1726,9 @@ namespace PepperDash.Essentials.Core.Fusion
}
}
/// <summary>
/// CreateOccupancySensorAsset method
/// </summary>
public static FusionOccupancySensor CreateOccupancySensorAsset(this FusionRoom fr, uint number, string name,
string type, string instanceId)
{
@@ -1765,6 +1798,9 @@ namespace PepperDash.Essentials.Core.Fusion
}
}
/// <summary>
/// Represents a RoomInformation
/// </summary>
public class RoomInformation
{
public RoomInformation()
@@ -1772,18 +1808,51 @@ namespace PepperDash.Essentials.Core.Fusion
FusionCustomProperties = new List<FusionCustomProperty>();
}
/// <summary>
/// Gets or sets the ID
/// </summary>
public string ID { get; set; }
/// <summary>
/// Gets or sets the Name
/// </summary>
public string Name { get; set; }
/// <summary>
/// Gets or sets the Location
/// </summary>
public string Location { get; set; }
/// <summary>
/// Gets or sets the Description
/// </summary>
public string Description { get; set; }
/// <summary>
/// Gets or sets the TimeZone
/// </summary>
public string TimeZone { get; set; }
/// <summary>
/// Gets or sets the WebcamURL
/// </summary>
public string WebcamURL { get; set; }
/// <summary>
/// Gets or sets the BacklogMsg
/// </summary>
public string BacklogMsg { get; set; }
/// <summary>
/// Gets or sets the SubErrorMsg
/// </summary>
public string SubErrorMsg { get; set; }
/// <summary>
/// Gets or sets the EmailInfo
/// </summary>
public string EmailInfo { get; set; }
/// <summary>
/// Gets or sets the FusionCustomProperties
/// </summary>
public List<FusionCustomProperty> FusionCustomProperties { get; set; }
}
/// <summary>
/// Represents a FusionCustomProperty
/// </summary>
public class FusionCustomProperty
{
public FusionCustomProperty()
@@ -1795,9 +1864,21 @@ namespace PepperDash.Essentials.Core.Fusion
ID = id;
}
/// <summary>
/// Gets or sets the ID
/// </summary>
public string ID { get; set; }
/// <summary>
/// Gets or sets the CustomFieldName
/// </summary>
public string CustomFieldName { get; set; }
/// <summary>
/// Gets or sets the CustomFieldType
/// </summary>
public string CustomFieldType { get; set; }
/// <summary>
/// Gets or sets the CustomFieldValue
/// </summary>
public string CustomFieldValue { get; set; }
}
}

3
src/PepperDash.Essentials.Core/Fusion/EssentialsHuddleSpaceRoomFusionRoomJoinMap.cs
View File

@@ -9,6 +9,9 @@ using PepperDash.Essentials.Core.Bridges;
namespace PepperDash.Essentials.Core.Fusion
{
/// <summary>
/// Represents a EssentialsHuddleSpaceRoomFusionRoomJoinMap
/// </summary>
public class EssentialsHuddleSpaceRoomFusionRoomJoinMap : JoinMapBaseAdvanced
{

12
src/PepperDash.Essentials.Core/Fusion/FusionEventHandlers.cs
View File

@@ -6,13 +6,25 @@ using Crestron.SimplSharp;
namespace PepperDash.Essentials.Core.Fusion
{
/// <summary>
/// Represents a ScheduleChangeEventArgs
/// </summary>
public class ScheduleChangeEventArgs : EventArgs
{
/// <summary>
/// Gets or sets the Schedule
/// </summary>
public RoomSchedule Schedule { get; set; }
}
/// <summary>
/// Represents a MeetingChangeEventArgs
/// </summary>
public class MeetingChangeEventArgs : EventArgs
{
/// <summary>
/// Gets or sets the Meeting
/// </summary>
public Event Meeting { get; set; }
}
}

8
src/PepperDash.Essentials.Core/Fusion/FusionProcessorQueries.cs
View File

@@ -53,11 +53,17 @@ namespace PepperDash.Essentials.Core.Fusion
}
/// <summary>
/// Used in ProcessorProgReg
/// Represents a ProcessorProgramItem
/// </summary>
public class ProcessorProgramItem
{
/// <summary>
/// Gets or sets the Exists
/// </summary>
public bool Exists { get; set; }
/// <summary>
/// Gets or sets the Name
/// </summary>
public string Name { get; set; }
}
}

233
src/PepperDash.Essentials.Core/Fusion/FusionRviDataClasses.cs
View File

@@ -54,6 +54,9 @@ namespace PepperDash.Essentials.Core.Fusion
/// </summary>
/// <param name="progSlot"></param>
/// <param name="mac"></param>
/// <summary>
/// GenerateNewRoomGuid method
/// </summary>
public string GenerateNewRoomGuid(uint progSlot, string mac)
{
Guid roomGuid = Guid.NewGuid();
@@ -89,6 +92,9 @@ namespace PepperDash.Essentials.Core.Fusion
/// </summary>
/// <param name="room"></param>
/// <returns></returns>
/// <summary>
/// GetNextAvailableAssetNumber method
/// </summary>
public static uint GetNextAvailableAssetNumber(FusionRoom room)
{
uint slotNum = 0;
@@ -113,13 +119,28 @@ namespace PepperDash.Essentials.Core.Fusion
}
/// <summary>
/// Represents a FusionOccupancySensorAsset
/// </summary>
public class FusionOccupancySensorAsset
{
// SlotNumber fixed at 4
/// <summary>
/// Gets or sets the SlotNumber
/// </summary>
public uint SlotNumber { get { return 4; } }
/// <summary>
/// Gets or sets the Name
/// </summary>
public string Name { get { return "Occupancy Sensor"; } }
/// <summary>
/// Gets or sets the Type
/// </summary>
public eAssetType Type { get; set; }
/// <summary>
/// Gets or sets the InstanceId
/// </summary>
public string InstanceId { get; set; }
public FusionOccupancySensorAsset()
@@ -134,11 +155,26 @@ namespace PepperDash.Essentials.Core.Fusion
}
}
/// <summary>
/// Represents a FusionAsset
/// </summary>
public class FusionAsset
{
/// <summary>
/// Gets or sets the SlotNumber
/// </summary>
public uint SlotNumber { get; set; }
/// <summary>
/// Gets or sets the Name
/// </summary>
public string Name { get; set; }
/// <summary>
/// Gets or sets the Type
/// </summary>
public string Type { get; set; }
/// <summary>
/// Gets or sets the InstanceId
/// </summary>
public string InstanceId { get;set; }
public FusionAsset()
@@ -164,8 +200,14 @@ namespace PepperDash.Essentials.Core.Fusion
//***************************************************************************************************
/// <summary>
/// Represents a RoomSchedule
/// </summary>
public class RoomSchedule
{
/// <summary>
/// Gets or sets the Meetings
/// </summary>
public List<Event> Meetings { get; set; }
public RoomSchedule()
@@ -178,7 +220,7 @@ namespace PepperDash.Essentials.Core.Fusion
// Helper Classes for XML API
/// <summary>
/// Data needed to request the local time from the Fusion server
/// Represents a LocalTimeRequest
/// </summary>
public class LocalTimeRequest
{
@@ -192,6 +234,9 @@ namespace PepperDash.Essentials.Core.Fusion
public class RequestSchedule
{
//[XmlElement(ElementName = "RequestID")]
/// <summary>
/// Gets or sets the RequestID
/// </summary>
public string RequestID { get; set; }
//[XmlElement(ElementName = "RoomID")]
public string RoomID { get; set; }
@@ -211,15 +256,30 @@ namespace PepperDash.Essentials.Core.Fusion
//[XmlRoot(ElementName = "RequestAction")]
/// <summary>
/// Represents a RequestAction
/// </summary>
public class RequestAction
{
//[XmlElement(ElementName = "RequestID")]
/// <summary>
/// Gets or sets the RequestID
/// </summary>
public string RequestID { get; set; }
//[XmlElement(ElementName = "RoomID")]
/// <summary>
/// Gets or sets the RoomID
/// </summary>
public string RoomID { get; set; }
//[XmlElement(ElementName = "ActionID")]
/// <summary>
/// Gets or sets the ActionID
/// </summary>
public string ActionID { get; set; }
//[XmlElement(ElementName = "Parameters")]
/// <summary>
/// Gets or sets the Parameters
/// </summary>
public List<Parameter> Parameters { get; set; }
public RequestAction(string roomID, string actionID, List<Parameter> parameters)
@@ -231,22 +291,43 @@ namespace PepperDash.Essentials.Core.Fusion
}
//[XmlRoot(ElementName = "ActionResponse")]
/// <summary>
/// Represents a ActionResponse
/// </summary>
public class ActionResponse
{
//[XmlElement(ElementName = "RequestID")]
/// <summary>
/// Gets or sets the RequestID
/// </summary>
public string RequestID { get; set; }
//[XmlElement(ElementName = "ActionID")]
/// <summary>
/// Gets or sets the ActionID
/// </summary>
public string ActionID { get; set; }
//[XmlElement(ElementName = "Parameters")]
/// <summary>
/// Gets or sets the Parameters
/// </summary>
public List<Parameter> Parameters { get; set; }
}
//[XmlRoot(ElementName = "Parameter")]
/// <summary>
/// Represents a Parameter
/// </summary>
public class Parameter
{
//[XmlAttribute(AttributeName = "ID")]
/// <summary>
/// Gets or sets the ID
/// </summary>
public string ID { get; set; }
//[XmlAttribute(AttributeName = "Value")]
/// <summary>
/// Gets or sets the Value
/// </summary>
public string Value { get; set; }
}
@@ -279,51 +360,120 @@ namespace PepperDash.Essentials.Core.Fusion
}
//[XmlRoot(ElementName = "Event")]
/// <summary>
/// Represents a Event
/// </summary>
public class Event
{
//[XmlElement(ElementName = "MeetingID")]
/// <summary>
/// Gets or sets the MeetingID
/// </summary>
public string MeetingID { get; set; }
//[XmlElement(ElementName = "RVMeetingID")]
/// <summary>
/// Gets or sets the RVMeetingID
/// </summary>
public string RVMeetingID { get; set; }
//[XmlElement(ElementName = "Recurring")]
/// <summary>
/// Gets or sets the Recurring
/// </summary>
public string Recurring { get; set; }
//[XmlElement(ElementName = "InstanceID")]
/// <summary>
/// Gets or sets the InstanceID
/// </summary>
public string InstanceID { get; set; }
//[XmlElement(ElementName = "dtStart")]
/// <summary>
/// Gets or sets the dtStart
/// </summary>
public DateTime dtStart { get; set; }
//[XmlElement(ElementName = "dtEnd")]
/// <summary>
/// Gets or sets the dtEnd
/// </summary>
public DateTime dtEnd { get; set; }
//[XmlElement(ElementName = "Organizer")]
/// <summary>
/// Gets or sets the Organizer
/// </summary>
public string Organizer { get; set; }
//[XmlElement(ElementName = "Attendees")]
/// <summary>
/// Gets or sets the Attendees
/// </summary>
public Attendees Attendees { get; set; }
//[XmlElement(ElementName = "Resources")]
/// <summary>
/// Gets or sets the Resources
/// </summary>
public Resources Resources { get; set; }
//[XmlElement(ElementName = "IsEvent")]
/// <summary>
/// Gets or sets the IsEvent
/// </summary>
public string IsEvent { get; set; }
//[XmlElement(ElementName = "IsRoomViewMeeting")]
/// <summary>
/// Gets or sets the IsRoomViewMeeting
/// </summary>
public string IsRoomViewMeeting { get; set; }
//[XmlElement(ElementName = "IsPrivate")]
/// <summary>
/// Gets or sets the IsPrivate
/// </summary>
public string IsPrivate { get; set; }
//[XmlElement(ElementName = "IsExchangePrivate")]
/// <summary>
/// Gets or sets the IsExchangePrivate
/// </summary>
public string IsExchangePrivate { get; set; }
//[XmlElement(ElementName = "MeetingTypes")]
/// <summary>
/// Gets or sets the MeetingTypes
/// </summary>
public MeetingTypes MeetingTypes { get; set; }
//[XmlElement(ElementName = "ParticipantCode")]
/// <summary>
/// Gets or sets the ParticipantCode
/// </summary>
public string ParticipantCode { get; set; }
//[XmlElement(ElementName = "PhoneNo")]
/// <summary>
/// Gets or sets the PhoneNo
/// </summary>
public string PhoneNo { get; set; }
//[XmlElement(ElementName = "WelcomeMsg")]
/// <summary>
/// Gets or sets the WelcomeMsg
/// </summary>
public string WelcomeMsg { get; set; }
//[XmlElement(ElementName = "Subject")]
/// <summary>
/// Gets or sets the Subject
/// </summary>
public string Subject { get; set; }
//[XmlElement(ElementName = "LiveMeeting")]
/// <summary>
/// Gets or sets the LiveMeeting
/// </summary>
public LiveMeeting LiveMeeting { get; set; }
//[XmlElement(ElementName = "ShareDocPath")]
/// <summary>
/// Gets or sets the ShareDocPath
/// </summary>
public string ShareDocPath { get; set; }
//[XmlElement(ElementName = "HaveAttendees")]
/// <summary>
/// Gets or sets the HaveAttendees
/// </summary>
public string HaveAttendees { get; set; }
//[XmlElement(ElementName = "HaveResources")]
/// <summary>
/// Gets or sets the HaveResources
/// </summary>
public string HaveResources { get; set; }
/// <summary>
@@ -415,86 +565,167 @@ namespace PepperDash.Essentials.Core.Fusion
}
//[XmlRoot(ElementName = "Resources")]
/// <summary>
/// Represents a Resources
/// </summary>
public class Resources
{
//[XmlElement(ElementName = "Rooms")]
/// <summary>
/// Gets or sets the Rooms
/// </summary>
public Rooms Rooms { get; set; }
}
//[XmlRoot(ElementName = "Rooms")]
/// <summary>
/// Represents a Rooms
/// </summary>
public class Rooms
{
//[XmlElement(ElementName = "Room")]
/// <summary>
/// Gets or sets the Room
/// </summary>
public List<Room> Room { get; set; }
}
//[XmlRoot(ElementName = "Room")]
/// <summary>
/// Represents a Room
/// </summary>
public class Room
{
//[XmlElement(ElementName = "Name")]
/// <summary>
/// Gets or sets the Name
/// </summary>
public string Name { get; set; }
//[XmlElement(ElementName = "ID")]
/// <summary>
/// Gets or sets the ID
/// </summary>
public string ID { get; set; }
//[XmlElement(ElementName = "MPType")]
/// <summary>
/// Gets or sets the MPType
/// </summary>
public string MPType { get; set; }
}
//[XmlRoot(ElementName = "Attendees")]
/// <summary>
/// Represents a Attendees
/// </summary>
public class Attendees
{
//[XmlElement(ElementName = "Required")]
/// <summary>
/// Gets or sets the Required
/// </summary>
public Required Required { get; set; }
//[XmlElement(ElementName = "Optional")]
/// <summary>
/// Gets or sets the Optional
/// </summary>
public Optional Optional { get; set; }
}
//[XmlRoot(ElementName = "Required")]
/// <summary>
/// Represents a Required
/// </summary>
public class Required
{
//[XmlElement(ElementName = "Attendee")]
/// <summary>
/// Gets or sets the Attendee
/// </summary>
public List<string> Attendee { get; set; }
}
//[XmlRoot(ElementName = "Optional")]
/// <summary>
/// Represents a Optional
/// </summary>
public class Optional
{
//[XmlElement(ElementName = "Attendee")]
/// <summary>
/// Gets or sets the Attendee
/// </summary>
public List<string> Attendee { get; set; }
}
//[XmlRoot(ElementName = "MeetingType")]
/// <summary>
/// Represents a MeetingType
/// </summary>
public class MeetingType
{
//[XmlAttribute(AttributeName = "ID")]
/// <summary>
/// Gets or sets the ID
/// </summary>
public string ID { get; set; }
//[XmlAttribute(AttributeName = "Value")]
/// <summary>
/// Gets or sets the Value
/// </summary>
public string Value { get; set; }
}
//[XmlRoot(ElementName = "MeetingTypes")]
/// <summary>
/// Represents a MeetingTypes
/// </summary>
public class MeetingTypes
{
//[XmlElement(ElementName = "MeetingType")]
/// <summary>
/// Gets or sets the MeetingType
/// </summary>
public List<MeetingType> MeetingType { get; set; }
}
//[XmlRoot(ElementName = "LiveMeeting")]
/// <summary>
/// Represents a LiveMeeting
/// </summary>
public class LiveMeeting
{
//[XmlElement(ElementName = "URL")]
/// <summary>
/// Gets or sets the URL
/// </summary>
public string URL { get; set; }
//[XmlElement(ElementName = "ID")]
/// <summary>
/// Gets or sets the ID
/// </summary>
public string ID { get; set; }
//[XmlElement(ElementName = "Key")]
/// <summary>
/// Gets or sets the Key
/// </summary>
public string Key { get; set; }
//[XmlElement(ElementName = "Subject")]
/// <summary>
/// Gets or sets the Subject
/// </summary>
public string Subject { get; set; }
}
//[XmlRoot(ElementName = "LiveMeetingURL")]
/// <summary>
/// Represents a LiveMeetingURL
/// </summary>
public class LiveMeetingURL
{
//[XmlElement(ElementName = "LiveMeeting")]
/// <summary>
/// Gets or sets the LiveMeeting
/// </summary>
public LiveMeeting LiveMeeting { get; set; }
}
}