2
0

IUserDataManager.cs 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. using System;
  2. using System.Collections.Generic;
  3. using System.Threading;
  4. using MediaBrowser.Controller.Dto;
  5. using MediaBrowser.Controller.Entities;
  6. using MediaBrowser.Model.Dto;
  7. using MediaBrowser.Model.Entities;
  8. namespace MediaBrowser.Controller.Library
  9. {
  10. /// <summary>
  11. /// Interface IUserDataManager
  12. /// </summary>
  13. public interface IUserDataManager
  14. {
  15. /// <summary>
  16. /// Occurs when [user data saved].
  17. /// </summary>
  18. event EventHandler<UserDataSaveEventArgs> UserDataSaved;
  19. /// <summary>
  20. /// Saves the user data.
  21. /// </summary>
  22. /// <param name="userId">The user id.</param>
  23. /// <param name="item">The item.</param>
  24. /// <param name="userData">The user data.</param>
  25. /// <param name="reason">The reason.</param>
  26. /// <param name="cancellationToken">The cancellation token.</param>
  27. /// <returns>Task.</returns>
  28. void SaveUserData(Guid userId, BaseItem item, UserItemData userData, UserDataSaveReason reason, CancellationToken cancellationToken);
  29. void SaveUserData(User userId, BaseItem item, UserItemData userData, UserDataSaveReason reason, CancellationToken cancellationToken);
  30. UserItemData GetUserData(User user, BaseItem item);
  31. UserItemData GetUserData(string userId, BaseItem item);
  32. UserItemData GetUserData(Guid userId, BaseItem item);
  33. /// <summary>
  34. /// Gets the user data dto.
  35. /// </summary>
  36. UserItemDataDto GetUserDataDto(BaseItem item, User user);
  37. UserItemDataDto GetUserDataDto(BaseItem item, BaseItemDto itemDto, User user, DtoOptions dto_options);
  38. /// <summary>
  39. /// Get all user data for the given user
  40. /// </summary>
  41. /// <param name="userId"></param>
  42. /// <returns></returns>
  43. List<UserItemData> GetAllUserData(Guid userId);
  44. /// <summary>
  45. /// Save the all provided user data for the given user
  46. /// </summary>
  47. /// <param name="userId"></param>
  48. /// <param name="userData"></param>
  49. /// <param name="cancellationToken"></param>
  50. /// <returns></returns>
  51. void SaveAllUserData(Guid userId, UserItemData[] userData, CancellationToken cancellationToken);
  52. /// <summary>
  53. /// Updates playstate for an item and returns true or false indicating if it was played to completion
  54. /// </summary>
  55. bool UpdatePlayState(BaseItem item, UserItemData data, long? positionTicks);
  56. }
  57. }