Interface IListRequest

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

Syntax
public interface IListRequest

Methods

AddField(string)

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

Declaration
IListRequest 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 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 ClearFields()

ClearFilters()

Clears all existing filters.

Declaration
IListRequest ClearFilters()

Count(int?)

Sets the maximum returning result size.

Declaration
IListRequest 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 Offset(int? offset)
Parameters
Type Name Description
int? offset

The offset.

Search(string)

Sets text to search for in all text fields.

Declaration
IListRequest 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> 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 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 SortDescending(string name)
Parameters
Type Name Description
string name

The field name for descending sorting.

Extension Methods