Interface IItemRepository

Provides an interface to implement an Item repository

Inherited Members

IRepository.Name

System.IDisposable.Dispose()

Namespace: MediaBrowser.Controller.Persistence

Assembly: MediaBrowser.Controller.dll

Syntax

public interface IItemRepository : IRepository, IDisposable

Properties

LiveTvViewId

Declaration

long LiveTvViewId { get; set; }

Property Value

Type	Description
System.Int64

Methods

AddDatabase(ILibraryDatabase)

Declaration

void AddDatabase(ILibraryDatabase db)

Parameters

Type	Name	Description
ILibraryDatabase	db

AddListItems(BaseItem, ListItem[], Boolean)

Declaration

ListItem[] AddListItems(BaseItem list, ListItem[] items, bool skipDuplicates)

Parameters

Type	Name	Description
BaseItem	list
ListItem[]	items
System.Boolean	skipDuplicates

Returns

Type	Description
ListItem[]

DeleteChannels(Int64[])

Declaration

void DeleteChannels(long[] idsToDelete)

Parameters

Type	Name	Description
System.Int64[]	idsToDelete

DeleteChapters(Int64, MarkerType[])

Declaration

void DeleteChapters(long itemId, MarkerType[] markerTypes)

Parameters

Type	Name	Description
System.Int64	itemId
MarkerType[]	markerTypes

DeleteItems(BaseItem[])

Deletes the item.

Declaration

void DeleteItems(BaseItem[] item)

Parameters

Type	Name	Description
BaseItem[]	item

DeleteItems(Int64[])

Declaration

void DeleteItems(long[] ids)

Parameters

Type	Name	Description
System.Int64[]	ids

DeleteUserItemShares(Int64, Nullable<UserItemShareLevel>)

Declaration

void DeleteUserItemShares(long itemId, UserItemShareLevel? maxShareLevel)

Parameters

Type	Name	Description
System.Int64	itemId
System.Nullable<UserItemShareLevel>	maxShareLevel

GetAllGenres(InternalItemsQuery)

Declaration

QueryResult<Tuple<BaseItem, ItemCounts>> GetAllGenres(InternalItemsQuery query)

Parameters

Type	Name	Description
InternalItemsQuery	query

Returns

Type	Description
QueryResult<System.Tuple<BaseItem, ItemCounts>>

GetArtists(InternalItemsQuery, ItemLinkType[])

Declaration

QueryResult<Tuple<BaseItem, ItemCounts>> GetArtists(InternalItemsQuery query, ItemLinkType[] artistTypes)

Parameters

Type	Name	Description
InternalItemsQuery	query
ItemLinkType[]	artistTypes

Returns

Type	Description
QueryResult<System.Tuple<BaseItem, ItemCounts>>

GetAudioCodecs(InternalItemsQuery)

Declaration

QueryResult<string> GetAudioCodecs(InternalItemsQuery query)

Parameters

Type	Name	Description
InternalItemsQuery	query

Returns

Type	Description
QueryResult<System.String>

GetAudioLayouts(InternalItemsQuery)

Declaration

QueryResult<string> GetAudioLayouts(InternalItemsQuery query)

Parameters

Type	Name	Description
InternalItemsQuery	query

Returns

Type	Description
QueryResult<System.String>

GetChapter(Int64, Int32)

Gets a single chapter for an item

Declaration

ChapterInfo GetChapter(long itemId, int index)

Parameters

Type	Name	Description
System.Int64	itemId	The item identifier.
System.Int32	index	The index.

Returns

Type	Description
ChapterInfo

GetChapters(BaseItem)

Gets chapters for an item

Declaration

List<ChapterInfo> GetChapters(BaseItem item)

Parameters

Type	Name	Description
BaseItem	item	The item.

Returns

Type	Description
System.Collections.Generic.List<ChapterInfo>

GetChapters(Int64, MarkerType[])

Declaration

List<ChapterInfo> GetChapters(long itemId, MarkerType[] markerTypes)

Parameters

Type	Name	Description
System.Int64	itemId
MarkerType[]	markerTypes

Returns

Type	Description
System.Collections.Generic.List<ChapterInfo>

GetCollectionFolderIdFromItemLinkId(Int64, Int64, IDataContext)

Declaration

List<long> GetCollectionFolderIdFromItemLinkId(long id, long rootRolderId, IDataContext dataContext)

Parameters

Type	Name	Description
System.Int64	id
System.Int64	rootRolderId
IDataContext	dataContext

Returns

Type	Description
System.Collections.Generic.List<System.Int64>

GetCount(InternalItemsQuery)

Declaration

int GetCount(InternalItemsQuery query)

Parameters

Type	Name	Description
InternalItemsQuery	query

Returns

Type	Description
System.Int32

GetExtendedVideoTypes(InternalItemsQuery)

Declaration

QueryResult<ExtendedVideoTypes> GetExtendedVideoTypes(InternalItemsQuery query)

Parameters

Type	Name	Description
InternalItemsQuery	query

Returns

Type	Description
QueryResult<ExtendedVideoTypes>

GetExternalSubtitleFiles(Int64)

Declaration

List<string> GetExternalSubtitleFiles(long itemId)

Parameters

Type	Name	Description
System.Int64	itemId

Returns

Type	Description
System.Collections.Generic.List<System.String>

GetExtradataTypeId(String)

Declaration

long GetExtradataTypeId(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
System.Int64

GetExtraTypes(InternalItemsQuery)

Declaration

ExtraType[] GetExtraTypes(InternalItemsQuery query)

Parameters

Type	Name	Description
InternalItemsQuery	query

Returns

Type	Description
ExtraType[]

GetGameGenres(InternalItemsQuery)

Declaration

QueryResult<Tuple<BaseItem, ItemCounts>> GetGameGenres(InternalItemsQuery query)

Parameters

Type	Name	Description
InternalItemsQuery	query

Returns

Type	Description
QueryResult<System.Tuple<BaseItem, ItemCounts>>

GetGenres(InternalItemsQuery)

Declaration

QueryResult<Tuple<BaseItem, ItemCounts>> GetGenres(InternalItemsQuery query)

Parameters

Type	Name	Description
InternalItemsQuery	query

Returns

Type	Description
QueryResult<System.Tuple<BaseItem, ItemCounts>>

GetGuidAndPath(Int64)

Declaration

Tuple<Guid, string> GetGuidAndPath(long itemId)

Parameters

Type	Name	Description
System.Int64	itemId

Returns

Type	Description
System.Tuple<System.Guid, System.String>

GetIdGuidPairs(InternalItemsQuery)

Declaration

(long, Guid)[] GetIdGuidPairs(InternalItemsQuery query)

Parameters

Type	Name	Description
InternalItemsQuery	query

Returns

Type	Description
System.ValueTuple<System.Int64, System.Guid>[]

GetImageInfo(Int64, ImageType, Int32)

Declaration

ItemImageInfo GetImageInfo(long itemId, ImageType imageType, int index)

Parameters

Type	Name	Description
System.Int64	itemId
ImageType	imageType
System.Int32	index

Returns

Type	Description
ItemImageInfo

GetImportedCollections(Int64)

Declaration

LinkedItemInfo[] GetImportedCollections(long itemId)

Parameters

Type	Name	Description
System.Int64	itemId

Returns

Type	Description
LinkedItemInfo[]

GetInternalId(Guid)

Declaration

long GetInternalId(Guid guid)

Parameters

Type	Name	Description
System.Guid	guid

Returns

Type	Description
System.Int64

GetInternalItemIdsList(InternalItemsQuery, IDataContext)

Declaration

long[] GetInternalItemIdsList(InternalItemsQuery query, IDataContext dataContext)

Parameters

Type	Name	Description
InternalItemsQuery	query
IDataContext	dataContext

Returns

Type	Description
System.Int64[]

GetIntroDetectionFailureResult(Int64)

Declaration

string GetIntroDetectionFailureResult(long itemId)

Parameters

Type	Name	Description
System.Int64	itemId

Returns

Type	Description
System.String

GetIntrosDebugInfo()

Declaration

List<IntroDebugInfo> GetIntrosDebugInfo()

Returns

Type	Description
System.Collections.Generic.List<IntroDebugInfo>

GetItemByGuid(Guid)

Declaration

BaseItem GetItemByGuid(Guid id)

Parameters

Type	Name	Description
System.Guid	id

Returns

Type	Description
BaseItem

GetItemById(Int64)

Declaration

BaseItem GetItemById(long id)

Parameters

Type	Name	Description
System.Int64	id

Returns

Type	Description
BaseItem

GetItemByIdInTransaction(Int64, IDataContext)

Declaration

BaseItem GetItemByIdInTransaction(long id, IDataContext dataContext)

Parameters

Type	Name	Description
System.Int64	id
IDataContext	dataContext

Returns

Type	Description
BaseItem

GetItemExtradataValue(Int64, Int64)

Declaration

string GetItemExtradataValue(long itemId, long extradataTypeId)

Parameters

Type	Name	Description
System.Int64	itemId
System.Int64	extradataTypeId

Returns

Type	Description
System.String

GetItemIdsList(InternalItemsQuery)

Gets the item ids list.

Declaration

Guid[] GetItemIdsList(InternalItemsQuery query)

Parameters

Type	Name	Description
InternalItemsQuery	query	The query.

Returns

Type	Description
System.Guid[]	List<Guid>.

GetItemLinks(Int64, List<ItemLinkType>, IDataContext)

Declaration

List<(ItemLinkType, string, long)> GetItemLinks(long itemId, List<ItemLinkType> types, IDataContext dataContext)

Parameters

Type	Name	Description
System.Int64	itemId
System.Collections.Generic.List<ItemLinkType>	types
IDataContext	dataContext

Returns

Type	Description
System.Collections.Generic.List<System.ValueTuple<ItemLinkType, System.String, System.Int64>>

GetItemList(InternalItemsQuery)

Gets the item list.

Declaration

BaseItem[] GetItemList(InternalItemsQuery query)

Parameters

Type	Name	Description
InternalItemsQuery	query	The query.

Returns

Type	Description
BaseItem[]	List<BaseItem>.

GetItemList(InternalItemsQuery, IDataContext)

Declaration

BaseItem[] GetItemList(InternalItemsQuery query, IDataContext dataContext)

Parameters

Type	Name	Description
InternalItemsQuery	query
IDataContext	dataContext

Returns

Type	Description
BaseItem[]

GetItemPeople(InternalPeopleQuery)

Gets the people.

Declaration

List<PersonInfo> GetItemPeople(InternalPeopleQuery query)

Parameters

Type	Name	Description
InternalPeopleQuery	query	The query.

Returns

Type	Description
System.Collections.Generic.List<PersonInfo>	List<PersonInfo>.

GetItems(InternalItemsQuery, IDataContext)

Gets the items.

Declaration

QueryResult<BaseItem> GetItems(InternalItemsQuery query, IDataContext dataContext)

Parameters

Type	Name	Description
InternalItemsQuery	query	The query.
IDataContext	dataContext

Returns

Type	Description
QueryResult<BaseItem>	QueryResult<BaseItem>.

GetItemTypes(InternalItemsQuery)

Declaration

string[] GetItemTypes(InternalItemsQuery query)

Parameters

Type	Name	Description
InternalItemsQuery	query

Returns

Type	Description
System.String[]

GetMediaStreams(MediaStreamQuery)

Gets the media streams.

Declaration

List<MediaStream> GetMediaStreams(MediaStreamQuery query)

Parameters

Type	Name	Description
MediaStreamQuery	query	The query.

Returns

Type	Description
System.Collections.Generic.List<MediaStream>

GetMusicAlbums(InternalItemsQuery)

Declaration

QueryResult<Tuple<BaseItem, ItemCounts>> GetMusicAlbums(InternalItemsQuery query)

Parameters

Type	Name	Description
InternalItemsQuery	query

Returns

Type	Description
QueryResult<System.Tuple<BaseItem, ItemCounts>>

GetMusicGenres(InternalItemsQuery)

Declaration

QueryResult<Tuple<BaseItem, ItemCounts>> GetMusicGenres(InternalItemsQuery query)

Parameters

Type	Name	Description
InternalItemsQuery	query

Returns

Type	Description
QueryResult<System.Tuple<BaseItem, ItemCounts>>

GetNamedValue(Int64)

Declaration

string GetNamedValue(long nameId)

Parameters

Type	Name	Description
System.Int64	nameId

Returns

Type	Description
System.String

GetNamedValue(String)

Declaration

string GetNamedValue(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
System.String

GetNameIdPairs(InternalItemsQuery)

Declaration

(string, long)[] GetNameIdPairs(InternalItemsQuery query)

Parameters

Type	Name	Description
InternalItemsQuery	query

Returns

Type	Description
System.ValueTuple<System.String, System.Int64>[]

GetNewListItems(BaseItem, ListItem[], Boolean)

Declaration

ListItem[] GetNewListItems(BaseItem list, ListItem[] items, bool skipDuplicates)

Parameters

Type	Name	Description
BaseItem	list
ListItem[]	items
System.Boolean	skipDuplicates

Returns

Type	Description
ListItem[]

GetPaths(InternalItemsQuery)

Declaration

string[] GetPaths(InternalItemsQuery query)

Parameters

Type	Name	Description
InternalItemsQuery	query

Returns

Type	Description
System.String[]

GetPeople(InternalItemsQuery)

Declaration

QueryResult<BaseItem> GetPeople(InternalItemsQuery query)

Parameters

Type	Name	Description
InternalItemsQuery	query

Returns

Type	Description
QueryResult<BaseItem>

GetProviderIds(Int64)

Declaration

ProviderIdDictionary GetProviderIds(long itemId)

Parameters

Type	Name	Description
System.Int64	itemId

Returns

Type	Description
ProviderIdDictionary

GetShareLevels(InternalItemsQuery)

Declaration

QueryResult<UserItemShareLevel?> GetShareLevels(InternalItemsQuery query)

Parameters

Type	Name	Description
InternalItemsQuery	query

Returns

Type	Description
QueryResult<System.Nullable<UserItemShareLevel>>

GetStreamLanguages(InternalItemsQuery, MediaStreamType)

Declaration

QueryResult<string> GetStreamLanguages(InternalItemsQuery query, MediaStreamType streamType)

Parameters

Type	Name	Description
InternalItemsQuery	query
MediaStreamType	streamType

Returns

Type	Description
QueryResult<System.String>

GetStudios(InternalItemsQuery)

Declaration

QueryResult<Tuple<BaseItem, ItemCounts>> GetStudios(InternalItemsQuery query)

Parameters

Type	Name	Description
InternalItemsQuery	query

Returns

Type	Description
QueryResult<System.Tuple<BaseItem, ItemCounts>>

GetSubtitleCodecs(InternalItemsQuery)

Declaration

QueryResult<string> GetSubtitleCodecs(InternalItemsQuery query)

Parameters

Type	Name	Description
InternalItemsQuery	query

Returns

Type	Description
QueryResult<System.String>

GetSubviews(InternalItemsQuery, String)

Declaration

List<string> GetSubviews(InternalItemsQuery query, string contentType)

Parameters

Type	Name	Description
InternalItemsQuery	query
System.String	contentType

Returns

Type	Description
System.Collections.Generic.List<System.String>

GetSyncTargetId(String, Boolean)

Declaration

long GetSyncTargetId(string name, bool createIfNotFound)

Parameters

Type	Name	Description
System.String	name
System.Boolean	createIfNotFound

Returns

Type	Description
System.Int64

GetTags(InternalItemsQuery)

Declaration

QueryResult<Tuple<BaseItem, ItemCounts>> GetTags(InternalItemsQuery query)

Parameters

Type	Name	Description
InternalItemsQuery	query

Returns

Type	Description
QueryResult<System.Tuple<BaseItem, ItemCounts>>

GetThumbnailImageExtractionFailureResult(Int64)

Declaration

string GetThumbnailImageExtractionFailureResult(long itemId)

Parameters

Type	Name	Description
System.Int64	itemId

Returns

Type	Description
System.String

GetTypeAndImageInfo(Int64, ImageType, Int32)

Declaration

Tuple<Type, ItemImageInfo> GetTypeAndImageInfo(long itemId, ImageType imageType, int index)

Parameters

Type	Name	Description
System.Int64	itemId
ImageType	imageType
System.Int32	index

Returns

Type	Description
System.Tuple<System.Type, ItemImageInfo>

GetUserItemShares(UserItemShareQuery)

Declaration

UserItemShare[] GetUserItemShares(UserItemShareQuery query)

Parameters

Type	Name	Description
UserItemShareQuery	query

Returns

Type	Description
UserItemShare[]

GetVideoCodecs(InternalItemsQuery)

Declaration

QueryResult<string> GetVideoCodecs(InternalItemsQuery query)

Parameters

Type	Name	Description
InternalItemsQuery	query

Returns

Type	Description
QueryResult<System.String>

LogIntroDetectionFailureFailure(Int64, Int64)

Declaration

void LogIntroDetectionFailureFailure(long itemId, long dateModifiedUnixTimeSeconds)

Parameters

Type	Name	Description
System.Int64	itemId
System.Int64	dateModifiedUnixTimeSeconds

LogThumbnailImageExtractionFailure(Int64, Int64)

Declaration

void LogThumbnailImageExtractionFailure(long itemId, long dateModifiedTicks)

Parameters

Type	Name	Description
System.Int64	itemId
System.Int64	dateModifiedTicks

MoveListItem(Int64, Int64, Int32)

Declaration

void MoveListItem(long listId, long entryId, int newIndex)

Parameters

Type	Name	Description
System.Int64	listId
System.Int64	entryId
System.Int32	newIndex

OnItemLinksFilled(BaseItem, IDataContext)

Declaration

void OnItemLinksFilled(BaseItem item, IDataContext dataContext)

Parameters

Type	Name	Description
BaseItem	item
IDataContext	dataContext

OnUserDeleted(Int64)

Declaration

void OnUserDeleted(long userId)

Parameters

Type	Name	Description
System.Int64	userId

RemoveListItemsByItemIds(Int64, Int64[])

Declaration

void RemoveListItemsByItemIds(long listId, long[] listItemIds)

Parameters

Type	Name	Description
System.Int64	listId
System.Int64[]	listItemIds

RemoveListItemsByListItemEntryIds(Int64, Int64[])

Declaration

void RemoveListItemsByListItemEntryIds(long listId, long[] listItemIds)

Parameters

Type	Name	Description
System.Int64	listId
System.Int64[]	listItemIds

SaveChapters(Int64, Boolean, List<ChapterInfo>)

Declaration

void SaveChapters(long itemId, bool clearExtractionFailureResult, List<ChapterInfo> chapters)

Parameters

Type	Name	Description
System.Int64	itemId
System.Boolean	clearExtractionFailureResult
System.Collections.Generic.List<ChapterInfo>	chapters

SaveChapters(Int64, List<ChapterInfo>)

Saves the chapters.

Declaration

void SaveChapters(long itemId, List<ChapterInfo> chapters)

Parameters

Type	Name	Description
System.Int64	itemId
System.Collections.Generic.List<ChapterInfo>	chapters

SaveImages(Int64, ItemImageInfo[])

Declaration

void SaveImages(long id, ItemImageInfo[] images)

Parameters

Type	Name	Description
System.Int64	id
ItemImageInfo[]	images

SaveItem(BaseItem, CancellationToken)

Saves an item

Declaration

void SaveItem(BaseItem item, CancellationToken cancellationToken)

Parameters

Type	Name	Description
BaseItem	item
System.Threading.CancellationToken	cancellationToken

SaveItems(List<BaseItem>, MetadataRefreshOptions, CancellationToken)

Declaration

void SaveItems(List<BaseItem> items, MetadataRefreshOptions metadataRefreshOptions, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Collections.Generic.List<BaseItem>	items
MetadataRefreshOptions	metadataRefreshOptions
System.Threading.CancellationToken	cancellationToken

SaveItems(List<BaseItem>, CancellationToken)

Saves the items.

Declaration

void SaveItems(List<BaseItem> items, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Collections.Generic.List<BaseItem>	items	The items.
System.Threading.CancellationToken	cancellationToken	The cancellation token.

SaveMediaStreams(Int64, List<MediaStream>, CancellationToken)

Saves the media streams.

Declaration

void SaveMediaStreams(long itemId, List<MediaStream> streams, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Int64	itemId	The item identifier.
System.Collections.Generic.List<MediaStream>	streams	The streams.
System.Threading.CancellationToken	cancellationToken	The cancellation token.

SaveUserItemShares(UserItemShare[])

Declaration

void SaveUserItemShares(UserItemShare[] shares)

Parameters

Type	Name	Description
UserItemShare[]	shares

SetItemExtradata(Int64, Int64, String)

Declaration

void SetItemExtradata(long itemId, long extradataTypeId, string value)

Parameters

Type	Name	Description
System.Int64	itemId
System.Int64	extradataTypeId
System.String	value

SetNamedValue(Int64, String)

Declaration

void SetNamedValue(long nameId, string value)

Parameters

Type	Name	Description
System.Int64	nameId
System.String	value

SetNamedValue(String, String)

Declaration

void SetNamedValue(string name, string value)

Parameters

Type	Name	Description
System.String	name
System.String	value

SetSortIndexNumbers(List<Tuple<Int64, Int32>>)

Declaration

void SetSortIndexNumbers(List<Tuple<long, int>> values)

Parameters

Type	Name	Description
System.Collections.Generic.List<System.Tuple<System.Int64, System.Int32>>	values

UpdateListItems(BaseItem, LinkedChild[])

Declaration

void UpdateListItems(BaseItem list, LinkedChild[] items)

Parameters

Type	Name	Description
BaseItem	list
LinkedChild[]	items

UpdatePeople(Int64, List<PersonInfo>)

Updates the people.

Declaration

void UpdatePeople(long itemId, List<PersonInfo> people)

Parameters

Type	Name	Description
System.Int64	itemId
System.Collections.Generic.List<PersonInfo>	people

UpdateProgramsForChannel(BaseItem, List<BaseItem>, Int64[])

Declaration

void UpdateProgramsForChannel(BaseItem channel, List<BaseItem> programs, long[] programsToDelete)

Parameters

Type	Name	Description
BaseItem	channel
System.Collections.Generic.List<BaseItem>	programs
System.Int64[]	programsToDelete

Events

OnItemTagged

Declaration

event EventHandler<GenericEventArgs<ItemTaggedEvent>> OnItemTagged

Event Type

Type	Description
System.EventHandler<GenericEventArgs<ItemTaggedEvent>>

Extension Methods

Extensions.JsonClone<T>(T, IJsonSerializer)