Преглед изворни кода

Add all websocket messages to generated openapi spec (#9682)

* Add all websocket messages to generated openapi spec

* Use oneOf

* JsonIgnore ServerId

* Oops

* Add discriminators

* Add WebSocketMessage container for Inbound and Outbound messages
Cody Robibero пре 2 година
родитељ
комит
9a0dfc00f1
51 измењених фајлова са 1192 додато и 91 уклоњено
  1. 138 10
      Jellyfin.Server/Filters/AdditionalModelFilter.cs
  2. 28 0
      MediaBrowser.Controller/Net/WebSocketMessage.cs
  3. 33 0
      MediaBrowser.Controller/Net/WebSocketMessageOfT.cs
  4. 10 0
      MediaBrowser.Controller/Net/WebSocketMessages/IInboundWebSocketMessage.cs
  5. 10 0
      MediaBrowser.Controller/Net/WebSocketMessages/IOutboundWebSocketMessage.cs
  6. 25 0
      MediaBrowser.Controller/Net/WebSocketMessages/Inbound/ActivityLogEntryStartMessage.cs
  7. 25 0
      MediaBrowser.Controller/Net/WebSocketMessages/Inbound/ActivityLogEntryStopMessage.cs
  8. 25 0
      MediaBrowser.Controller/Net/WebSocketMessages/Inbound/ScheduledTasksInfoStartMessage.cs
  9. 25 0
      MediaBrowser.Controller/Net/WebSocketMessages/Inbound/ScheduledTasksInfoStopMessage.cs
  10. 24 0
      MediaBrowser.Controller/Net/WebSocketMessages/Inbound/SessionsStartMessage.cs
  11. 24 0
      MediaBrowser.Controller/Net/WebSocketMessages/Inbound/SessionsStopMessage.cs
  12. 9 0
      MediaBrowser.Controller/Net/WebSocketMessages/InboundWebSocketMessage.cs
  13. 25 0
      MediaBrowser.Controller/Net/WebSocketMessages/Outbound/ActivityLogEntryMessage.cs
  14. 23 0
      MediaBrowser.Controller/Net/WebSocketMessages/Outbound/ForceKeepAliveMessage.cs
  15. 23 0
      MediaBrowser.Controller/Net/WebSocketMessages/Outbound/GeneralCommandMessage.cs
  16. 24 0
      MediaBrowser.Controller/Net/WebSocketMessages/Outbound/LibraryChangedMessage.cs
  17. 23 0
      MediaBrowser.Controller/Net/WebSocketMessages/Outbound/PlayMessage.cs
  18. 23 0
      MediaBrowser.Controller/Net/WebSocketMessages/Outbound/PlaystateMessage.cs
  19. 24 0
      MediaBrowser.Controller/Net/WebSocketMessages/Outbound/PluginInstallationCancelledMessage.cs
  20. 24 0
      MediaBrowser.Controller/Net/WebSocketMessages/Outbound/PluginInstallationCompletedMessage.cs
  21. 24 0
      MediaBrowser.Controller/Net/WebSocketMessages/Outbound/PluginInstallationFailedMessage.cs
  22. 24 0
      MediaBrowser.Controller/Net/WebSocketMessages/Outbound/PluginInstallingMessage.cs
  23. 24 0
      MediaBrowser.Controller/Net/WebSocketMessages/Outbound/PluginUninstalledMessage.cs
  24. 24 0
      MediaBrowser.Controller/Net/WebSocketMessages/Outbound/RefreshProgressMessage.cs
  25. 14 0
      MediaBrowser.Controller/Net/WebSocketMessages/Outbound/RestartRequiredMessage.cs
  26. 24 0
      MediaBrowser.Controller/Net/WebSocketMessages/Outbound/ScheduledTaskEndedMessage.cs
  27. 25 0
      MediaBrowser.Controller/Net/WebSocketMessages/Outbound/ScheduledTasksInfoMessage.cs
  28. 24 0
      MediaBrowser.Controller/Net/WebSocketMessages/Outbound/SeriesTimerCancelledMessage.cs
  29. 24 0
      MediaBrowser.Controller/Net/WebSocketMessages/Outbound/SeriesTimerCreatedMessage.cs
  30. 14 0
      MediaBrowser.Controller/Net/WebSocketMessages/Outbound/ServerRestartingMessage.cs
  31. 14 0
      MediaBrowser.Controller/Net/WebSocketMessages/Outbound/ServerShuttingDownMessage.cs
  32. 24 0
      MediaBrowser.Controller/Net/WebSocketMessages/Outbound/SessionsMessage.cs
  33. 24 0
      MediaBrowser.Controller/Net/WebSocketMessages/Outbound/SyncPlayCommandMessage.cs
  34. 24 0
      MediaBrowser.Controller/Net/WebSocketMessages/Outbound/SyncPlayGroupUpdateCommandMessage.cs
  35. 25 0
      MediaBrowser.Controller/Net/WebSocketMessages/Outbound/SyncPlayGroupUpdateCommandOfGroupInfoMessage.cs
  36. 25 0
      MediaBrowser.Controller/Net/WebSocketMessages/Outbound/SyncPlayGroupUpdateCommandOfGroupStateUpdateMessage.cs
  37. 25 0
      MediaBrowser.Controller/Net/WebSocketMessages/Outbound/SyncPlayGroupUpdateCommandOfPlayQueueUpdateMessage.cs
  38. 25 0
      MediaBrowser.Controller/Net/WebSocketMessages/Outbound/SyncPlayGroupUpdateCommandOfStringMessage.cs
  39. 24 0
      MediaBrowser.Controller/Net/WebSocketMessages/Outbound/TimerCancelledMessage.cs
  40. 24 0
      MediaBrowser.Controller/Net/WebSocketMessages/Outbound/TimerCreatedMessage.cs
  41. 23 0
      MediaBrowser.Controller/Net/WebSocketMessages/Outbound/UserDataChangedMessage.cs
  42. 24 0
      MediaBrowser.Controller/Net/WebSocketMessages/Outbound/UserDeletedMessage.cs
  43. 24 0
      MediaBrowser.Controller/Net/WebSocketMessages/Outbound/UserUpdatedMessage.cs
  44. 9 0
      MediaBrowser.Controller/Net/WebSocketMessages/OutboundWebSocketMessage.cs
  45. 23 0
      MediaBrowser.Controller/Net/WebSocketMessages/Shared/KeepAliveMessage.cs
  46. 12 12
      MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs
  47. 0 31
      MediaBrowser.Model/Net/WebSocketMessage.cs
  48. 21 33
      MediaBrowser.Model/SyncPlay/GroupUpdate.cs
  49. 31 0
      MediaBrowser.Model/SyncPlay/GroupUpdateOfT.cs
  50. 2 2
      MediaBrowser.Model/SyncPlay/PlayQueueUpdate.cs
  51. 3 3
      MediaBrowser.Model/SyncPlay/SyncPlayQueueItem.cs

+ 138 - 10
Jellyfin.Server/Filters/AdditionalModelFilter.cs

@@ -1,12 +1,16 @@
 using System;
+using System.Collections.Generic;
+using System.ComponentModel;
 using System.Linq;
+using System.Reflection;
 using Jellyfin.Extensions;
 using Jellyfin.Server.Migrations;
 using MediaBrowser.Common.Plugins;
 using MediaBrowser.Controller.Configuration;
-using MediaBrowser.Controller.LiveTv;
+using MediaBrowser.Controller.Net;
+using MediaBrowser.Controller.Net.WebSocketMessages;
+using MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
 using MediaBrowser.Model.ApiClient;
-using MediaBrowser.Model.Entities;
 using MediaBrowser.Model.Session;
 using MediaBrowser.Model.SyncPlay;
 using Microsoft.OpenApi.Any;
@@ -36,17 +40,141 @@ namespace Jellyfin.Server.Filters
         /// <inheritdoc />
         public void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)
         {
-            context.SchemaGenerator.GenerateSchema(typeof(LibraryUpdateInfo), context.SchemaRepository);
             context.SchemaGenerator.GenerateSchema(typeof(IPlugin), context.SchemaRepository);
-            context.SchemaGenerator.GenerateSchema(typeof(PlayRequest), context.SchemaRepository);
-            context.SchemaGenerator.GenerateSchema(typeof(PlaystateRequest), context.SchemaRepository);
-            context.SchemaGenerator.GenerateSchema(typeof(TimerEventInfo), context.SchemaRepository);
-            context.SchemaGenerator.GenerateSchema(typeof(SendCommand), context.SchemaRepository);
-            context.SchemaGenerator.GenerateSchema(typeof(GeneralCommandType), context.SchemaRepository);
 
-            context.SchemaGenerator.GenerateSchema(typeof(GroupUpdate<object>), context.SchemaRepository);
+            var webSocketTypes = typeof(WebSocketMessage).Assembly.GetTypes()
+                .Where(t => t.IsSubclassOf(typeof(WebSocketMessage))
+                            && !t.IsGenericType
+                            && t != typeof(WebSocketMessageInfo))
+                .ToList();
+
+            var inboundWebSocketSchemas = new List<OpenApiSchema>();
+            var inboundWebSocketDiscriminators = new Dictionary<string, string>();
+            foreach (var type in webSocketTypes.Where(t => typeof(IInboundWebSocketMessage).IsAssignableFrom(t)))
+            {
+                var messageType = (SessionMessageType?)type.GetProperty(nameof(WebSocketMessage.MessageType))?.GetCustomAttribute<DefaultValueAttribute>()?.Value;
+                if (messageType is null)
+                {
+                    continue;
+                }
+
+                var schema = context.SchemaGenerator.GenerateSchema(type, context.SchemaRepository);
+                inboundWebSocketSchemas.Add(schema);
+                inboundWebSocketDiscriminators[messageType.ToString()!] = schema.Reference.ReferenceV3;
+            }
+
+            var inboundWebSocketMessageSchema = new OpenApiSchema
+            {
+                Type = "object",
+                Description = "Represents the list of possible inbound websocket types",
+                Reference = new OpenApiReference
+                {
+                    Id = nameof(InboundWebSocketMessage),
+                    Type = ReferenceType.Schema
+                },
+                OneOf = inboundWebSocketSchemas,
+                Discriminator = new OpenApiDiscriminator
+                {
+                    PropertyName = nameof(WebSocketMessage.MessageType),
+                    Mapping = inboundWebSocketDiscriminators
+                }
+            };
+
+            context.SchemaRepository.AddDefinition(nameof(InboundWebSocketMessage), inboundWebSocketMessageSchema);
+
+            var outboundWebSocketSchemas = new List<OpenApiSchema>();
+            var outboundWebSocketDiscriminators = new Dictionary<string, string>();
+            foreach (var type in webSocketTypes.Where(t => typeof(IOutboundWebSocketMessage).IsAssignableFrom(t)))
+            {
+                var messageType = (SessionMessageType?)type.GetProperty(nameof(WebSocketMessage.MessageType))?.GetCustomAttribute<DefaultValueAttribute>()?.Value;
+                if (messageType is null)
+                {
+                    continue;
+                }
+
+                // Additional discriminator needed for GroupUpdate models...
+                if (messageType == SessionMessageType.SyncPlayGroupUpdate && type != typeof(SyncPlayGroupUpdateCommandMessage))
+                {
+                    continue;
+                }
+
+                var schema = context.SchemaGenerator.GenerateSchema(type, context.SchemaRepository);
+                outboundWebSocketSchemas.Add(schema);
+                outboundWebSocketDiscriminators.Add(messageType.ToString()!, schema.Reference.ReferenceV3);
+            }
+
+            var outboundWebSocketMessageSchema = new OpenApiSchema
+            {
+                Type = "object",
+                Description = "Represents the list of possible outbound websocket types",
+                Reference = new OpenApiReference
+                {
+                    Id = nameof(OutboundWebSocketMessage),
+                    Type = ReferenceType.Schema
+                },
+                OneOf = outboundWebSocketSchemas,
+                Discriminator = new OpenApiDiscriminator
+                {
+                    PropertyName = nameof(WebSocketMessage.MessageType),
+                    Mapping = outboundWebSocketDiscriminators
+                }
+            };
+
+            context.SchemaRepository.AddDefinition(nameof(OutboundWebSocketMessage), outboundWebSocketMessageSchema);
+            context.SchemaRepository.AddDefinition(
+                nameof(WebSocketMessage),
+                new OpenApiSchema
+                {
+                    Type = "object",
+                    Description = "Represents the possible websocket types",
+                    Reference = new OpenApiReference
+                    {
+                        Id = nameof(WebSocketMessage),
+                        Type = ReferenceType.Schema
+                    },
+                    OneOf = new[]
+                    {
+                        inboundWebSocketMessageSchema,
+                        outboundWebSocketMessageSchema
+                    }
+                });
+
+            // Manually generate sync play GroupUpdate messages.
+            if (!context.SchemaRepository.Schemas.TryGetValue(nameof(GroupUpdate), out var groupUpdateSchema))
+            {
+                groupUpdateSchema = context.SchemaGenerator.GenerateSchema(typeof(GroupUpdate), context.SchemaRepository);
+            }
+
+            var groupUpdateOfGroupInfoSchema = context.SchemaGenerator.GenerateSchema(typeof(GroupUpdate<GroupInfoDto>), context.SchemaRepository);
+            var groupUpdateOfGroupStateSchema = context.SchemaGenerator.GenerateSchema(typeof(GroupUpdate<GroupStateUpdate>), context.SchemaRepository);
+            var groupUpdateOfStringSchema = context.SchemaGenerator.GenerateSchema(typeof(GroupUpdate<string>), context.SchemaRepository);
+            var groupUpdateOfPlayQueueSchema = context.SchemaGenerator.GenerateSchema(typeof(GroupUpdate<PlayQueueUpdate>), context.SchemaRepository);
+
+            groupUpdateSchema.OneOf = new List<OpenApiSchema>
+            {
+                groupUpdateOfGroupInfoSchema,
+                groupUpdateOfGroupStateSchema,
+                groupUpdateOfStringSchema,
+                groupUpdateOfPlayQueueSchema
+            };
+
+            groupUpdateSchema.Discriminator = new OpenApiDiscriminator
+            {
+                PropertyName = nameof(GroupUpdate.Type),
+                Mapping = new Dictionary<string, string>
+                {
+                    { GroupUpdateType.UserJoined.ToString(), groupUpdateOfStringSchema.Reference.ReferenceV3 },
+                    { GroupUpdateType.UserLeft.ToString(), groupUpdateOfStringSchema.Reference.ReferenceV3 },
+                    { GroupUpdateType.GroupJoined.ToString(), groupUpdateOfGroupInfoSchema.Reference.ReferenceV3 },
+                    { GroupUpdateType.GroupLeft.ToString(), groupUpdateOfStringSchema.Reference.ReferenceV3 },
+                    { GroupUpdateType.StateUpdate.ToString(), groupUpdateOfGroupStateSchema.Reference.ReferenceV3 },
+                    { GroupUpdateType.PlayQueue.ToString(), groupUpdateOfPlayQueueSchema.Reference.ReferenceV3 },
+                    { GroupUpdateType.NotInGroup.ToString(), groupUpdateOfStringSchema.Reference.ReferenceV3 },
+                    { GroupUpdateType.GroupDoesNotExist.ToString(), groupUpdateOfStringSchema.Reference.ReferenceV3 },
+                    { GroupUpdateType.LibraryAccessDenied.ToString(), groupUpdateOfStringSchema.Reference.ReferenceV3 }
+                }
+            };
 
-            context.SchemaGenerator.GenerateSchema(typeof(SessionMessageType), context.SchemaRepository);
             context.SchemaGenerator.GenerateSchema(typeof(ServerDiscoveryInfo), context.SchemaRepository);
 
             foreach (var configuration in _serverConfigurationManager.GetConfigurationStores())

+ 28 - 0
MediaBrowser.Controller/Net/WebSocketMessage.cs

@@ -0,0 +1,28 @@
+using System;
+using System.Text.Json.Serialization;
+using MediaBrowser.Model.Session;
+
+namespace MediaBrowser.Controller.Net;
+
+/// <summary>
+/// Websocket message without data.
+/// </summary>
+public abstract class WebSocketMessage
+{
+    /// <summary>
+    /// Gets or sets the type of the message.
+    /// TODO make this abstract and get only.
+    /// </summary>
+    public virtual SessionMessageType MessageType { get; set; }
+
+    /// <summary>
+    /// Gets or sets the message id.
+    /// </summary>
+    public Guid MessageId { get; set; }
+
+    /// <summary>
+    /// Gets or sets the server id.
+    /// </summary>
+    [JsonIgnore]
+    public string? ServerId { get; set; }
+}

+ 33 - 0
MediaBrowser.Controller/Net/WebSocketMessageOfT.cs

@@ -0,0 +1,33 @@
+#pragma warning disable SA1649 // File name must equal class name.
+
+namespace MediaBrowser.Controller.Net;
+
+/// <summary>
+/// Class WebSocketMessage.
+/// </summary>
+/// <typeparam name="T">The type of the data.</typeparam>
+// TODO make this abstract, remove empty ctor.
+public class WebSocketMessage<T> : WebSocketMessage
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="WebSocketMessage{T}"/> class.
+    /// </summary>
+    public WebSocketMessage()
+    {
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="WebSocketMessage{T}"/> class.
+    /// </summary>
+    /// <param name="data">The data to send.</param>
+    protected WebSocketMessage(T data)
+    {
+        Data = data;
+    }
+
+    /// <summary>
+    /// Gets or sets the data.
+    /// </summary>
+    // TODO make this set only.
+    public T? Data { get; set; }
+}

+ 10 - 0
MediaBrowser.Controller/Net/WebSocketMessages/IInboundWebSocketMessage.cs

@@ -0,0 +1,10 @@
+#pragma warning disable CA1040
+
+namespace MediaBrowser.Controller.Net.WebSocketMessages;
+
+/// <summary>
+/// Interface representing that the websocket message is inbound.
+/// </summary>
+public interface IInboundWebSocketMessage
+{
+}

+ 10 - 0
MediaBrowser.Controller/Net/WebSocketMessages/IOutboundWebSocketMessage.cs

@@ -0,0 +1,10 @@
+#pragma warning disable CA1040
+
+namespace MediaBrowser.Controller.Net.WebSocketMessages;
+
+/// <summary>
+/// Interface representing that the websocket message is outbound.
+/// </summary>
+public interface IOutboundWebSocketMessage
+{
+}

+ 25 - 0
MediaBrowser.Controller/Net/WebSocketMessages/Inbound/ActivityLogEntryStartMessage.cs

@@ -0,0 +1,25 @@
+using System.Collections.Generic;
+using System.ComponentModel;
+using MediaBrowser.Model.Activity;
+using MediaBrowser.Model.Session;
+
+namespace MediaBrowser.Controller.Net.WebSocketMessages.Inbound;
+
+/// <summary>
+/// Activity log entry start message.
+/// </summary>
+public class ActivityLogEntryStartMessage : WebSocketMessage<IReadOnlyCollection<ActivityLogEntry>>, IInboundWebSocketMessage
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="ActivityLogEntryStartMessage"/> class.
+    /// </summary>
+    /// <param name="data">Collection of activity log entries.</param>
+    public ActivityLogEntryStartMessage(IReadOnlyCollection<ActivityLogEntry> data)
+        : base(data)
+    {
+    }
+
+    /// <inheritdoc />
+    [DefaultValue(SessionMessageType.ActivityLogEntryStart)]
+    public override SessionMessageType MessageType => SessionMessageType.ActivityLogEntryStart;
+}

+ 25 - 0
MediaBrowser.Controller/Net/WebSocketMessages/Inbound/ActivityLogEntryStopMessage.cs

@@ -0,0 +1,25 @@
+using System.Collections.Generic;
+using System.ComponentModel;
+using MediaBrowser.Model.Activity;
+using MediaBrowser.Model.Session;
+
+namespace MediaBrowser.Controller.Net.WebSocketMessages.Inbound;
+
+/// <summary>
+/// Activity log entry stop message.
+/// </summary>
+public class ActivityLogEntryStopMessage : WebSocketMessage<IReadOnlyCollection<ActivityLogEntry>>, IInboundWebSocketMessage
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="ActivityLogEntryStopMessage"/> class.
+    /// </summary>
+    /// <param name="data">Collection of activity log entries.</param>
+    public ActivityLogEntryStopMessage(IReadOnlyCollection<ActivityLogEntry> data)
+        : base(data)
+    {
+    }
+
+    /// <inheritdoc />
+    [DefaultValue(SessionMessageType.ActivityLogEntryStop)]
+    public override SessionMessageType MessageType => SessionMessageType.ActivityLogEntryStop;
+}

+ 25 - 0
MediaBrowser.Controller/Net/WebSocketMessages/Inbound/ScheduledTasksInfoStartMessage.cs

@@ -0,0 +1,25 @@
+using System.Collections.Generic;
+using System.ComponentModel;
+using MediaBrowser.Model.Session;
+using MediaBrowser.Model.Tasks;
+
+namespace MediaBrowser.Controller.Net.WebSocketMessages.Inbound;
+
+/// <summary>
+/// Scheduled tasks info start message.
+/// </summary>
+public class ScheduledTasksInfoStartMessage : WebSocketMessage<IReadOnlyCollection<TaskInfo>>, IInboundWebSocketMessage
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="ScheduledTasksInfoStartMessage"/> class.
+    /// </summary>
+    /// <param name="data">Collection of task info.</param>
+    public ScheduledTasksInfoStartMessage(IReadOnlyCollection<TaskInfo> data)
+        : base(data)
+    {
+    }
+
+    /// <inheritdoc />
+    [DefaultValue(SessionMessageType.ScheduledTasksInfoStart)]
+    public override SessionMessageType MessageType => SessionMessageType.ScheduledTasksInfoStart;
+}

+ 25 - 0
MediaBrowser.Controller/Net/WebSocketMessages/Inbound/ScheduledTasksInfoStopMessage.cs

@@ -0,0 +1,25 @@
+using System.Collections.Generic;
+using System.ComponentModel;
+using MediaBrowser.Model.Session;
+using MediaBrowser.Model.Tasks;
+
+namespace MediaBrowser.Controller.Net.WebSocketMessages.Inbound;
+
+/// <summary>
+/// Scheduled tasks info stop message.
+/// </summary>
+public class ScheduledTasksInfoStopMessage : WebSocketMessage<IReadOnlyCollection<TaskInfo>>, IInboundWebSocketMessage
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="ScheduledTasksInfoStopMessage"/> class.
+    /// </summary>
+    /// <param name="data">Collection of task info.</param>
+    public ScheduledTasksInfoStopMessage(IReadOnlyCollection<TaskInfo> data)
+        : base(data)
+    {
+    }
+
+    /// <inheritdoc />
+    [DefaultValue(SessionMessageType.ScheduledTasksInfoStop)]
+    public override SessionMessageType MessageType => SessionMessageType.ScheduledTasksInfoStop;
+}

+ 24 - 0
MediaBrowser.Controller/Net/WebSocketMessages/Inbound/SessionsStartMessage.cs

@@ -0,0 +1,24 @@
+using System.ComponentModel;
+using MediaBrowser.Controller.Session;
+using MediaBrowser.Model.Session;
+
+namespace MediaBrowser.Controller.Net.WebSocketMessages.Inbound;
+
+/// <summary>
+/// Sessions start message.
+/// </summary>
+public class SessionsStartMessage : WebSocketMessage<SessionInfo>, IInboundWebSocketMessage
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="SessionsStartMessage"/> class.
+    /// </summary>
+    /// <param name="data">Session info.</param>
+    public SessionsStartMessage(SessionInfo data)
+        : base(data)
+    {
+    }
+
+    /// <inheritdoc />
+    [DefaultValue(SessionMessageType.SessionsStart)]
+    public override SessionMessageType MessageType => SessionMessageType.SessionsStart;
+}

+ 24 - 0
MediaBrowser.Controller/Net/WebSocketMessages/Inbound/SessionsStopMessage.cs

@@ -0,0 +1,24 @@
+using System.ComponentModel;
+using MediaBrowser.Controller.Session;
+using MediaBrowser.Model.Session;
+
+namespace MediaBrowser.Controller.Net.WebSocketMessages.Inbound;
+
+/// <summary>
+/// Sessions stop message.
+/// </summary>
+public class SessionsStopMessage : WebSocketMessage<SessionInfo>, IInboundWebSocketMessage
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="SessionsStopMessage"/> class.
+    /// </summary>
+    /// <param name="data">Session info.</param>
+    public SessionsStopMessage(SessionInfo data)
+        : base(data)
+    {
+    }
+
+    /// <inheritdoc />
+    [DefaultValue(SessionMessageType.SessionsStop)]
+    public override SessionMessageType MessageType => SessionMessageType.SessionsStop;
+}

+ 9 - 0
MediaBrowser.Controller/Net/WebSocketMessages/InboundWebSocketMessage.cs

@@ -0,0 +1,9 @@
+namespace MediaBrowser.Controller.Net.WebSocketMessages;
+
+/// <summary>
+/// Class representing the list of outbound websocket message types.
+/// Only used in openapi generation.
+/// </summary>
+public class InboundWebSocketMessage : WebSocketMessage
+{
+}

+ 25 - 0
MediaBrowser.Controller/Net/WebSocketMessages/Outbound/ActivityLogEntryMessage.cs

@@ -0,0 +1,25 @@
+using System.Collections.Generic;
+using System.ComponentModel;
+using MediaBrowser.Model.Activity;
+using MediaBrowser.Model.Session;
+
+namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
+
+/// <summary>
+/// Activity log created message.
+/// </summary>
+public class ActivityLogEntryMessage : WebSocketMessage<IReadOnlyList<ActivityLogEntry>>, IOutboundWebSocketMessage
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="ActivityLogEntryMessage"/> class.
+    /// </summary>
+    /// <param name="data">List of activity log entries.</param>
+    public ActivityLogEntryMessage(IReadOnlyList<ActivityLogEntry> data)
+        : base(data)
+    {
+    }
+
+    /// <inheritdoc />
+    [DefaultValue(SessionMessageType.ActivityLogEntry)]
+    public override SessionMessageType MessageType => SessionMessageType.ActivityLogEntry;
+}

+ 23 - 0
MediaBrowser.Controller/Net/WebSocketMessages/Outbound/ForceKeepAliveMessage.cs

@@ -0,0 +1,23 @@
+using System.ComponentModel;
+using MediaBrowser.Model.Session;
+
+namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
+
+/// <summary>
+/// Force keep alive websocket messages.
+/// </summary>
+public class ForceKeepAliveMessage : WebSocketMessage<int>, IOutboundWebSocketMessage
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="ForceKeepAliveMessage"/> class.
+    /// </summary>
+    /// <param name="data">The timeout in seconds.</param>
+    public ForceKeepAliveMessage(int data)
+        : base(data)
+    {
+    }
+
+    /// <inheritdoc />
+    [DefaultValue(SessionMessageType.ForceKeepAlive)]
+    public override SessionMessageType MessageType => SessionMessageType.ForceKeepAlive;
+}

+ 23 - 0
MediaBrowser.Controller/Net/WebSocketMessages/Outbound/GeneralCommandMessage.cs

@@ -0,0 +1,23 @@
+using System.ComponentModel;
+using MediaBrowser.Model.Session;
+
+namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
+
+/// <summary>
+/// General command websocket message.
+/// </summary>
+public class GeneralCommandMessage : WebSocketMessage<GeneralCommand>, IOutboundWebSocketMessage
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="GeneralCommandMessage"/> class.
+    /// </summary>
+    /// <param name="data">The general command.</param>
+    public GeneralCommandMessage(GeneralCommand data)
+        : base(data)
+    {
+    }
+
+    /// <inheritdoc />
+    [DefaultValue(SessionMessageType.GeneralCommand)]
+    public override SessionMessageType MessageType => SessionMessageType.GeneralCommand;
+}

+ 24 - 0
MediaBrowser.Controller/Net/WebSocketMessages/Outbound/LibraryChangedMessage.cs

@@ -0,0 +1,24 @@
+using System.ComponentModel;
+using MediaBrowser.Model.Entities;
+using MediaBrowser.Model.Session;
+
+namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
+
+/// <summary>
+/// Library changed message.
+/// </summary>
+public class LibraryChangedMessage : WebSocketMessage<LibraryUpdateInfo>, IOutboundWebSocketMessage
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="LibraryChangedMessage"/> class.
+    /// </summary>
+    /// <param name="data">The library update info.</param>
+    public LibraryChangedMessage(LibraryUpdateInfo data)
+        : base(data)
+    {
+    }
+
+    /// <inheritdoc />
+    [DefaultValue(SessionMessageType.LibraryChanged)]
+    public override SessionMessageType MessageType => SessionMessageType.LibraryChanged;
+}

+ 23 - 0
MediaBrowser.Controller/Net/WebSocketMessages/Outbound/PlayMessage.cs

@@ -0,0 +1,23 @@
+using System.ComponentModel;
+using MediaBrowser.Model.Session;
+
+namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
+
+/// <summary>
+/// Play command websocket message.
+/// </summary>
+public class PlayMessage : WebSocketMessage<PlayRequest>, IOutboundWebSocketMessage
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="PlayMessage"/> class.
+    /// </summary>
+    /// <param name="data">The play request.</param>
+    public PlayMessage(PlayRequest data)
+        : base(data)
+    {
+    }
+
+    /// <inheritdoc />
+    [DefaultValue(SessionMessageType.Play)]
+    public override SessionMessageType MessageType => SessionMessageType.Play;
+}

+ 23 - 0
MediaBrowser.Controller/Net/WebSocketMessages/Outbound/PlaystateMessage.cs

@@ -0,0 +1,23 @@
+using System.ComponentModel;
+using MediaBrowser.Model.Session;
+
+namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
+
+/// <summary>
+/// Playstate message.
+/// </summary>
+public class PlaystateMessage : WebSocketMessage<PlaystateRequest>, IOutboundWebSocketMessage
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="PlaystateMessage"/> class.
+    /// </summary>
+    /// <param name="data">Playstate request data.</param>
+    public PlaystateMessage(PlaystateRequest data)
+        : base(data)
+    {
+    }
+
+    /// <inheritdoc />
+    [DefaultValue(SessionMessageType.Playstate)]
+    public override SessionMessageType MessageType => SessionMessageType.Playstate;
+}

+ 24 - 0
MediaBrowser.Controller/Net/WebSocketMessages/Outbound/PluginInstallationCancelledMessage.cs

@@ -0,0 +1,24 @@
+using System.ComponentModel;
+using MediaBrowser.Model.Session;
+using MediaBrowser.Model.Updates;
+
+namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
+
+/// <summary>
+/// Plugin installation cancelled message.
+/// </summary>
+public class PluginInstallationCancelledMessage : WebSocketMessage<InstallationInfo>, IOutboundWebSocketMessage
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="PluginInstallationCancelledMessage"/> class.
+    /// </summary>
+    /// <param name="data">Installation info.</param>
+    public PluginInstallationCancelledMessage(InstallationInfo data)
+        : base(data)
+    {
+    }
+
+    /// <inheritdoc />
+    [DefaultValue(SessionMessageType.PackageInstallationCancelled)]
+    public override SessionMessageType MessageType => SessionMessageType.PackageInstallationCancelled;
+}

+ 24 - 0
MediaBrowser.Controller/Net/WebSocketMessages/Outbound/PluginInstallationCompletedMessage.cs

@@ -0,0 +1,24 @@
+using System.ComponentModel;
+using MediaBrowser.Model.Session;
+using MediaBrowser.Model.Updates;
+
+namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
+
+/// <summary>
+/// Plugin installation completed message.
+/// </summary>
+public class PluginInstallationCompletedMessage : WebSocketMessage<InstallationInfo>, IOutboundWebSocketMessage
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="PluginInstallationCompletedMessage"/> class.
+    /// </summary>
+    /// <param name="data">Installation info.</param>
+    public PluginInstallationCompletedMessage(InstallationInfo data)
+        : base(data)
+    {
+    }
+
+    /// <inheritdoc />
+    [DefaultValue(SessionMessageType.PackageInstallationCompleted)]
+    public override SessionMessageType MessageType => SessionMessageType.PackageInstallationCompleted;
+}

+ 24 - 0
MediaBrowser.Controller/Net/WebSocketMessages/Outbound/PluginInstallationFailedMessage.cs

@@ -0,0 +1,24 @@
+using System.ComponentModel;
+using MediaBrowser.Model.Session;
+using MediaBrowser.Model.Updates;
+
+namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
+
+/// <summary>
+/// Plugin installation failed message.
+/// </summary>
+public class PluginInstallationFailedMessage : WebSocketMessage<InstallationInfo>, IOutboundWebSocketMessage
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="PluginInstallationFailedMessage"/> class.
+    /// </summary>
+    /// <param name="data">Installation info.</param>
+    public PluginInstallationFailedMessage(InstallationInfo data)
+        : base(data)
+    {
+    }
+
+    /// <inheritdoc />
+    [DefaultValue(SessionMessageType.PackageInstallationFailed)]
+    public override SessionMessageType MessageType => SessionMessageType.PackageInstallationFailed;
+}

+ 24 - 0
MediaBrowser.Controller/Net/WebSocketMessages/Outbound/PluginInstallingMessage.cs

@@ -0,0 +1,24 @@
+using System.ComponentModel;
+using MediaBrowser.Model.Session;
+using MediaBrowser.Model.Updates;
+
+namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
+
+/// <summary>
+/// Package installing message.
+/// </summary>
+public class PluginInstallingMessage : WebSocketMessage<InstallationInfo>, IOutboundWebSocketMessage
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="PluginInstallingMessage"/> class.
+    /// </summary>
+    /// <param name="data">Installation info.</param>
+    public PluginInstallingMessage(InstallationInfo data)
+        : base(data)
+    {
+    }
+
+    /// <inheritdoc />
+    [DefaultValue(SessionMessageType.PackageInstalling)]
+    public override SessionMessageType MessageType => SessionMessageType.PackageInstalling;
+}

+ 24 - 0
MediaBrowser.Controller/Net/WebSocketMessages/Outbound/PluginUninstalledMessage.cs

@@ -0,0 +1,24 @@
+using System.ComponentModel;
+using MediaBrowser.Model.Plugins;
+using MediaBrowser.Model.Session;
+
+namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
+
+/// <summary>
+/// Plugin uninstalled message.
+/// </summary>
+public class PluginUninstalledMessage : WebSocketMessage<PluginInfo>, IOutboundWebSocketMessage
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="PluginUninstalledMessage"/> class.
+    /// </summary>
+    /// <param name="data">Plugin info.</param>
+    public PluginUninstalledMessage(PluginInfo data)
+        : base(data)
+    {
+    }
+
+    /// <inheritdoc />
+    [DefaultValue(SessionMessageType.PackageUninstalled)]
+    public override SessionMessageType MessageType => SessionMessageType.PackageUninstalled;
+}

+ 24 - 0
MediaBrowser.Controller/Net/WebSocketMessages/Outbound/RefreshProgressMessage.cs

@@ -0,0 +1,24 @@
+using System.Collections.Generic;
+using System.ComponentModel;
+using MediaBrowser.Model.Session;
+
+namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
+
+/// <summary>
+/// Refresh progress message.
+/// </summary>
+public class RefreshProgressMessage : WebSocketMessage<Dictionary<string, string>>, IOutboundWebSocketMessage
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="RefreshProgressMessage"/> class.
+    /// </summary>
+    /// <param name="data">Refresh progress data.</param>
+    public RefreshProgressMessage(Dictionary<string, string> data)
+        : base(data)
+    {
+    }
+
+    /// <inheritdoc />
+    [DefaultValue(SessionMessageType.RefreshProgress)]
+    public override SessionMessageType MessageType => SessionMessageType.RefreshProgress;
+}

+ 14 - 0
MediaBrowser.Controller/Net/WebSocketMessages/Outbound/RestartRequiredMessage.cs

@@ -0,0 +1,14 @@
+using System.ComponentModel;
+using MediaBrowser.Model.Session;
+
+namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
+
+/// <summary>
+/// Restart required.
+/// </summary>
+public class RestartRequiredMessage : WebSocketMessage, IOutboundWebSocketMessage
+{
+    /// <inheritdoc />
+    [DefaultValue(SessionMessageType.RestartRequired)]
+    public override SessionMessageType MessageType => SessionMessageType.RestartRequired;
+}

+ 24 - 0
MediaBrowser.Controller/Net/WebSocketMessages/Outbound/ScheduledTaskEndedMessage.cs

@@ -0,0 +1,24 @@
+using System.ComponentModel;
+using MediaBrowser.Model.Session;
+using MediaBrowser.Model.Tasks;
+
+namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
+
+/// <summary>
+/// Scheduled task ended message.
+/// </summary>
+public class ScheduledTaskEndedMessage : WebSocketMessage<TaskResult>, IOutboundWebSocketMessage
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="ScheduledTaskEndedMessage"/> class.
+    /// </summary>
+    /// <param name="data">Task result.</param>
+    public ScheduledTaskEndedMessage(TaskResult data)
+        : base(data)
+    {
+    }
+
+    /// <inheritdoc />
+    [DefaultValue(SessionMessageType.ScheduledTaskEnded)]
+    public override SessionMessageType MessageType => SessionMessageType.ScheduledTaskEnded;
+}

+ 25 - 0
MediaBrowser.Controller/Net/WebSocketMessages/Outbound/ScheduledTasksInfoMessage.cs

@@ -0,0 +1,25 @@
+using System.Collections.Generic;
+using System.ComponentModel;
+using MediaBrowser.Model.Session;
+using MediaBrowser.Model.Tasks;
+
+namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
+
+/// <summary>
+/// Scheduled tasks info message.
+/// </summary>
+public class ScheduledTasksInfoMessage : WebSocketMessage<IReadOnlyList<TaskInfo>>, IOutboundWebSocketMessage
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="ScheduledTasksInfoMessage"/> class.
+    /// </summary>
+    /// <param name="data">List of task infos.</param>
+    public ScheduledTasksInfoMessage(IReadOnlyList<TaskInfo> data)
+        : base(data)
+    {
+    }
+
+    /// <inheritdoc />
+    [DefaultValue(SessionMessageType.ScheduledTasksInfo)]
+    public override SessionMessageType MessageType => SessionMessageType.ScheduledTasksInfo;
+}

+ 24 - 0
MediaBrowser.Controller/Net/WebSocketMessages/Outbound/SeriesTimerCancelledMessage.cs

@@ -0,0 +1,24 @@
+using System.ComponentModel;
+using MediaBrowser.Controller.LiveTv;
+using MediaBrowser.Model.Session;
+
+namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
+
+/// <summary>
+/// Series timer cancelled message.
+/// </summary>
+public class SeriesTimerCancelledMessage : WebSocketMessage<TimerEventInfo>, IOutboundWebSocketMessage
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="SeriesTimerCancelledMessage"/> class.
+    /// </summary>
+    /// <param name="data">The timer event info.</param>
+    public SeriesTimerCancelledMessage(TimerEventInfo data)
+        : base(data)
+    {
+    }
+
+    /// <inheritdoc />
+    [DefaultValue(SessionMessageType.SeriesTimerCancelled)]
+    public override SessionMessageType MessageType => SessionMessageType.SeriesTimerCancelled;
+}

+ 24 - 0
MediaBrowser.Controller/Net/WebSocketMessages/Outbound/SeriesTimerCreatedMessage.cs

@@ -0,0 +1,24 @@
+using System.ComponentModel;
+using MediaBrowser.Controller.LiveTv;
+using MediaBrowser.Model.Session;
+
+namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
+
+/// <summary>
+/// Series timer created message.
+/// </summary>
+public class SeriesTimerCreatedMessage : WebSocketMessage<TimerEventInfo>, IOutboundWebSocketMessage
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="SeriesTimerCreatedMessage"/> class.
+    /// </summary>
+    /// <param name="data">timer event info.</param>
+    public SeriesTimerCreatedMessage(TimerEventInfo data)
+        : base(data)
+    {
+    }
+
+    /// <inheritdoc />
+    [DefaultValue(SessionMessageType.SeriesTimerCreated)]
+    public override SessionMessageType MessageType => SessionMessageType.SeriesTimerCreated;
+}

+ 14 - 0
MediaBrowser.Controller/Net/WebSocketMessages/Outbound/ServerRestartingMessage.cs

@@ -0,0 +1,14 @@
+using System.ComponentModel;
+using MediaBrowser.Model.Session;
+
+namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
+
+/// <summary>
+/// Server restarting down message.
+/// </summary>
+public class ServerRestartingMessage : WebSocketMessage, IOutboundWebSocketMessage
+{
+    /// <inheritdoc />
+    [DefaultValue(SessionMessageType.ServerRestarting)]
+    public override SessionMessageType MessageType => SessionMessageType.ServerRestarting;
+}

+ 14 - 0
MediaBrowser.Controller/Net/WebSocketMessages/Outbound/ServerShuttingDownMessage.cs

@@ -0,0 +1,14 @@
+using System.ComponentModel;
+using MediaBrowser.Model.Session;
+
+namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
+
+/// <summary>
+/// Server shutting down message.
+/// </summary>
+public class ServerShuttingDownMessage : WebSocketMessage, IOutboundWebSocketMessage
+{
+    /// <inheritdoc />
+    [DefaultValue(SessionMessageType.ServerShuttingDown)]
+    public override SessionMessageType MessageType => SessionMessageType.ServerShuttingDown;
+}

+ 24 - 0
MediaBrowser.Controller/Net/WebSocketMessages/Outbound/SessionsMessage.cs

@@ -0,0 +1,24 @@
+using System.ComponentModel;
+using MediaBrowser.Controller.Session;
+using MediaBrowser.Model.Session;
+
+namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
+
+/// <summary>
+/// Sessions message.
+/// </summary>
+public class SessionsMessage : WebSocketMessage<SessionInfo>, IOutboundWebSocketMessage
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="SessionsMessage"/> class.
+    /// </summary>
+    /// <param name="data">Session info.</param>
+    public SessionsMessage(SessionInfo data)
+        : base(data)
+    {
+    }
+
+    /// <inheritdoc />
+    [DefaultValue(SessionMessageType.Sessions)]
+    public override SessionMessageType MessageType => SessionMessageType.Sessions;
+}

+ 24 - 0
MediaBrowser.Controller/Net/WebSocketMessages/Outbound/SyncPlayCommandMessage.cs

@@ -0,0 +1,24 @@
+using System.ComponentModel;
+using MediaBrowser.Model.Session;
+using MediaBrowser.Model.SyncPlay;
+
+namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
+
+/// <summary>
+/// Sync play command.
+/// </summary>
+public class SyncPlayCommandMessage : WebSocketMessage<SendCommand>, IOutboundWebSocketMessage
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="SyncPlayCommandMessage"/> class.
+    /// </summary>
+    /// <param name="data">The send command.</param>
+    public SyncPlayCommandMessage(SendCommand data)
+        : base(data)
+    {
+    }
+
+    /// <inheritdoc />
+    [DefaultValue(SessionMessageType.SyncPlayCommand)]
+    public override SessionMessageType MessageType => SessionMessageType.SyncPlayCommand;
+}

+ 24 - 0
MediaBrowser.Controller/Net/WebSocketMessages/Outbound/SyncPlayGroupUpdateCommandMessage.cs

@@ -0,0 +1,24 @@
+using System.ComponentModel;
+using MediaBrowser.Model.Session;
+using MediaBrowser.Model.SyncPlay;
+
+namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
+
+/// <summary>
+/// Untyped sync play command.
+/// </summary>
+public class SyncPlayGroupUpdateCommandMessage : WebSocketMessage<GroupUpdate>, IOutboundWebSocketMessage
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="SyncPlayGroupUpdateCommandMessage"/> class.
+    /// </summary>
+    /// <param name="data">The send command.</param>
+    public SyncPlayGroupUpdateCommandMessage(GroupUpdate data)
+        : base(data)
+    {
+    }
+
+    /// <inheritdoc />
+    [DefaultValue(SessionMessageType.SyncPlayGroupUpdate)]
+    public override SessionMessageType MessageType => SessionMessageType.SyncPlayGroupUpdate;
+}

+ 25 - 0
MediaBrowser.Controller/Net/WebSocketMessages/Outbound/SyncPlayGroupUpdateCommandOfGroupInfoMessage.cs

@@ -0,0 +1,25 @@
+using System.ComponentModel;
+using MediaBrowser.Model.Session;
+using MediaBrowser.Model.SyncPlay;
+
+namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
+
+/// <summary>
+/// Sync play group update command with group info.
+/// GroupUpdateTypes: GroupJoined.
+/// </summary>
+public class SyncPlayGroupUpdateCommandOfGroupInfoMessage : WebSocketMessage<GroupUpdate<GroupInfoDto>>, IOutboundWebSocketMessage
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="SyncPlayGroupUpdateCommandOfGroupInfoMessage"/> class.
+    /// </summary>
+    /// <param name="data">The group info.</param>
+    public SyncPlayGroupUpdateCommandOfGroupInfoMessage(GroupUpdate<GroupInfoDto> data)
+        : base(data)
+    {
+    }
+
+    /// <inheritdoc />
+    [DefaultValue(SessionMessageType.SyncPlayGroupUpdate)]
+    public override SessionMessageType MessageType => SessionMessageType.SyncPlayGroupUpdate;
+}

+ 25 - 0
MediaBrowser.Controller/Net/WebSocketMessages/Outbound/SyncPlayGroupUpdateCommandOfGroupStateUpdateMessage.cs

@@ -0,0 +1,25 @@
+using System.ComponentModel;
+using MediaBrowser.Model.Session;
+using MediaBrowser.Model.SyncPlay;
+
+namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
+
+/// <summary>
+/// Sync play group update command with group state update.
+/// GroupUpdateTypes: StateUpdate.
+/// </summary>
+public class SyncPlayGroupUpdateCommandOfGroupStateUpdateMessage : WebSocketMessage<GroupUpdate<GroupStateUpdate>>, IOutboundWebSocketMessage
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="SyncPlayGroupUpdateCommandOfGroupStateUpdateMessage"/> class.
+    /// </summary>
+    /// <param name="data">The group info.</param>
+    public SyncPlayGroupUpdateCommandOfGroupStateUpdateMessage(GroupUpdate<GroupStateUpdate> data)
+        : base(data)
+    {
+    }
+
+    /// <inheritdoc />
+    [DefaultValue(SessionMessageType.SyncPlayGroupUpdate)]
+    public override SessionMessageType MessageType => SessionMessageType.SyncPlayGroupUpdate;
+}

+ 25 - 0
MediaBrowser.Controller/Net/WebSocketMessages/Outbound/SyncPlayGroupUpdateCommandOfPlayQueueUpdateMessage.cs

@@ -0,0 +1,25 @@
+using System.ComponentModel;
+using MediaBrowser.Model.Session;
+using MediaBrowser.Model.SyncPlay;
+
+namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
+
+/// <summary>
+/// Sync play group update command with play queue update.
+/// GroupUpdateTypes: PlayQueue.
+/// </summary>
+public class SyncPlayGroupUpdateCommandOfPlayQueueUpdateMessage : WebSocketMessage<GroupUpdate<PlayQueueUpdate>>, IOutboundWebSocketMessage
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="SyncPlayGroupUpdateCommandOfPlayQueueUpdateMessage"/> class.
+    /// </summary>
+    /// <param name="data">The play queue update.</param>
+    public SyncPlayGroupUpdateCommandOfPlayQueueUpdateMessage(GroupUpdate<PlayQueueUpdate> data)
+        : base(data)
+    {
+    }
+
+    /// <inheritdoc />
+    [DefaultValue(SessionMessageType.SyncPlayGroupUpdate)]
+    public override SessionMessageType MessageType => SessionMessageType.SyncPlayGroupUpdate;
+}

+ 25 - 0
MediaBrowser.Controller/Net/WebSocketMessages/Outbound/SyncPlayGroupUpdateCommandOfStringMessage.cs

@@ -0,0 +1,25 @@
+using System.ComponentModel;
+using MediaBrowser.Model.Session;
+using MediaBrowser.Model.SyncPlay;
+
+namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
+
+/// <summary>
+/// Sync play group update command with string.
+/// GroupUpdateTypes: GroupDoesNotExist (error), LibraryAccessDenied (error), NotInGroup (error), GroupLeft (groupId), UserJoined (username), UserLeft (username).
+/// </summary>
+public class SyncPlayGroupUpdateCommandOfStringMessage : WebSocketMessage<GroupUpdate<string>>, IOutboundWebSocketMessage
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="SyncPlayGroupUpdateCommandOfStringMessage"/> class.
+    /// </summary>
+    /// <param name="data">The send command.</param>
+    public SyncPlayGroupUpdateCommandOfStringMessage(GroupUpdate<string> data)
+        : base(data)
+    {
+    }
+
+    /// <inheritdoc />
+    [DefaultValue(SessionMessageType.SyncPlayGroupUpdate)]
+    public override SessionMessageType MessageType => SessionMessageType.SyncPlayGroupUpdate;
+}

+ 24 - 0
MediaBrowser.Controller/Net/WebSocketMessages/Outbound/TimerCancelledMessage.cs

@@ -0,0 +1,24 @@
+using System.ComponentModel;
+using MediaBrowser.Controller.LiveTv;
+using MediaBrowser.Model.Session;
+
+namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
+
+/// <summary>
+/// Timer cancelled message.
+/// </summary>
+public class TimerCancelledMessage : WebSocketMessage<TimerEventInfo>, IOutboundWebSocketMessage
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="TimerCancelledMessage"/> class.
+    /// </summary>
+    /// <param name="data">Timer event info.</param>
+    public TimerCancelledMessage(TimerEventInfo data)
+        : base(data)
+    {
+    }
+
+    /// <inheritdoc />
+    [DefaultValue(SessionMessageType.TimerCancelled)]
+    public override SessionMessageType MessageType => SessionMessageType.TimerCancelled;
+}

+ 24 - 0
MediaBrowser.Controller/Net/WebSocketMessages/Outbound/TimerCreatedMessage.cs

@@ -0,0 +1,24 @@
+using System.ComponentModel;
+using MediaBrowser.Controller.LiveTv;
+using MediaBrowser.Model.Session;
+
+namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
+
+/// <summary>
+/// Timer created message.
+/// </summary>
+public class TimerCreatedMessage : WebSocketMessage<TimerEventInfo>, IOutboundWebSocketMessage
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="TimerCreatedMessage"/> class.
+    /// </summary>
+    /// <param name="data">Timer event info.</param>
+    public TimerCreatedMessage(TimerEventInfo data)
+        : base(data)
+    {
+    }
+
+    /// <inheritdoc />
+    [DefaultValue(SessionMessageType.TimerCreated)]
+    public override SessionMessageType MessageType => SessionMessageType.TimerCreated;
+}

+ 23 - 0
MediaBrowser.Controller/Net/WebSocketMessages/Outbound/UserDataChangedMessage.cs

@@ -0,0 +1,23 @@
+using System.ComponentModel;
+using MediaBrowser.Model.Session;
+
+namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
+
+/// <summary>
+/// User data changed message.
+/// </summary>
+public class UserDataChangedMessage : WebSocketMessage<UserDataChangeInfo>, IOutboundWebSocketMessage
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="UserDataChangedMessage"/> class.
+    /// </summary>
+    /// <param name="data">The data change info.</param>
+    public UserDataChangedMessage(UserDataChangeInfo data)
+        : base(data)
+    {
+    }
+
+    /// <inheritdoc />
+    [DefaultValue(SessionMessageType.UserDataChanged)]
+    public override SessionMessageType MessageType => SessionMessageType.UserDataChanged;
+}

+ 24 - 0
MediaBrowser.Controller/Net/WebSocketMessages/Outbound/UserDeletedMessage.cs

@@ -0,0 +1,24 @@
+using System;
+using System.ComponentModel;
+using MediaBrowser.Model.Session;
+
+namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
+
+/// <summary>
+/// User deleted message.
+/// </summary>
+public class UserDeletedMessage : WebSocketMessage<Guid>, IOutboundWebSocketMessage
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="UserDeletedMessage"/> class.
+    /// </summary>
+    /// <param name="data">The user id.</param>
+    public UserDeletedMessage(Guid data)
+        : base(data)
+    {
+    }
+
+    /// <inheritdoc />
+    [DefaultValue(SessionMessageType.UserDeleted)]
+    public override SessionMessageType MessageType => SessionMessageType.UserDeleted;
+}

+ 24 - 0
MediaBrowser.Controller/Net/WebSocketMessages/Outbound/UserUpdatedMessage.cs

@@ -0,0 +1,24 @@
+using System.ComponentModel;
+using MediaBrowser.Model.Dto;
+using MediaBrowser.Model.Session;
+
+namespace MediaBrowser.Controller.Net.WebSocketMessages.Outbound;
+
+/// <summary>
+/// User updated message.
+/// </summary>
+public class UserUpdatedMessage : WebSocketMessage<UserDto>, IOutboundWebSocketMessage
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="UserUpdatedMessage"/> class.
+    /// </summary>
+    /// <param name="data">The user dto.</param>
+    public UserUpdatedMessage(UserDto data)
+        : base(data)
+    {
+    }
+
+    /// <inheritdoc />
+    [DefaultValue(SessionMessageType.UserUpdated)]
+    public override SessionMessageType MessageType => SessionMessageType.UserUpdated;
+}

+ 9 - 0
MediaBrowser.Controller/Net/WebSocketMessages/OutboundWebSocketMessage.cs

@@ -0,0 +1,9 @@
+namespace MediaBrowser.Controller.Net.WebSocketMessages;
+
+/// <summary>
+/// Class representing the list of outbound websocket message types.
+/// Only used in openapi generation.
+/// </summary>
+public class OutboundWebSocketMessage : WebSocketMessage
+{
+}

+ 23 - 0
MediaBrowser.Controller/Net/WebSocketMessages/Shared/KeepAliveMessage.cs

@@ -0,0 +1,23 @@
+using System.ComponentModel;
+using MediaBrowser.Model.Session;
+
+namespace MediaBrowser.Controller.Net.WebSocketMessages.Shared;
+
+/// <summary>
+/// Keep alive websocket messages.
+/// </summary>
+public class KeepAliveMessage : WebSocketMessage<int>, IInboundWebSocketMessage, IOutboundWebSocketMessage
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="KeepAliveMessage"/> class.
+    /// </summary>
+    /// <param name="data">The seconds to keep alive for.</param>
+    public KeepAliveMessage(int data)
+        : base(data)
+    {
+    }
+
+    /// <inheritdoc />
+    [DefaultValue(SessionMessageType.KeepAlive)]
+    public override SessionMessageType MessageType => SessionMessageType.KeepAlive;
+}

+ 12 - 12
MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs

@@ -23,13 +23,13 @@ namespace MediaBrowser.Controller.SyncPlay.Queue
         /// The sorted playlist.
         /// </summary>
         /// <value>The sorted playlist, or play queue of the group.</value>
-        private List<QueueItem> _sortedPlaylist = new List<QueueItem>();
+        private List<SyncPlayQueueItem> _sortedPlaylist = new List<SyncPlayQueueItem>();
 
         /// <summary>
         /// The shuffled playlist.
         /// </summary>
         /// <value>The shuffled playlist, or play queue of the group.</value>
-        private List<QueueItem> _shuffledPlaylist = new List<QueueItem>();
+        private List<SyncPlayQueueItem> _shuffledPlaylist = new List<SyncPlayQueueItem>();
 
         /// <summary>
         /// Initializes a new instance of the <see cref="PlayQueueManager" /> class.
@@ -76,7 +76,7 @@ namespace MediaBrowser.Controller.SyncPlay.Queue
         /// Gets the current playlist considering the shuffle mode.
         /// </summary>
         /// <returns>The playlist.</returns>
-        public IReadOnlyList<QueueItem> GetPlaylist()
+        public IReadOnlyList<SyncPlayQueueItem> GetPlaylist()
         {
             return GetPlaylistInternal();
         }
@@ -93,7 +93,7 @@ namespace MediaBrowser.Controller.SyncPlay.Queue
             _sortedPlaylist = CreateQueueItemsFromArray(items);
             if (ShuffleMode.Equals(GroupShuffleMode.Shuffle))
             {
-                _shuffledPlaylist = new List<QueueItem>(_sortedPlaylist);
+                _shuffledPlaylist = new List<SyncPlayQueueItem>(_sortedPlaylist);
                 _shuffledPlaylist.Shuffle();
             }
 
@@ -125,14 +125,14 @@ namespace MediaBrowser.Controller.SyncPlay.Queue
         {
             if (PlayingItemIndex == NoPlayingItemIndex)
             {
-                _shuffledPlaylist = new List<QueueItem>(_sortedPlaylist);
+                _shuffledPlaylist = new List<SyncPlayQueueItem>(_sortedPlaylist);
                 _shuffledPlaylist.Shuffle();
             }
             else if (ShuffleMode.Equals(GroupShuffleMode.Sorted))
             {
                 // First time shuffle.
                 var playingItem = _sortedPlaylist[PlayingItemIndex];
-                _shuffledPlaylist = new List<QueueItem>(_sortedPlaylist);
+                _shuffledPlaylist = new List<SyncPlayQueueItem>(_sortedPlaylist);
                 _shuffledPlaylist.RemoveAt(PlayingItemIndex);
                 _shuffledPlaylist.Shuffle();
                 _shuffledPlaylist.Insert(0, playingItem);
@@ -407,7 +407,7 @@ namespace MediaBrowser.Controller.SyncPlay.Queue
         /// Gets the next item in the playlist considering repeat mode and shuffle mode.
         /// </summary>
         /// <returns>The next item in the playlist.</returns>
-        public QueueItem GetNextItemPlaylistId()
+        public SyncPlayQueueItem GetNextItemPlaylistId()
         {
             int newIndex;
             var playlist = GetPlaylistInternal();
@@ -502,12 +502,12 @@ namespace MediaBrowser.Controller.SyncPlay.Queue
         /// Creates a list from the array of items. Each item is given an unique playlist identifier.
         /// </summary>
         /// <returns>The list of queue items.</returns>
-        private List<QueueItem> CreateQueueItemsFromArray(IReadOnlyList<Guid> items)
+        private List<SyncPlayQueueItem> CreateQueueItemsFromArray(IReadOnlyList<Guid> items)
         {
-            var list = new List<QueueItem>();
+            var list = new List<SyncPlayQueueItem>();
             foreach (var item in items)
             {
-                var queueItem = new QueueItem(item);
+                var queueItem = new SyncPlayQueueItem(item);
                 list.Add(queueItem);
             }
 
@@ -518,7 +518,7 @@ namespace MediaBrowser.Controller.SyncPlay.Queue
         /// Gets the current playlist considering the shuffle mode.
         /// </summary>
         /// <returns>The playlist.</returns>
-        private List<QueueItem> GetPlaylistInternal()
+        private List<SyncPlayQueueItem> GetPlaylistInternal()
         {
             if (ShuffleMode.Equals(GroupShuffleMode.Shuffle))
             {
@@ -532,7 +532,7 @@ namespace MediaBrowser.Controller.SyncPlay.Queue
         /// Gets the current playing item, depending on the shuffle mode.
         /// </summary>
         /// <returns>The playing item.</returns>
-        private QueueItem GetPlayingItem()
+        private SyncPlayQueueItem GetPlayingItem()
         {
             if (PlayingItemIndex == NoPlayingItemIndex)
             {

+ 0 - 31
MediaBrowser.Model/Net/WebSocketMessage.cs

@@ -1,31 +0,0 @@
-#nullable disable
-#pragma warning disable CS1591
-
-using System;
-using MediaBrowser.Model.Session;
-
-namespace MediaBrowser.Model.Net
-{
-    /// <summary>
-    /// Class WebSocketMessage.
-    /// </summary>
-    /// <typeparam name="T">The type of the data.</typeparam>
-    public class WebSocketMessage<T>
-    {
-        /// <summary>
-        /// Gets or sets the type of the message.
-        /// </summary>
-        /// <value>The type of the message.</value>
-        public SessionMessageType MessageType { get; set; }
-
-        public Guid MessageId { get; set; }
-
-        public string ServerId { get; set; }
-
-        /// <summary>
-        /// Gets or sets the data.
-        /// </summary>
-        /// <value>The data.</value>
-        public T Data { get; set; }
-    }
-}

+ 21 - 33
MediaBrowser.Model/SyncPlay/GroupUpdate.cs

@@ -1,42 +1,30 @@
 using System;
 
-namespace MediaBrowser.Model.SyncPlay
+namespace MediaBrowser.Model.SyncPlay;
+
+/// <summary>
+/// Group update without data.
+/// </summary>
+public abstract class GroupUpdate
 {
     /// <summary>
-    /// Class GroupUpdate.
+    /// Initializes a new instance of the <see cref="GroupUpdate"/> class.
     /// </summary>
-    /// <typeparam name="T">The type of the data of the message.</typeparam>
-    public class GroupUpdate<T>
+    /// <param name="groupId">The group identifier.</param>
+    protected GroupUpdate(Guid groupId)
     {
-        /// <summary>
-        /// Initializes a new instance of the <see cref="GroupUpdate{T}"/> class.
-        /// </summary>
-        /// <param name="groupId">The group identifier.</param>
-        /// <param name="type">The update type.</param>
-        /// <param name="data">The update data.</param>
-        public GroupUpdate(Guid groupId, GroupUpdateType type, T data)
-        {
-            GroupId = groupId;
-            Type = type;
-            Data = data;
-        }
-
-        /// <summary>
-        /// Gets the group identifier.
-        /// </summary>
-        /// <value>The group identifier.</value>
-        public Guid GroupId { get; }
+        GroupId = groupId;
+    }
 
-        /// <summary>
-        /// Gets the update type.
-        /// </summary>
-        /// <value>The update type.</value>
-        public GroupUpdateType Type { get; }
+    /// <summary>
+    /// Gets the group identifier.
+    /// </summary>
+    /// <value>The group identifier.</value>
+    public Guid GroupId { get; }
 
-        /// <summary>
-        /// Gets the update data.
-        /// </summary>
-        /// <value>The update data.</value>
-        public T Data { get; }
-    }
+    /// <summary>
+    /// Gets the update type.
+    /// </summary>
+    /// <value>The update type.</value>
+    public GroupUpdateType Type { get; init; }
 }

+ 31 - 0
MediaBrowser.Model/SyncPlay/GroupUpdateOfT.cs

@@ -0,0 +1,31 @@
+#pragma warning disable SA1649
+
+using System;
+
+namespace MediaBrowser.Model.SyncPlay;
+
+/// <summary>
+/// Class GroupUpdate.
+/// </summary>
+/// <typeparam name="T">The type of the data of the message.</typeparam>
+public class GroupUpdate<T> : GroupUpdate
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="GroupUpdate{T}"/> class.
+    /// </summary>
+    /// <param name="groupId">The group identifier.</param>
+    /// <param name="type">The update type.</param>
+    /// <param name="data">The update data.</param>
+    public GroupUpdate(Guid groupId, GroupUpdateType type, T data)
+        : base(groupId)
+    {
+        Data = data;
+        Type = type;
+    }
+
+    /// <summary>
+    /// Gets the update data.
+    /// </summary>
+    /// <value>The update data.</value>
+    public T Data { get; }
+}

+ 2 - 2
MediaBrowser.Model/SyncPlay/PlayQueueUpdate.cs

@@ -19,7 +19,7 @@ namespace MediaBrowser.Model.SyncPlay
         /// <param name="isPlaying">The playing item status.</param>
         /// <param name="shuffleMode">The shuffle mode.</param>
         /// <param name="repeatMode">The repeat mode.</param>
-        public PlayQueueUpdate(PlayQueueUpdateReason reason, DateTime lastUpdate, IReadOnlyList<QueueItem> playlist, int playingItemIndex, long startPositionTicks, bool isPlaying, GroupShuffleMode shuffleMode, GroupRepeatMode repeatMode)
+        public PlayQueueUpdate(PlayQueueUpdateReason reason, DateTime lastUpdate, IReadOnlyList<SyncPlayQueueItem> playlist, int playingItemIndex, long startPositionTicks, bool isPlaying, GroupShuffleMode shuffleMode, GroupRepeatMode repeatMode)
         {
             Reason = reason;
             LastUpdate = lastUpdate;
@@ -47,7 +47,7 @@ namespace MediaBrowser.Model.SyncPlay
         /// Gets the playlist.
         /// </summary>
         /// <value>The playlist.</value>
-        public IReadOnlyList<QueueItem> Playlist { get; }
+        public IReadOnlyList<SyncPlayQueueItem> Playlist { get; }
 
         /// <summary>
         /// Gets the playing item index in the playlist.

+ 3 - 3
MediaBrowser.Model/SyncPlay/QueueItem.cs → MediaBrowser.Model/SyncPlay/SyncPlayQueueItem.cs

@@ -5,13 +5,13 @@ namespace MediaBrowser.Model.SyncPlay
     /// <summary>
     /// Class QueueItem.
     /// </summary>
-    public class QueueItem
+    public class SyncPlayQueueItem
     {
         /// <summary>
-        /// Initializes a new instance of the <see cref="QueueItem"/> class.
+        /// Initializes a new instance of the <see cref="SyncPlayQueueItem"/> class.
         /// </summary>
         /// <param name="itemId">The item identifier.</param>
-        public QueueItem(Guid itemId)
+        public SyncPlayQueueItem(Guid itemId)
         {
             ItemId = itemId;
         }