Interface ICollectionManager
Namespace: MediaBrowser.Controller.Collections
Assembly: MediaBrowser.Controller.dll
Syntax
public interface ICollectionManagerMethods
AddToCollection(Int64, Int64[])
Adds to collection.
Declaration
Task AddToCollection(long collectionId, long[] itemIds)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | collectionId | The collection identifier. |
| System.Int64[] | itemIds | The item ids. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
CreateCollection(CollectionCreationOptions)
Creates the collection.
Declaration
Task<BoxSet> CreateCollection(CollectionCreationOptions options)Parameters
| Type | Name | Description |
|---|---|---|
| CollectionCreationOptions | options | The options. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<BoxSet> |
RemoveFromCollection(BoxSet, Int64[])
Removes from collection.
Declaration
void RemoveFromCollection(BoxSet item, long[] itemIds)Parameters
| Type | Name | Description |
|---|---|---|
| BoxSet | item | |
| System.Int64[] | itemIds |
Events
CollectionCreated
Occurs when [collection created].
Declaration
event EventHandler<CollectionCreatedEventArgs> CollectionCreatedEvent Type
| Type | Description |
|---|---|
| System.EventHandler<CollectionCreatedEventArgs> |
ItemsAddedToCollection
Occurs when [items added to collection].
Declaration
event EventHandler<CollectionModifiedEventArgs> ItemsAddedToCollectionEvent Type
| Type | Description |
|---|---|
| System.EventHandler<CollectionModifiedEventArgs> |
ItemsRemovedFromCollection
Occurs when [items removed from collection].
Declaration
event EventHandler<CollectionModifiedEventArgs> ItemsRemovedFromCollectionEvent Type
| Type | Description |
|---|---|
| System.EventHandler<CollectionModifiedEventArgs> |