2021-05-06 18:39:20 -04:00
|
|
|
#nullable disable
|
|
|
|
|
2020-08-22 15:56:24 -04:00
|
|
|
#pragma warning disable CS1591
|
|
|
|
|
2019-01-13 15:01:16 -05:00
|
|
|
using System;
|
2018-12-27 18:27:57 -05:00
|
|
|
using System.Collections.Generic;
|
|
|
|
using System.Threading;
|
2019-01-13 14:25:32 -05:00
|
|
|
using MediaBrowser.Controller.Entities;
|
2018-12-27 18:27:57 -05:00
|
|
|
using MediaBrowser.Model.Dto;
|
2019-01-13 14:25:32 -05:00
|
|
|
using MediaBrowser.Model.Entities;
|
2018-12-27 18:27:57 -05:00
|
|
|
using MediaBrowser.Model.Querying;
|
|
|
|
|
|
|
|
namespace MediaBrowser.Controller.Persistence
|
|
|
|
{
|
|
|
|
/// <summary>
|
2020-06-15 18:37:52 -04:00
|
|
|
/// Provides an interface to implement an Item repository.
|
2018-12-27 18:27:57 -05:00
|
|
|
/// </summary>
|
2022-02-15 16:27:38 -05:00
|
|
|
public interface IItemRepository : IDisposable
|
2018-12-27 18:27:57 -05:00
|
|
|
{
|
|
|
|
/// <summary>
|
|
|
|
/// Deletes the item.
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="id">The identifier.</param>
|
2020-04-03 14:59:38 -04:00
|
|
|
void DeleteItem(Guid id);
|
2018-12-27 18:27:57 -05:00
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Saves the items.
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="items">The items.</param>
|
|
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
2019-02-08 18:57:58 -05:00
|
|
|
void SaveItems(IEnumerable<BaseItem> items, CancellationToken cancellationToken);
|
2018-12-27 18:27:57 -05:00
|
|
|
|
|
|
|
void SaveImages(BaseItem item);
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Retrieves the item.
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="id">The id.</param>
|
|
|
|
/// <returns>BaseItem.</returns>
|
|
|
|
BaseItem RetrieveItem(Guid id);
|
|
|
|
|
|
|
|
/// <summary>
|
2020-06-15 18:37:52 -04:00
|
|
|
/// Gets chapters for an item.
|
2018-12-27 18:27:57 -05:00
|
|
|
/// </summary>
|
2021-09-03 12:46:34 -04:00
|
|
|
/// <param name="item">The item.</param>
|
2021-06-06 11:16:41 -04:00
|
|
|
/// <returns>The list of chapter info.</returns>
|
2021-09-03 12:46:34 -04:00
|
|
|
List<ChapterInfo> GetChapters(BaseItem item);
|
2018-12-27 18:27:57 -05:00
|
|
|
|
|
|
|
/// <summary>
|
2020-06-15 18:37:52 -04:00
|
|
|
/// Gets a single chapter for an item.
|
2018-12-27 18:27:57 -05:00
|
|
|
/// </summary>
|
2021-09-03 12:46:34 -04:00
|
|
|
/// <param name="item">The item.</param>
|
2021-06-06 11:16:41 -04:00
|
|
|
/// <param name="index">The chapter index.</param>
|
|
|
|
/// <returns>The chapter info at the specified index.</returns>
|
2021-09-03 12:46:34 -04:00
|
|
|
ChapterInfo GetChapter(BaseItem item, int index);
|
2018-12-27 18:27:57 -05:00
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Saves the chapters.
|
|
|
|
/// </summary>
|
2021-06-06 11:16:41 -04:00
|
|
|
/// <param name="id">The item id.</param>
|
|
|
|
/// <param name="chapters">The list of chapters to save.</param>
|
2020-02-23 04:53:51 -05:00
|
|
|
void SaveChapters(Guid id, IReadOnlyList<ChapterInfo> chapters);
|
2018-12-27 18:27:57 -05:00
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Gets the media streams.
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="query">The query.</param>
|
|
|
|
/// <returns>IEnumerable{MediaStream}.</returns>
|
|
|
|
List<MediaStream> GetMediaStreams(MediaStreamQuery query);
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Saves the media streams.
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="id">The identifier.</param>
|
|
|
|
/// <param name="streams">The streams.</param>
|
|
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
2022-01-22 09:40:05 -05:00
|
|
|
void SaveMediaStreams(Guid id, IReadOnlyList<MediaStream> streams, CancellationToken cancellationToken);
|
2018-12-27 18:27:57 -05:00
|
|
|
|
2019-10-04 13:23:08 -04:00
|
|
|
/// <summary>
|
|
|
|
/// Gets the media attachments.
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="query">The query.</param>
|
|
|
|
/// <returns>IEnumerable{MediaAttachment}.</returns>
|
|
|
|
List<MediaAttachment> GetMediaAttachments(MediaAttachmentQuery query);
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Saves the media attachments.
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="id">The identifier.</param>
|
|
|
|
/// <param name="attachments">The attachments.</param>
|
|
|
|
/// <param name="cancellationToken">The cancellation token.</param>
|
2019-12-26 17:20:31 -05:00
|
|
|
void SaveMediaAttachments(Guid id, IReadOnlyList<MediaAttachment> attachments, CancellationToken cancellationToken);
|
2019-10-04 13:23:08 -04:00
|
|
|
|
2018-12-27 18:27:57 -05:00
|
|
|
/// <summary>
|
|
|
|
/// Gets the items.
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="query">The query.</param>
|
|
|
|
/// <returns>QueryResult<BaseItem>.</returns>
|
|
|
|
QueryResult<BaseItem> GetItems(InternalItemsQuery query);
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Gets the item ids list.
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="query">The query.</param>
|
|
|
|
/// <returns>List<Guid>.</returns>
|
|
|
|
List<Guid> GetItemIdsList(InternalItemsQuery query);
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Gets the people.
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="query">The query.</param>
|
|
|
|
/// <returns>List<PersonInfo>.</returns>
|
|
|
|
List<PersonInfo> GetPeople(InternalPeopleQuery query);
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Updates the people.
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="itemId">The item identifier.</param>
|
|
|
|
/// <param name="people">The people.</param>
|
|
|
|
void UpdatePeople(Guid itemId, List<PersonInfo> people);
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Gets the people names.
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="query">The query.</param>
|
|
|
|
/// <returns>List<System.String>.</returns>
|
|
|
|
List<string> GetPeopleNames(InternalPeopleQuery query);
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Gets the item list.
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="query">The query.</param>
|
|
|
|
/// <returns>List<BaseItem>.</returns>
|
|
|
|
List<BaseItem> GetItemList(InternalItemsQuery query);
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Updates the inherited values.
|
|
|
|
/// </summary>
|
2021-04-22 09:28:24 -04:00
|
|
|
void UpdateInheritedValues();
|
2018-12-27 18:27:57 -05:00
|
|
|
|
|
|
|
int GetCount(InternalItemsQuery query);
|
|
|
|
|
2021-12-24 16:18:24 -05:00
|
|
|
QueryResult<(BaseItem Item, ItemCounts ItemCounts)> GetGenres(InternalItemsQuery query);
|
2020-08-22 15:56:24 -04:00
|
|
|
|
2021-12-24 16:18:24 -05:00
|
|
|
QueryResult<(BaseItem Item, ItemCounts ItemCounts)> GetMusicGenres(InternalItemsQuery query);
|
2020-08-22 15:56:24 -04:00
|
|
|
|
2021-12-24 16:18:24 -05:00
|
|
|
QueryResult<(BaseItem Item, ItemCounts ItemCounts)> GetStudios(InternalItemsQuery query);
|
2020-08-22 15:56:24 -04:00
|
|
|
|
2021-12-24 16:18:24 -05:00
|
|
|
QueryResult<(BaseItem Item, ItemCounts ItemCounts)> GetArtists(InternalItemsQuery query);
|
2020-08-22 15:56:24 -04:00
|
|
|
|
2021-12-24 16:18:24 -05:00
|
|
|
QueryResult<(BaseItem Item, ItemCounts ItemCounts)> GetAlbumArtists(InternalItemsQuery query);
|
2020-08-22 15:56:24 -04:00
|
|
|
|
2021-12-24 16:18:24 -05:00
|
|
|
QueryResult<(BaseItem Item, ItemCounts ItemCounts)> GetAllArtists(InternalItemsQuery query);
|
2018-12-27 18:27:57 -05:00
|
|
|
|
|
|
|
List<string> GetMusicGenreNames();
|
2020-08-22 15:56:24 -04:00
|
|
|
|
2018-12-27 18:27:57 -05:00
|
|
|
List<string> GetStudioNames();
|
2020-08-22 15:56:24 -04:00
|
|
|
|
2018-12-27 18:27:57 -05:00
|
|
|
List<string> GetGenreNames();
|
2020-08-22 15:56:24 -04:00
|
|
|
|
2018-12-27 18:27:57 -05:00
|
|
|
List<string> GetAllArtistNames();
|
|
|
|
}
|
|
|
|
}
|