Class PaginationParameters

Namespace

Smartsheet.Api.Models

Assembly

smartsheet-csharp-sdk.dll

Builds optional query string parameters for pagination.

public class PaginationParameters

Inheritance

object

PaginationParameters

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

PaginationParameters(bool, int?, int?)

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)

Parameters

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.

Properties

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).

public bool IncludeAll { get; set; }

Property Value

bool

Page

Which page to return. Defaults to 1 if not specified.

public int? Page { get; set; }

Property Value

int?

PageSize

The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100 if not specified.

public int? PageSize { get; set; }

Property Value

int?

Methods

ToQueryString()

Returns a formatted string of query string parameters.

public string ToQueryString()

Returns

string

the query string

toDictionary()

Returns a dictionary of query string parameters.

public IDictionary<string, string> toDictionary()

Returns

IDictionary<string, string>