Interface IUserDataManager

Interface IUserDataManager

Namespace: MediaBrowser.Controller.Library
Assembly: MediaBrowser.Controller.dll
Syntax
public interface IUserDataManager

Methods

ClearTrackSelections(Int64, MediaStreamType)

Declaration
void ClearTrackSelections(long userId, MediaStreamType trackType)
Parameters
Type Name Description
System.Int64 userId
MediaStreamType trackType

GetAllUserData(Int64)

Get all user data for the given user

Declaration
List<UserItemData> GetAllUserData(long userId)
Parameters
Type Name Description
System.Int64 userId
Returns
Type Description
System.Collections.Generic.List<UserItemData>

GetUserData(User, BaseItem)

Declaration
UserItemData GetUserData(User user, BaseItem item)
Parameters
Type Name Description
User user
BaseItem item
Returns
Type Description
UserItemData

GetUserData(User, Int64)

Declaration
UserItemData GetUserData(User user, long itemId)
Parameters
Type Name Description
User user
System.Int64 itemId
Returns
Type Description
UserItemData

GetUserData(Int64, BaseItem)

Declaration
UserItemData GetUserData(long userId, BaseItem item)
Parameters
Type Name Description
System.Int64 userId
BaseItem item
Returns
Type Description
UserItemData

GetUserData(Int64, Int64, UserDataFields[])

Declaration
UserItemData GetUserData(long userId, long itemId, UserDataFields[] fields)
Parameters
Type Name Description
System.Int64 userId
System.Int64 itemId
UserDataFields[] fields
Returns
Type Description
UserItemData

GetUserData(ReadOnlySpan<Char>, BaseItem)

Declaration
UserItemData GetUserData(ReadOnlySpan<char> userId, BaseItem item)
Parameters
Type Name Description
System.ReadOnlySpan<System.Char> userId
BaseItem item
Returns
Type Description
UserItemData

GetUserData(String, BaseItem)

Declaration
UserItemData GetUserData(string userId, BaseItem item)
Parameters
Type Name Description
System.String userId
BaseItem item
Returns
Type Description
UserItemData

GetUserDataDto(BaseItem, User)

Gets the user data dto.

Declaration
UserItemDataDto GetUserDataDto(BaseItem item, User user)
Parameters
Type Name Description
BaseItem item
User user
Returns
Type Description
UserItemDataDto

GetUserDataDto(BaseItem, User, DtoOptions, LibraryOptions)

Declaration
UserItemDataDto GetUserDataDto(BaseItem item, User user, DtoOptions options, LibraryOptions libraryOptions)
Parameters
Type Name Description
BaseItem item
User user
DtoOptions options
LibraryOptions libraryOptions
Returns
Type Description
UserItemDataDto

SaveAllUserData(Int64, UserItemData[], CancellationToken)

Save the all provided user data for the given user

Declaration
void SaveAllUserData(long userId, UserItemData[] userData, CancellationToken cancellationToken)
Parameters
Type Name Description
System.Int64 userId
UserItemData[] userData
System.Threading.CancellationToken cancellationToken

SaveUserData(User, BaseItem, BaseItem[], UserItemData, UserDataSaveReason, CancellationToken)

Declaration
void SaveUserData(User user, BaseItem item, BaseItem[] collectionFolders, UserItemData userData, UserDataSaveReason reason, CancellationToken cancellationToken)
Parameters
Type Name Description
User user
BaseItem item
BaseItem[] collectionFolders
UserItemData userData
UserDataSaveReason reason
System.Threading.CancellationToken cancellationToken

SaveUserData(User, BaseItem, UserItemData, UserDataSaveReason, CancellationToken)

Declaration
void SaveUserData(User user, BaseItem item, UserItemData userData, UserDataSaveReason reason, CancellationToken cancellationToken)
Parameters
Type Name Description
User user
BaseItem item
UserItemData userData
UserDataSaveReason reason
System.Threading.CancellationToken cancellationToken

SaveUserData(Int64, BaseItem, BaseItem[], UserItemData, UserDataSaveReason, CancellationToken)

Declaration
void SaveUserData(long userId, BaseItem item, BaseItem[] collectionFolders, UserItemData userData, UserDataSaveReason reason, CancellationToken cancellationToken)
Parameters
Type Name Description
System.Int64 userId
BaseItem item
BaseItem[] collectionFolders
UserItemData userData
UserDataSaveReason reason
System.Threading.CancellationToken cancellationToken

SaveUserData(Int64, BaseItem, UserItemData, UserDataSaveReason, CancellationToken)

Declaration
void SaveUserData(long userId, BaseItem item, UserItemData userData, UserDataSaveReason reason, CancellationToken cancellationToken)
Parameters
Type Name Description
System.Int64 userId
BaseItem item
UserItemData userData
UserDataSaveReason reason
System.Threading.CancellationToken cancellationToken

UnhideSeriesFromResume(Int64, String)

Declaration
void UnhideSeriesFromResume(long userId, string seriesPresentationUniqueKey)
Parameters
Type Name Description
System.Int64 userId
System.String seriesPresentationUniqueKey

UpdatePlayState(BaseItem, UserItemData, Nullable<Int64>)

Declaration
bool UpdatePlayState(BaseItem item, UserItemData data, long? positionTicks)
Parameters
Type Name Description
BaseItem item
UserItemData data
System.Nullable<System.Int64> positionTicks
Returns
Type Description
System.Boolean

UpdatePlayState(BaseItem, LibraryOptions, UserItemData, Nullable<Int64>)

Updates playstate for an item and returns true or false indicating if it was played to completion

Declaration
bool UpdatePlayState(BaseItem item, LibraryOptions libraryOptions, UserItemData data, long? positionTicks)
Parameters
Type Name Description
BaseItem item
LibraryOptions libraryOptions
UserItemData data
System.Nullable<System.Int64> positionTicks
Returns
Type Description
System.Boolean

Events

UserDataSaved

Occurs when [user data saved].

Declaration
event EventHandler<UserDataSaveEventArgs> UserDataSaved
Event Type
Type Description
System.EventHandler<UserDataSaveEventArgs>

Extension Methods