Documentation

ListRecipientsOptions
in package

ListRecipientsOptions 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

$include_anchor_tab_locations  : string|null
$include_anchor_tab_locations When set to **true** and `include_tabs` is set to **true**, all tabs with anchor tab properties are included in the response.
$include_extended  : string|null
$include_extended When set to **true**, the extended properties are included in the response.
$include_metadata  : string|null
$include_metadata
$include_tabs  : string|null
$include_tabs When set to **true**, the tab information associated with the recipient is included in the response.
getIncludeAnchorTabLocations()  : string|null
Gets include_anchor_tab_locations
getIncludeExtended()  : string|null
Gets include_extended
getIncludeMetadata()  : string|null
Gets include_metadata
getIncludeTabs()  : string|null
Gets include_tabs
setIncludeAnchorTabLocations()  : self
Sets include_anchor_tab_locations
setIncludeExtended()  : self
Sets include_extended
setIncludeMetadata()  : self
Sets include_metadata
setIncludeTabs()  : self
Sets include_tabs

Properties

$include_anchor_tab_locations

$include_anchor_tab_locations When set to **true** and `include_tabs` is set to **true**, all tabs with anchor tab properties are included in the response.

protected string|null $include_anchor_tab_locations = null

$include_extended

$include_extended When set to **true**, the extended properties are included in the response.

protected string|null $include_extended = null

$include_metadata

$include_metadata

protected string|null $include_metadata = null

$include_tabs

$include_tabs When set to **true**, the tab information associated with the recipient is included in the response.

protected string|null $include_tabs = null

Methods

getIncludeAnchorTabLocations()

Gets include_anchor_tab_locations

public getIncludeAnchorTabLocations() : string|null
Return values
string|null —

getIncludeExtended()

Gets include_extended

public getIncludeExtended() : string|null
Return values
string|null —

getIncludeMetadata()

Gets include_metadata

public getIncludeMetadata() : string|null
Return values
string|null —

getIncludeTabs()

Gets include_tabs

public getIncludeTabs() : string|null
Return values
string|null —

setIncludeAnchorTabLocations()

Sets include_anchor_tab_locations

public setIncludeAnchorTabLocations(string|null $include_anchor_tab_locations) : self
Parameters
$include_anchor_tab_locations : string|null

When set to true and include_tabs is set to true, all tabs with anchor tab properties are included in the response.

Return values
self —

setIncludeExtended()

Sets include_extended

public setIncludeExtended(string|null $include_extended) : self
Parameters
$include_extended : string|null

When set to true, the extended properties are included in the response.

Return values
self —

setIncludeMetadata()

Sets include_metadata

public setIncludeMetadata(string|null $include_metadata) : self
Parameters
$include_metadata : string|null
Return values
self —

setIncludeTabs()

Sets include_tabs

public setIncludeTabs(string|null $include_tabs) : self
Parameters
$include_tabs : string|null

When set to true, the tab information associated with the recipient is included in the response.

Return values
self —

Search results