C# Class Smartsheet.Api.Models.PaginationParameters

Builds optional query string parameters for pagination.

Show file Open project: smartsheet-platform/smartsheet-csharp-sdk Class Usage Examples

Public Methods

Method	Description
PaginationParameters ( bool includeAll, int pageSize, int page ) : System	Builds optional query string parameters for pagination. Most index endpoints default to a page size of 100 results. If you need all results at once, you should specify the includeAll=true query string parameter.
ToQueryString ( ) : string	Returns a formatted string of query string parameters.
toDictionary ( ) : string>.IDictionary	Returns a dictionary of query string parameters.

Method Details

PaginationParameters() public method

Builds optional query string parameters for pagination. Most index endpoints default to a page size of 100 results. If you need all results at once, you should specify the includeAll=true query string parameter.

public PaginationParameters ( bool includeAll, int pageSize, int page ) : System
includeAll	bool	If true, include all results (i.e. do not paginate). /// Mutually exclusive with pageSize and page (they are ignored if includeAll=true is specified)
pageSize	int	The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, /// defaults to 100 if not specified.
page	int	Which page to return. Defaults to 1 if not specified.
return	System

ToQueryString() public method

Returns a formatted string of query string parameters.

public ToQueryString ( ) : string
return	string

toDictionary() public method

Returns a dictionary of query string parameters.

public toDictionary ( ) : string>.IDictionary
return	string>.IDictionary