Documentation

PrefillTabs
in package
implements ModelInterface, ArrayAccess

PrefillTabs Class Doc Comment

Tags
category

Class

description

Prefill tabs are tabs that the sender can fill in before the envelope is sent. They are sometimes called sender tags or pre-fill fields. Only the following tab types can be prefill tabs: - text - check boxes - radio buttons [Pre-Fill Your Own Document Fields][app] describes how prefill tabs work in the web application. [Customize your envelopes with pre-fill fields][catblog] shows how to use prefill tabs in your application using the eSignature SDKs. [app]: https://support.docusign.com/en/guides/ndse-user-guide-prefill-fields [catblog]: https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields

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

Interfaces, Classes, Traits and Enums

ModelInterface
Interface abstracting model access.
ArrayAccess

Table of Contents

DISCRIMINATOR  = null
$attributeMap  : array<string|int, string>
Array of attributes where the key is the local name, and the value is the original name
$container  : array<string|int, mixed>
Associative array for storing property values
$getters  : array<string|int, string>
Array of attributes to getter functions (for serialization of requests)
$setters  : array<string|int, string>
Array of attributes to setter functions (for deserialization of responses)
$swaggerFormats  : array<string|int, string>
Array of property to format mappings. Used for (de)serialization
$swaggerModelName  : string
The original name of the model.
$swaggerTypes  : array<string|int, string>
Array of property to type mappings. Used for (de)serialization
__construct()  : mixed
Constructor
__toString()  : string
Gets the string presentation of the object
attributeMap()  : array<string|int, mixed>
Array of attributes where the key is the local name, and the value is the original name
getCheckboxTabs()  : array<string|int, Checkbox>
Gets checkbox_tabs
getDateTabs()  : array<string|int, Date>
Gets date_tabs
getEmailTabs()  : array<string|int, Email>
Gets email_tabs
getModelName()  : string
The original name of the model.
getNumberTabs()  : array<string|int, Number>
Gets number_tabs
getRadioGroupTabs()  : array<string|int, RadioGroup>
Gets radio_group_tabs
getSenderCompanyTabs()  : array<string|int, SenderCompany>
Gets sender_company_tabs
getSenderNameTabs()  : array<string|int, SenderName>
Gets sender_name_tabs
getSsnTabs()  : array<string|int, Ssn>
Gets ssn_tabs
getTabGroups()  : array<string|int, TabGroup>
Gets tab_groups
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getTextTabs()  : array<string|int, Text>
Gets text_tabs
getZipTabs()  : array<string|int, Zip>
Gets zip_tabs
listInvalidProperties()  : array<string|int, mixed>
Show all the invalid properties with reasons.
offsetExists()  : bool
Returns true if offset exists. False otherwise.
offsetGet()  : mixed
Gets offset.
offsetSet()  : void
Sets value based on offset.
offsetUnset()  : void
Unsets offset.
setCheckboxTabs()  : $this
Sets checkbox_tabs
setDateTabs()  : $this
Sets date_tabs
setEmailTabs()  : $this
Sets email_tabs
setNumberTabs()  : $this
Sets number_tabs
setRadioGroupTabs()  : $this
Sets radio_group_tabs
setSenderCompanyTabs()  : $this
Sets sender_company_tabs
setSenderNameTabs()  : $this
Sets sender_name_tabs
setSsnTabs()  : $this
Sets ssn_tabs
setTabGroups()  : $this
Sets tab_groups
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTextTabs()  : $this
Sets text_tabs
setZipTabs()  : $this
Sets zip_tabs
swaggerFormats()  : array<string|int, mixed>
Array of property to format mappings. Used for (de)serialization
swaggerTypes()  : array<string|int, mixed>
Array of property to type mappings. Used for (de)serialization
valid()  : bool
Validate all the properties in the model return true if all passed

Constants

Properties

$attributeMap

Array of attributes where the key is the local name, and the value is the original name

protected static array<string|int, string> $attributeMap = ['checkbox_tabs' => 'checkboxTabs', 'date_tabs' => 'dateTabs', 'email_tabs' => 'emailTabs', 'number_tabs' => 'numberTabs', 'radio_group_tabs' => 'radioGroupTabs', 'sender_company_tabs' => 'senderCompanyTabs', 'sender_name_tabs' => 'senderNameTabs', 'ssn_tabs' => 'ssnTabs', 'tab_groups' => 'tabGroups', 'text_tabs' => 'textTabs', 'zip_tabs' => 'zipTabs']

$container

Associative array for storing property values

protected array<string|int, mixed> $container = []

$getters

Array of attributes to getter functions (for serialization of requests)

protected static array<string|int, string> $getters = ['checkbox_tabs' => 'getCheckboxTabs', 'date_tabs' => 'getDateTabs', 'email_tabs' => 'getEmailTabs', 'number_tabs' => 'getNumberTabs', 'radio_group_tabs' => 'getRadioGroupTabs', 'sender_company_tabs' => 'getSenderCompanyTabs', 'sender_name_tabs' => 'getSenderNameTabs', 'ssn_tabs' => 'getSsnTabs', 'tab_groups' => 'getTabGroups', 'text_tabs' => 'getTextTabs', 'zip_tabs' => 'getZipTabs']

$setters

Array of attributes to setter functions (for deserialization of responses)

protected static array<string|int, string> $setters = ['checkbox_tabs' => 'setCheckboxTabs', 'date_tabs' => 'setDateTabs', 'email_tabs' => 'setEmailTabs', 'number_tabs' => 'setNumberTabs', 'radio_group_tabs' => 'setRadioGroupTabs', 'sender_company_tabs' => 'setSenderCompanyTabs', 'sender_name_tabs' => 'setSenderNameTabs', 'ssn_tabs' => 'setSsnTabs', 'tab_groups' => 'setTabGroups', 'text_tabs' => 'setTextTabs', 'zip_tabs' => 'setZipTabs']

$swaggerFormats

Array of property to format mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerFormats = ['checkbox_tabs' => null, 'date_tabs' => null, 'email_tabs' => null, 'number_tabs' => null, 'radio_group_tabs' => null, 'sender_company_tabs' => null, 'sender_name_tabs' => null, 'ssn_tabs' => null, 'tab_groups' => null, 'text_tabs' => null, 'zip_tabs' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'prefillTabs'

$swaggerTypes

Array of property to type mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerTypes = ['checkbox_tabs' => '\\DocuSign\\eSign\\Model\\Checkbox[]', 'date_tabs' => '\\DocuSign\\eSign\\Model\\Date[]', 'email_tabs' => '\\DocuSign\\eSign\\Model\\Email[]', 'number_tabs' => '\\DocuSign\\eSign\\Model\\Number[]', 'radio_group_tabs' => '\\DocuSign\\eSign\\Model\\RadioGroup[]', 'sender_company_tabs' => '\\DocuSign\\eSign\\Model\\SenderCompany[]', 'sender_name_tabs' => '\\DocuSign\\eSign\\Model\\SenderName[]', 'ssn_tabs' => '\\DocuSign\\eSign\\Model\\Ssn[]', 'tab_groups' => '\\DocuSign\\eSign\\Model\\TabGroup[]', 'text_tabs' => '\\DocuSign\\eSign\\Model\\Text[]', 'zip_tabs' => '\\DocuSign\\eSign\\Model\\Zip[]']

Methods

__construct()

Constructor

public __construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
$data : array<string|int, mixed> = null

Associated array of property values initializing the model

Return values
mixed —

__toString()

Gets the string presentation of the object

public __toString() : string
Return values
string —

attributeMap()

Array of attributes where the key is the local name, and the value is the original name

public static attributeMap() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getCheckboxTabs()

Gets checkbox_tabs

public getCheckboxTabs() : array<string|int, Checkbox>
Return values
array<string|int, Checkbox> —

getDateTabs()

Gets date_tabs

public getDateTabs() : array<string|int, Date>
Return values
array<string|int, Date> —

getEmailTabs()

Gets email_tabs

public getEmailTabs() : array<string|int, Email>
Return values
array<string|int, Email> —

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getNumberTabs()

Gets number_tabs

public getNumberTabs() : array<string|int, Number>
Return values
array<string|int, Number> —

getSsnTabs()

Gets ssn_tabs

public getSsnTabs() : array<string|int, Ssn>
Return values
array<string|int, Ssn> —

getters()

Array of attributes to getter functions (for serialization of requests)

public static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getTextTabs()

Gets text_tabs

public getTextTabs() : array<string|int, Text>
Return values
array<string|int, Text> —

getZipTabs()

Gets zip_tabs

public getZipTabs() : array<string|int, Zip>
Return values
array<string|int, Zip> —

listInvalidProperties()

Show all the invalid properties with reasons.

public listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —

invalid properties with reasons

offsetExists()

Returns true if offset exists. False otherwise.

public offsetExists(int $offset) : bool
Parameters
$offset : int

Offset

Return values
bool —

offsetGet()

Gets offset.

public offsetGet(int $offset) : mixed
Parameters
$offset : int

Offset

Return values
mixed —

offsetSet()

Sets value based on offset.

public offsetSet(int $offset, mixed $value) : void
Parameters
$offset : int

Offset

$value : mixed

Value to be set

Return values
void —

offsetUnset()

Unsets offset.

public offsetUnset(int $offset) : void
Parameters
$offset : int

Offset

Return values
void —

setCheckboxTabs()

Sets checkbox_tabs

public setCheckboxTabs(array<string|int, Checkbox> $checkbox_tabs) : $this
Parameters
$checkbox_tabs : array<string|int, Checkbox>

Specifies a tag on the document in a location where the recipient can select an option.

Return values
$this —

setDateTabs()

Sets date_tabs

public setDateTabs(array<string|int, Date> $date_tabs) : $this
Parameters
$date_tabs : array<string|int, Date>

Specifies a tab on the document where you want the recipient to enter a date. Date tabs are single-line fields that allow date information to be entered in any format. The tooltip for this tab recommends entering the date as MM/DD/YYYY, but this is not enforced. The format entered by the signer is retained. If you need a particular date format enforced, DocuSign recommends using a Text tab with a Validation Pattern and Validation Message to enforce the format.

Return values
$this —

setEmailTabs()

Sets email_tabs

public setEmailTabs(array<string|int, Email> $email_tabs) : $this
Parameters
$email_tabs : array<string|int, Email>

Specifies a tag on the document where you want the recipient to enter an email. Email tags are single-line fields that accept any characters. The system checks that a valid email format (i.e. xxx@yyy.zzz) is entered in the tag. It uses the same parameters as a Text tab, with the validation message and pattern set for email information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.

Return values
$this —

setNumberTabs()

Sets number_tabs

public setNumberTabs(array<string|int, Number> $number_tabs) : $this
Parameters
$number_tabs : array<string|int, Number>

Specifies a tag on the document where you want the recipient to enter a number. It uses the same parameters as a Text tab, with the validation message and pattern set for number information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.

Return values
$this —

setRadioGroupTabs()

Sets radio_group_tabs

public setRadioGroupTabs(array<string|int, RadioGroup> $radio_group_tabs) : $this
Parameters
$radio_group_tabs : array<string|int, RadioGroup>

Specifies a tag on the document in a location where the recipient can select one option from a group of options using a radio button. The radio buttons do not have to be on the same page in a document.

Return values
$this —

setSenderCompanyTabs()

Sets sender_company_tabs

public setSenderCompanyTabs(array<string|int, SenderCompany> $sender_company_tabs) : $this
Parameters
$sender_company_tabs : array<string|int, SenderCompany>
Return values
$this —

setSenderNameTabs()

Sets sender_name_tabs

public setSenderNameTabs(array<string|int, SenderName> $sender_name_tabs) : $this
Parameters
$sender_name_tabs : array<string|int, SenderName>
Return values
$this —

setSsnTabs()

Sets ssn_tabs

public setSsnTabs(array<string|int, Ssn> $ssn_tabs) : $this
Parameters
$ssn_tabs : array<string|int, Ssn>

Specifies a tag on the document where you want the recipient to enter a Social Security Number (SSN). A SSN can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.

Return values
$this —

setTabGroups()

Sets tab_groups

public setTabGroups(array<string|int, TabGroup> $tab_groups) : $this
Parameters
$tab_groups : array<string|int, TabGroup>
Return values
$this —

setters()

Array of attributes to setter functions (for deserialization of responses)

public static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —

setTextTabs()

Sets text_tabs

public setTextTabs(array<string|int, Text> $text_tabs) : $this
Parameters
$text_tabs : array<string|int, Text>

Specifies a that that is an adaptable field that allows the recipient to enter different text information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.

Return values
$this —

setZipTabs()

Sets zip_tabs

public setZipTabs(array<string|int, Zip> $zip_tabs) : $this
Parameters
$zip_tabs : array<string|int, Zip>

Specifies a tag on the document where you want the recipient to enter a ZIP code. The ZIP code can be a five numbers or the ZIP+4 format with nine numbers. The zip code can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.

Return values
$this —

swaggerFormats()

Array of property to format mappings. Used for (de)serialization

public static swaggerFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —

swaggerTypes()

Array of property to type mappings. Used for (de)serialization

public static swaggerTypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —

valid()

Validate all the properties in the model return true if all passed

public valid() : bool
Return values
bool —

True if all properties are valid

Search results