Class OffsetPageRequest
Create an API request with a limited page in response
Inherited Members
Namespace: QarnotSDK
Assembly: QarnotSDK.dll
Syntax
public class OffsetPageRequestConstructors
OffsetPageRequest()
Create a new empty OffsetPageRequest
Declaration
public OffsetPageRequest()OffsetPageRequest(int, int)
Create a new OffsetPageRequest with custom limit and offset.
Declaration
public OffsetPageRequest(int limit, int offset = 0)Parameters
| Type | Name | Description |
|---|---|---|
| int | limit | The maximum number of elements of a page (cannot be more than the default value QarnotSDK.OffsetPageRequest.MAX_PAGE_SIZE) |
| int | offset | The response page offset. Default to 0. |
Properties
Limit
The limit number of elements to display in the response page. Cannot be over the default value QarnotSDK.OffsetPageRequest.MAX_PAGE_SIZE
Declaration
public int Limit { get; set; }Property Value
| Type | Description |
|---|---|
| int |
Offset
The number of elements to ignore.
Declaration
public int Offset { get; set; }Property Value
| Type | Description |
|---|---|
| int |
Methods
GetAsQueryString()
Get the query with the request as parameters
Declaration
public string GetAsQueryString()Returns
| Type | Description |
|---|---|
| string |
ToString()
Override to string
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| string | string format |