Tgstation.Server.Client.PaginationSettings Class Reference

Settings for a paginated request. More...

Properties
int?	PageSize [get, set]
	The size of a page. Defaults to server settings.
int?	Offset [get, set]
	The offset to take from. Default 0.
int?	RetrieveCount [get, set]
	The maximum amount of items to retrieve. Default everything.

Detailed Description

Settings for a paginated request.

Definition at line 6 of file PaginationSettings.cs.

Property Documentation

Offset

int? Tgstation.Server.Client.PaginationSettings.Offset

getset

The offset to take from. Default 0.

Definition at line 16 of file PaginationSettings.cs.

{ get; set; }

Referenced by Tgstation.Server.Client.PaginatedClient.ReadPaged< TModel >().

PageSize

int? Tgstation.Server.Client.PaginationSettings.PageSize

getset

The size of a page. Defaults to server settings.

Definition at line 11 of file PaginationSettings.cs.

{ get; set; }

Referenced by Tgstation.Server.Client.PaginatedClient.ReadPaged< TModel >().

RetrieveCount

int? Tgstation.Server.Client.PaginationSettings.RetrieveCount

getset

The maximum amount of items to retrieve. Default everything.

Results will be truncated if overflow occurs due to PageSize.

Definition at line 22 of file PaginationSettings.cs.

{ get; set; }

Referenced by Tgstation.Server.Client.PaginatedClient.ReadPaged< TModel >().

---

The documentation for this class was generated from the following file:

• src/Tgstation.Server.Client/PaginationSettings.cs