diff options
| author | Cody Robibero <cody@robibe.ro> | 2024-07-23 11:34:41 -0600 |
|---|---|---|
| committer | Cody Robibero <cody@robibe.ro> | 2024-07-23 11:34:41 -0600 |
| commit | 6fd79fb01597b5132ca5b3bd9c06c92d527ee0cc (patch) | |
| tree | 34c8b08c7d302caa867c175f0b83df5ab46b2cd5 /Jellyfin.Api/Models | |
| parent | 59446a8dd297dd2f7d6646aabf475a63a4f906b6 (diff) | |
Fix up getting livetv programs api docs
Diffstat (limited to 'Jellyfin.Api/Models')
| -rw-r--r-- | Jellyfin.Api/Models/LiveTvDtos/GetProgramsDto.cs | 39 |
1 files changed, 9 insertions, 30 deletions
diff --git a/Jellyfin.Api/Models/LiveTvDtos/GetProgramsDto.cs b/Jellyfin.Api/Models/LiveTvDtos/GetProgramsDto.cs index 8482b1cf1..633729c11 100644 --- a/Jellyfin.Api/Models/LiveTvDtos/GetProgramsDto.cs +++ b/Jellyfin.Api/Models/LiveTvDtos/GetProgramsDto.cs @@ -17,7 +17,7 @@ public class GetProgramsDto /// Gets or sets the channels to return guide information for. /// </summary> [JsonConverter(typeof(JsonCommaDelimitedArrayConverterFactory))] - public IReadOnlyList<Guid> ChannelIds { get; set; } = Array.Empty<Guid>(); + public IReadOnlyList<Guid>? ChannelIds { get; set; } /// <summary> /// Gets or sets optional. Filter by user id. @@ -26,110 +26,95 @@ public class GetProgramsDto /// <summary> /// Gets or sets the minimum premiere start date. - /// Optional. /// </summary> public DateTime? MinStartDate { get; set; } /// <summary> /// Gets or sets filter by programs that have completed airing, or not. - /// Optional. /// </summary> public bool? HasAired { get; set; } /// <summary> /// Gets or sets filter by programs that are currently airing, or not. - /// Optional. /// </summary> public bool? IsAiring { get; set; } /// <summary> /// Gets or sets the maximum premiere start date. - /// Optional. /// </summary> public DateTime? MaxStartDate { get; set; } /// <summary> /// Gets or sets the minimum premiere end date. - /// Optional. /// </summary> public DateTime? MinEndDate { get; set; } /// <summary> /// Gets or sets the maximum premiere end date. - /// Optional. /// </summary> public DateTime? MaxEndDate { get; set; } /// <summary> /// Gets or sets filter for movies. - /// Optional. /// </summary> public bool? IsMovie { get; set; } /// <summary> /// Gets or sets filter for series. - /// Optional. /// </summary> public bool? IsSeries { get; set; } /// <summary> /// Gets or sets filter for news. - /// Optional. /// </summary> public bool? IsNews { get; set; } /// <summary> /// Gets or sets filter for kids. - /// Optional. /// </summary> public bool? IsKids { get; set; } /// <summary> /// Gets or sets filter for sports. - /// Optional. /// </summary> public bool? IsSports { get; set; } /// <summary> /// Gets or sets the record index to start at. All items with a lower index will be dropped from the results. - /// Optional. /// </summary> public int? StartIndex { get; set; } /// <summary> /// Gets or sets the maximum number of records to return. - /// Optional. /// </summary> public int? Limit { get; set; } /// <summary> /// Gets or sets specify one or more sort orders, comma delimited. Options: Name, StartDate. - /// Optional. /// </summary> [JsonConverter(typeof(JsonCommaDelimitedArrayConverterFactory))] - public IReadOnlyList<ItemSortBy> SortBy { get; set; } = Array.Empty<ItemSortBy>(); + public IReadOnlyList<ItemSortBy>? SortBy { get; set; } /// <summary> - /// Gets or sets sort Order - Ascending,Descending. + /// Gets or sets sort order. /// </summary> [JsonConverter(typeof(JsonCommaDelimitedArrayConverterFactory))] - public IReadOnlyList<SortOrder> SortOrder { get; set; } = Array.Empty<SortOrder>(); + public IReadOnlyList<SortOrder>? SortOrder { get; set; } /// <summary> /// Gets or sets the genres to return guide information for. /// </summary> [JsonConverter(typeof(JsonPipeDelimitedArrayConverterFactory))] - public IReadOnlyList<string> Genres { get; set; } = Array.Empty<string>(); + public IReadOnlyList<string>? Genres { get; set; } /// <summary> /// Gets or sets the genre ids to return guide information for. /// </summary> [JsonConverter(typeof(JsonCommaDelimitedArrayConverterFactory))] - public IReadOnlyList<Guid> GenreIds { get; set; } = Array.Empty<Guid>(); + public IReadOnlyList<Guid>? GenreIds { get; set; } /// <summary> /// Gets or sets include image information in output. - /// Optional. /// </summary> public bool? EnableImages { get; set; } @@ -140,39 +125,33 @@ public class GetProgramsDto /// <summary> /// Gets or sets the max number of images to return, per image type. - /// Optional. /// </summary> public int? ImageTypeLimit { get; set; } /// <summary> /// Gets or sets the image types to include in the output. - /// Optional. /// </summary> [JsonConverter(typeof(JsonCommaDelimitedArrayConverterFactory))] - public IReadOnlyList<ImageType> EnableImageTypes { get; set; } = Array.Empty<ImageType>(); + public IReadOnlyList<ImageType>? EnableImageTypes { get; set; } /// <summary> /// Gets or sets include user data. - /// Optional. /// </summary> public bool? EnableUserData { get; set; } /// <summary> /// Gets or sets filter by series timer id. - /// Optional. /// </summary> public string? SeriesTimerId { get; set; } /// <summary> /// Gets or sets filter by library series id. - /// Optional. /// </summary> public Guid LibrarySeriesId { get; set; } /// <summary> - /// Gets or sets specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines. - /// Optional. + /// Gets or sets specify additional fields of information to return in the output. /// </summary> [JsonConverter(typeof(JsonCommaDelimitedArrayConverterFactory))] - public IReadOnlyList<ItemFields> Fields { get; set; } = Array.Empty<ItemFields>(); + public IReadOnlyList<ItemFields>? Fields { get; set; } } |
