mirror of
https://github.com/PepperDash/Essentials.git
synced 2026-08-31 19:08:29 +00:00
docs: add missing XML comments for Mobile Control Project
This commit is contained in:
parent
c557c6cdd6
commit
98d0cc8fdc
28 changed files with 576 additions and 177 deletions
|
|
@ -17,9 +17,15 @@ namespace PepperDash.Essentials.WebSocketServer
|
|||
[JsonProperty("clientId")]
|
||||
public string ClientId { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Room Key for this client
|
||||
/// </summary>
|
||||
[JsonProperty("roomKey")]
|
||||
public string RoomKey { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// System UUID for this system
|
||||
/// </summary>
|
||||
[JsonProperty("systemUUid")]
|
||||
public string SystemUuid { get; set; }
|
||||
|
||||
|
|
|
|||
|
|
@ -14,10 +14,19 @@ namespace PepperDash.Essentials.WebSocketServer
|
|||
/// </summary>
|
||||
public string Code { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Room Key this token is associated with
|
||||
/// </summary>
|
||||
public string RoomKey { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Unique ID for this token
|
||||
/// </summary>
|
||||
public string Uuid { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Touchpanel Key this token is associated with, if this is a touch panel token
|
||||
/// </summary>
|
||||
public string TouchpanelKey { get; set; } = "";
|
||||
|
||||
/// <summary>
|
||||
|
|
|
|||
|
|
@ -315,6 +315,9 @@ namespace PepperDash.Essentials.WebSocketServer
|
|||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Set the internal logging level for the Websocket Server
|
||||
/// </summary>
|
||||
public void SetWebsocketLogLevel(LogLevel level)
|
||||
{
|
||||
CrestronConsole.ConsoleCommandResponse($"Setting direct server debug level to {level}", level.ToString());
|
||||
|
|
|
|||
|
|
@ -13,8 +13,15 @@ namespace PepperDash.Essentials.WebSocketServer
|
|||
/// </summary>
|
||||
public string GrantCode { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the Tokens for this server
|
||||
/// </summary>
|
||||
public Dictionary<string, JoinToken> Tokens { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Initialize a new instance of the <see cref="ServerTokenSecrets"/> class with the provided grant code
|
||||
/// </summary>
|
||||
/// <param name="grantCode">The grant code for this server</param>
|
||||
public ServerTokenSecrets(string grantCode)
|
||||
{
|
||||
GrantCode = grantCode;
|
||||
|
|
|
|||
|
|
@ -14,6 +14,10 @@ namespace PepperDash.Essentials.WebSocketServer
|
|||
/// </summary>
|
||||
public JoinToken Token { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
/// Initialize an instance of the <see cref="UiClientContext"/> class with the provided token
|
||||
/// </summary>
|
||||
/// <param name="token">token for this client</param>
|
||||
public UiClientContext(JoinToken token)
|
||||
{
|
||||
Token = token;
|
||||
|
|
|
|||
|
|
@ -8,12 +8,25 @@ namespace PepperDash.Essentials.WebSocketServer
|
|||
/// </summary>
|
||||
public class Version
|
||||
{
|
||||
/// <summary>
|
||||
/// Server version this Websocket is connected to
|
||||
/// </summary>
|
||||
[JsonProperty("serverVersion")]
|
||||
public string ServerVersion { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// True if the server is on a processor
|
||||
/// </summary>
|
||||
|
||||
[JsonProperty("serverIsRunningOnProcessorHardware")]
|
||||
public bool ServerIsRunningOnProcessorHardware { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
/// Initialize an instance of the <see cref="Version"/> class
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// the <see cref="ServerIsRunningOnProcessorHardware"/> property is set to true by default.
|
||||
/// </remarks>
|
||||
public Version()
|
||||
{
|
||||
ServerIsRunningOnProcessorHardware = true;
|
||||
|
|
|
|||
|
|
@ -13,25 +13,28 @@ namespace PepperDash.Essentials.WebSocketServer
|
|||
}
|
||||
|
||||
/// <summary>
|
||||
/// Represents a WebSocketServerSecret
|
||||
/// Stores a secret value using the provided secret store provider
|
||||
/// </summary>
|
||||
public class WebSocketServerSecret : ISecret
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets or sets the Provider
|
||||
/// Gets the Secret Provider associated with this secret
|
||||
/// </summary>
|
||||
public ISecretProvider Provider { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the Key
|
||||
/// Gets the Key associated with this secret
|
||||
/// </summary>
|
||||
public string Key { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the Value
|
||||
/// Gets the Value associated with this secret
|
||||
/// </summary>
|
||||
public object Value { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
/// Initialize and instance of the <see cref="WebSocketServerSecret"/> class
|
||||
/// </summary>
|
||||
public WebSocketServerSecret(string key, object value, ISecretProvider provider)
|
||||
{
|
||||
Key = key;
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue