diff options
| author | cvium <clausvium@gmail.com> | 2021-09-03 21:25:18 +0200 |
|---|---|---|
| committer | cvium <clausvium@gmail.com> | 2021-09-03 21:25:18 +0200 |
| commit | 048c478b0d9fbad3c7e6ef7fcbf8e6c2b91fc013 (patch) | |
| tree | e30a5eba97deff4b82a89099d802e06a67ae329c /MediaBrowser.Controller/Library/IUserDataManager.cs | |
| parent | 02a56d8cf73e6745f651fe230520182f0398fae3 (diff) | |
| parent | e83d7a866750405f790cc261d1894dc51c088bf4 (diff) | |
Merge branch 'master' into bug/authorization-header-issue
Diffstat (limited to 'MediaBrowser.Controller/Library/IUserDataManager.cs')
| -rw-r--r-- | MediaBrowser.Controller/Library/IUserDataManager.cs | 20 |
1 files changed, 13 insertions, 7 deletions
diff --git a/MediaBrowser.Controller/Library/IUserDataManager.cs b/MediaBrowser.Controller/Library/IUserDataManager.cs index 58499e853..cf35b48db 100644 --- a/MediaBrowser.Controller/Library/IUserDataManager.cs +++ b/MediaBrowser.Controller/Library/IUserDataManager.cs @@ -1,6 +1,6 @@ #nullable disable -#pragma warning disable CS1591 +#pragma warning disable CA1002, CA1707, CS1591 using System; using System.Collections.Generic; @@ -42,6 +42,9 @@ namespace MediaBrowser.Controller.Library /// <summary> /// Gets the user data dto. /// </summary> + /// <param name="item">Item to use.</param> + /// <param name="user">User to use.</param> + /// <returns>User data dto.</returns> UserItemDataDto GetUserDataDto(BaseItem item, User user); UserItemDataDto GetUserDataDto(BaseItem item, BaseItemDto itemDto, User user, DtoOptions dto_options); @@ -49,22 +52,25 @@ namespace MediaBrowser.Controller.Library /// <summary> /// Get all user data for the given user. /// </summary> - /// <param name="userId"></param> - /// <returns></returns> + /// <param name="userId">The user id.</param> + /// <returns>The user item data.</returns> List<UserItemData> GetAllUserData(Guid userId); /// <summary> /// Save the all provided user data for the given user. /// </summary> - /// <param name="userId"></param> - /// <param name="userData"></param> - /// <param name="cancellationToken"></param> - /// <returns></returns> + /// <param name="userId">The user id.</param> + /// <param name="userData">The array of user data.</param> + /// <param name="cancellationToken">The cancellation token.</param> void SaveAllUserData(Guid userId, UserItemData[] userData, CancellationToken cancellationToken); /// <summary> /// Updates playstate for an item and returns true or false indicating if it was played to completion. /// </summary> + /// <param name="item">Item to update.</param> + /// <param name="data">Data to update.</param> + /// <param name="positionTicks">New playstate.</param> + /// <returns>True if playstate was updated.</returns> bool UpdatePlayState(BaseItem item, UserItemData data, long? positionTicks); } } |
