aboutsummaryrefslogtreecommitdiff
path: root/MediaBrowser.Model/DTO/DTOBaseItem.cs
blob: c729db74b50a1ed7e97f463d750b21ad589cf43b (plain)
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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
using System;
using System.Collections.Generic;
using MediaBrowser.Model.Entities;
using ProtoBuf;

namespace MediaBrowser.Model.DTO
{
    /// <summary>
    /// This is strictly used as a data transfer object from the api layer.
    /// This holds information about a BaseItem in a format that is convenient for the client.
    /// </summary>
    [ProtoContract]
    public class DTOBaseItem : IHasProviderIds
    {
        [ProtoMember(1)]
        public string Name { get; set; }

        [ProtoMember(2)]
        public Guid Id { get; set; }

        [ProtoMember(3)]
        public DateTime DateCreated { get; set; }

        [ProtoMember(4)]
        public string SortName { get; set; }

        [ProtoMember(5)]
        public DateTime? PremiereDate { get; set; }

        [ProtoMember(6)]
        public string Path { get; set; }

        [ProtoMember(7)]
        public string OfficialRating { get; set; }

        [ProtoMember(8)]
        public string Overview { get; set; }

        [ProtoMember(9)]
        public string[] Taglines { get; set; }

        [ProtoMember(10)]
        public string[] Genres { get; set; }

        [ProtoMember(11)]
        public string DisplayMediaType { get; set; }

        [ProtoMember(12)]
        public float? UserRating { get; set; }

        [ProtoMember(13)]
        public long? RunTimeTicks { get; set; }

        [ProtoMember(14)]
        public string AspectRatio { get; set; }

        [ProtoMember(15)]
        public int? ProductionYear { get; set; }

        [ProtoMember(16)]
        public int? IndexNumber { get; set; }

        [ProtoMember(17)]
        public int? ParentIndexNumber { get; set; }

        [ProtoMember(18)]
        public string TrailerUrl { get; set; }

        [ProtoMember(19)]
        public Dictionary<string, string> ProviderIds { get; set; }

        [ProtoMember(20)]
        public bool HasBanner { get; set; }

        [ProtoMember(21)]
        public bool HasArt { get; set; }

        [ProtoMember(22)]
        public bool HasLogo { get; set; }

        [ProtoMember(23)]
        public bool HasThumb { get; set; }

        [ProtoMember(24)]
        public bool HasPrimaryImage { get; set; }

        [ProtoMember(25)]
        public string Language { get; set; }

        [ProtoMember(26)]
        public int BackdropCount { get; set; }

        [ProtoMember(27)]
        public DTOBaseItem[] Children { get; set; }

        [ProtoMember(28)]
        public bool IsFolder { get; set; }

        /// <summary>
        /// If the item is a Folder this will determine if it's the Root or not
        /// </summary>
        [ProtoMember(29)]
        public bool? IsRoot { get; set; }

        /// <summary>
        /// If the item is a Folder this will determine if it's a VF or not
        /// </summary>
        [ProtoMember(30)]
        public bool? IsVirtualFolder { get; set; }

        [ProtoMember(31)]
        public Guid? ParentId { get; set; }

        [ProtoMember(32)]
        public string Type { get; set; }

        [ProtoMember(33)]
        public BaseItemPerson[] People { get; set; }

        [ProtoMember(34)]
        public BaseItemStudio[] Studios { get; set; }

        /// <summary>
        /// If the item does not have a logo, this will hold the Id of the Parent that has one.
        /// </summary>
        [ProtoMember(35)]
        public Guid? ParentLogoItemId { get; set; }

        /// <summary>
        /// If the item does not have any backdrops, this will hold the Id of the Parent that has one.
        /// </summary>
        [ProtoMember(36)]
        public Guid? ParentBackdropItemId { get; set; }

        [ProtoMember(37)]
        public int? ParentBackdropCount { get; set; }

        [ProtoMember(38)]
        public DTOBaseItem[] LocalTrailers { get; set; }

        [ProtoMember(39)]
        public int LocalTrailerCount { get; set; }

        /// <summary>
        /// User data for this item based on the user it's being requested for
        /// </summary>
        [ProtoMember(40)]
        public UserItemData UserData { get; set; }

        [ProtoMember(41)]
        public ItemSpecialCounts SpecialCounts { get; set; }

        [ProtoMember(42)]
        public AudioInfo AudioInfo { get; set; }

        [ProtoMember(43)]
        public VideoInfo VideoInfo { get; set; }
      
        public bool IsType(Type type)
        {
            return IsType(type.Name);
        }

        public bool IsType(string type)
        {
            return Type.Equals(type, StringComparison.OrdinalIgnoreCase);
        }

        [ProtoMember(44)]
        public bool IsNew { get; set; }
    }
}