MediaBrowser.Controller/Library/SimilarItemsRecommendation.cs


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

using System;
using System.Collections.Generic;
using MediaBrowser.Controller.Entities;
using MediaBrowser.Model.Dto;

namespace MediaBrowser.Controller.Library;

/// <summary>
/// A recommendation category derived from a baseline item, holding similar items prior to DTO conversion.
/// </summary>
public sealed class SimilarItemsRecommendation
{
    /// <summary>
    /// Gets the display name of the baseline item the recommendation is based on.
    /// </summary>
    public required string BaselineItemName { get; init; }

    /// <summary>
    /// Gets an identifier for the recommendation category.
    /// </summary>
    public required Guid CategoryId { get; init; }

    /// <summary>
    /// Gets the recommendation type.
    /// </summary>
    public required RecommendationType RecommendationType { get; init; }

    /// <summary>
    /// Gets the similar items for the baseline, ordered by relevance.
    /// </summary>
    public required IReadOnlyList<BaseItem> Items { get; init; }
}