PaginationParameters Class

Builds optional query string parameters for pagination.

Inheritance Hierarchy

SystemObject
Smartsheet.Api.ModelsPaginationParameters

Namespace: Smartsheet.Api.Models
Assemblies: smartsheet-csharp-sdk (in smartsheet-csharp-sdk.dll) Version: 2.126.0
smartsheet-csharp-sdk (in smartsheet-csharp-sdk.dll) Version: 2.126.0

Syntax

C++

Copy

public class PaginationParameters

Public Class PaginationParameters

public ref class PaginationParameters

type PaginationParameters =  class end

The PaginationParameters type exposes the following members.

Constructors

	Name	Description
	PaginationParameters	Builds optional query string parameters for pagination. Remarks 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.

Top

Properties

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

Top

Methods

	Name	Description
	toDictionary	Returns a dictionary of query string parameters.
	ToQueryString	Returns a formatted string of query string parameters.

Top

Reference

Smartsheet.Api.Models Namespace