Class PaginatedRequest<T>

This class manage the Api request pages list for a specified class

Inheritance
object
PaginatedRequest<T>
Inherited Members
Namespace: QarnotSDK
Assembly: QarnotSDK.dll
Syntax
public class PaginatedRequest<T>
Type Parameters
Name Description
T

the class to call

Constructors

PaginatedRequest()

Construct a new PaginatedRequest object empty.

Declaration
public PaginatedRequest()

PaginatedRequest(int, string, QFilter<T>)

Construct a new PaginatedRequest object.

Declaration
public PaginatedRequest(int maxResultByPage, string token = null, QFilter<T> filter = null)
Parameters
Type Name Description
int maxResultByPage

Maximum list number of objects to be retrun.
string token

Pagination token to get the next list.
QFilter<T> filter

Filter.

Properties

Filter

The filtering part, specification logical filters on the object properties

Declaration
public QFilter<T> Filter { get; set; }
Property Value
Type Description
QFilter<T>

the filter

MaximumResults

Maximum results number of result by page.

Declaration
public int? MaximumResults { get; set; }
Property Value
Type Description
int?

The maximum result for the query.

Token

Token given by the last page call return it to have the next page set it to it default value (null) to restart the paging from the start.

Declaration
public string Token { get; set; }
Property Value
Type Description
string

The token of the next page.

Methods

PrepareNextPage(PaginatedResponse<T>)

Change the request to get the next page send by the Api.

Declaration
public bool PrepareNextPage(PaginatedResponse<T> response)
Parameters
Type Name Description
PaginatedResponse<T> response

Last response send by the api.
Returns
Type Description
bool

Is there a new page to get.

ToString()

Override to string

Declaration
public override string ToString()
Returns
Type Description
string

string format
Overrides