Interface IListRequest<T>

Represents a request which can be filtered, sorted and paged.

Syntax
public interface IListRequest<T> : IListRequest
Type Parameters
Name Description
T

Methods

AddField(string)

Adds an individual field to be requested. Can also be a table attribute.

Declaration
IListRequest<T> AddField(string name)
Parameters
Type Name Description
string name

The name of the field

AddFilter(string, IFilter)

Adds a filter for a specific field.

Declaration
IListRequest<T> AddFilter(string name, IFilter filter)
Parameters
Type Name Description
string name

The name of the field.
IFilter filter

The filter condition.

ClearFields()

Clears all existing requested fields.

Declaration
IListRequest<T> ClearFields()

ClearFilters()

Clears all existing filters.

Declaration
IListRequest<T> ClearFilters()

Count(int?)

Sets the maximum returning result size.

Declaration
IListRequest<T> Count(int? count)
Parameters
Type Name Description
int? count

The count.

Offset(int?)

Sets the zero based offset from which to start returning results.

Declaration
IListRequest<T> Offset(int? offset)
Parameters
Type Name Description
int? offset

The offset.

Search(string)

Sets text to search for in all text fields.

Declaration
IListRequest<T> Search(string value)
Parameters
Type Name Description
string value

The value to search for.

SendAsync(CancellationToken)

Sends the list request to the server.

Declaration
Task<IListResponse<T>> SendAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken

The cancellation token.

SortAscending(string)

Sets the field name to sort for in ascending order.

Declaration
IListRequest<T> SortAscending(string name)
Parameters
Type Name Description
string name

The field name for ascending sorting.

SortDescending(string)

Sets the field name to sort for in descening order.

Declaration
IListRequest<T> SortDescending(string name)
Parameters
Type Name Description
string name

The field name for descending sorting.

Extension Methods