Interface IGenreCollectionBase
A common interface for all collections that return genres.
Namespace: StrixMusic.Sdk.BaseModels
Assembly: StrixMusic.Sdk.dll
Syntax
public interface IGenreCollectionBase : ICollectionBase
Properties
| Improve this Doc View SourceTotalGenreCount
The total number of genres in this collection.
Declaration
int TotalGenreCount { get; }
Property Value
Type | Description |
---|---|
int |
Methods
| Improve this Doc View SourceIsAddGenreAvailableAsync(int, CancellationToken)
Checks if adding a genre to the collection at at the given index
is supported.
Declaration
Task<bool> IsAddGenreAvailableAsync(int index, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
int | index | |
CancellationToken | cancellationToken |
Returns
Type | Description |
---|---|
Task<bool> | A Task representing the asynchronous operation. If value is true, a new item can be added to the collection. |
IsRemoveGenreAvailableAsync(int, CancellationToken)
Checks if removing a genre to the collection at at the given index
is supported.
Declaration
Task<bool> IsRemoveGenreAvailableAsync(int index, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
int | index | |
CancellationToken | cancellationToken |
Returns
Type | Description |
---|---|
Task<bool> | A Task representing the asynchronous operation. If value is true, the item can be removed from the collection.. |
RemoveGenreAsync(int, CancellationToken)
Removes a genre from the collection.
Declaration
Task RemoveGenreAsync(int index, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
int | index | the position remove the genre from. |
CancellationToken | cancellationToken | A cancellation token that may be used to cancel the ongoing task. |
Returns
Type | Description |
---|---|
Task | A Task representing the asynchronous operation. |
Events
| Improve this Doc View SourceGenresCountChanged
Fires when the merged number of genres in the collection changes.
Declaration
event EventHandler<int>? GenresCountChanged
Event Type
Type | Description |
---|---|
EventHandler<int> |