Interface IFilteredPagedListApiClient<TContent>
Interface for an API client that can list for content items with a filter.
Inherited Members
Namespace: Tableau.Migration.Api
Assembly: Tableau.Migration.dll
Syntax
public interface IFilteredPagedListApiClient<TContent> : IPagedListApiClient<TContent>Type Parameters
| Name | Description |
|---|---|
| TContent | The content type. |
Methods
GetAllAsync(IEnumerable<Filter>, int, CancellationToken)
Gets all the content items that the user has access to.
Declaration
Task<IResult<IImmutableList<TContent>>> GetAllAsync(IEnumerable<Filter> filters, int pageSize, CancellationToken cancel)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<Filter> | filters | The filters to apply. |
| int | pageSize | The expected maximum number of items to include in each page. |
| CancellationToken | cancel | The cancellation token to obey. |
Returns
| Type | Description |
|---|---|
| Task<IResult<IImmutableList<TContent>>> | The total results. |
GetPager(IEnumerable<Filter>, int)
Gets a pager to list all the content the user has access to.
Declaration
IPager<TContent> GetPager(IEnumerable<Filter> filters, int pageSize)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<Filter> | filters | The filters to apply. |
| int | pageSize | The page size to use. |
Returns
| Type | Description |
|---|---|
| IPager<TContent> | A pager to list content with. |