Interface ICoreUrlCollection
A collection of URLs.
Inherited Members
Namespace: StrixMusic.Sdk.CoreModels
Assembly: StrixMusic.Sdk.dll
Syntax
public interface ICoreUrlCollection : ICoreCollection, IUrlCollectionBase, ICollectionBase, ICoreModel
Remarks
This interface should be implemented by a core.
Methods
| Improve this Doc View SourceAddUrlAsync(ICoreUrl, int, CancellationToken)
Adds a new url to the collection.
Declaration
Task AddUrlAsync(ICoreUrl url, int index, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
ICoreUrl | url | The url to insert. |
int | index | the position to insert the url at. |
CancellationToken | cancellationToken | A cancellation token that may be used to cancel the ongoing task. |
Returns
Type | Description |
---|---|
Task | A Task representing the asynchronous operation. |
GetUrlsAsync(int, int, CancellationToken)
Gets a requested number of ICoreUrls starting at the given offset in the backend.
Declaration
IAsyncEnumerable<ICoreUrl> GetUrlsAsync(int limit, int offset, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
int | limit | The max number of items to return. |
int | offset | Get items starting at this index. |
CancellationToken | cancellationToken | A cancellation token that may be used to cancel the ongoing task. |
Returns
Type | Description |
---|---|
IAsyncEnumerable<ICoreUrl> | IAsyncEnumerable<T> containing the requested items. |
Events
| Improve this Doc View SourceUrlsChanged
Fires when the urls are changed.
Declaration
event CollectionChangedEventHandler<ICoreUrl>? UrlsChanged
Event Type
Type | Description |
---|---|
CollectionChangedEventHandler<ICoreUrl> |