Documentation

ListWorkspaceFilePagesOptions
in package

ListWorkspaceFilePagesOptions Class Doc Comment

Tags
category

Class

author

Swagger Codegen team apihelp@docusign.com

license

The DocuSign PHP Client SDK is licensed under the MIT License.

link
https://github.com/swagger-api/swagger-codegen

Table of Contents

$count  : string|null
$count The maximum number of results to be returned by this request.
$dpi  : string|null
$dpi Number of dots per inch for the resulting image. The default if not used is 94. The range is 1-310.
$max_height  : string|null
$max_height Sets the maximum height (in pixels) of the returned image.
$max_width  : string|null
$max_width Sets the maximum width (in pixels) of the returned image.
$start_position  : string|null
$start_position The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.
getCount()  : string|null
Gets count
getDpi()  : string|null
Gets dpi
getMaxHeight()  : string|null
Gets max_height
getMaxWidth()  : string|null
Gets max_width
getStartPosition()  : string|null
Gets start_position
setCount()  : self
Sets count
setDpi()  : self
Sets dpi
setMaxHeight()  : self
Sets max_height
setMaxWidth()  : self
Sets max_width
setStartPosition()  : self
Sets start_position

Properties

$count

$count The maximum number of results to be returned by this request.

protected string|null $count = null

$dpi

$dpi Number of dots per inch for the resulting image. The default if not used is 94. The range is 1-310.

protected string|null $dpi = null

$max_height

$max_height Sets the maximum height (in pixels) of the returned image.

protected string|null $max_height = null

$max_width

$max_width Sets the maximum width (in pixels) of the returned image.

protected string|null $max_width = null

$start_position

$start_position The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.

protected string|null $start_position = null

Methods

getCount()

Gets count

public getCount() : string|null
Return values
string|null

getDpi()

Gets dpi

public getDpi() : string|null
Return values
string|null

getMaxHeight()

Gets max_height

public getMaxHeight() : string|null
Return values
string|null

getMaxWidth()

Gets max_width

public getMaxWidth() : string|null
Return values
string|null

getStartPosition()

Gets start_position

public getStartPosition() : string|null
Return values
string|null

setCount()

Sets count

public setCount(string|null $count) : self
Parameters
$count : string|null

The maximum number of results to be returned by this request.

Return values
self

setDpi()

Sets dpi

public setDpi(string|null $dpi) : self
Parameters
$dpi : string|null

Number of dots per inch for the resulting image. The default if not used is 94. The range is 1-310.

Return values
self

setMaxHeight()

Sets max_height

public setMaxHeight(string|null $max_height) : self
Parameters
$max_height : string|null

Sets the maximum height (in pixels) of the returned image.

Return values
self

setMaxWidth()

Sets max_width

public setMaxWidth(string|null $max_width) : self
Parameters
$max_width : string|null

Sets the maximum width (in pixels) of the returned image.

Return values
self

setStartPosition()

Sets start_position

public setStartPosition(string|null $start_position) : self
Parameters
$start_position : string|null

The position within the total result set from which to start returning values. The value thumbnail may be used to return the page image.

Return values
self

Search results