new module:model/PrefillTabs()
- Source:
Constructs a new PrefillTabs.
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
Members
(inner) checkboxTabs :Array.<module:model/Checkbox>
- Source:
Specifies a tag on the document in a location where the recipient can select an option.
Type:
- Array.<module:model/Checkbox>
(inner) dateTabs :Array.<module:model/ModelDate>
- Source:
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.
Type:
- Array.<module:model/ModelDate>
(inner) emailTabs :Array.<module:model/Email>
- Source:
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.
Type:
- Array.<module:model/Email>
(inner) numberTabs :Array.<module:model/ModelNumber>
- Source:
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.
Type:
- Array.<module:model/ModelNumber>
(inner) radioGroupTabs :Array.<module:model/RadioGroup>
- Source:
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.
Type:
- Array.<module:model/RadioGroup>
(inner) senderCompanyTabs :Array.<module:model/SenderCompany>
- Source:
Type:
- Array.<module:model/SenderCompany>
(inner) senderNameTabs :Array.<module:model/SenderName>
- Source:
Type:
- Array.<module:model/SenderName>
(inner) ssnTabs :Array.<module:model/Ssn>
- Source:
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.
Type:
- Array.<module:model/Ssn>
(inner) tabGroups :Array.<module:model/TabGroup>
- Source:
Type:
- Array.<module:model/TabGroup>
(inner) textTabs :Array.<module:model/Text>
- Source:
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.
Type:
- Array.<module:model/Text>
(inner) zipTabs :Array.<module:model/Zip>
- Source:
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.
Type:
- Array.<module:model/Zip>
Methods
(static) constructFromObject(data, obj) → {module:model/PrefillTabs}
- Source:
Constructs a PrefillTabs from a plain JavaScript object, optionally creating a new instance.
Copies all relevant properties from data to obj if supplied or a new instance if not.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Object | The plain JavaScript object bearing properties of interest. |
obj |
module:model/PrefillTabs | Optional instance to populate. |
Returns:
The populated PrefillTabs instance.