DocumentPackageSettingsBuilder (sdk 11.54 API)

java.lang.Object
- com.silanis.esl.sdk.builder.DocumentPackageSettingsBuilder

```
public class DocumentPackageSettingsBuilder
extends Object
```
Builder object used to customize the signing ceremony.
This object allows to customize the signing ceremony with certain UI widgets of customization options.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DocumentPackageSettings`	`build()` Builds the actual Field with the values specified.
`DocumentPackageSettingsBuilder`	`disableFirstAffidavit()`
`DocumentPackageSettingsBuilder`	`disableSecondAffidavit()`
`DocumentPackageSettingsBuilder`	`enableFirstAffidavit()`
`DocumentPackageSettingsBuilder`	`enableSecondAffidavit()`
`DocumentPackageSettingsBuilder`	`hideOwnerInPersonDropDown()` Removes the owner of the package from the list of users, when switching users during an inPerson signing ceremony.
`static DocumentPackageSettingsBuilder`	`newDocumentPackageSettings()`
`DocumentPackageSettingsBuilder`	`showOwnerInPersonDropDown()` Displays the owner int the list of users, when switching users during an inPerson signing ceremony.
`DocumentPackageSettingsBuilder`	`withAda()` Enables the option for a signer to sign ADA documents.
`DocumentPackageSettingsBuilder`	`withCaptureText()` Enables the stamping documents with the date, time, and signer's name at each location they were signed.
`DocumentPackageSettingsBuilder`	`withCeremonyLayoutSettings(CeremonyLayoutSettings ceremonyLayoutSettings)` Set eSignLive signing ceremony branding and customization options.
`DocumentPackageSettingsBuilder`	`withCeremonyLayoutSettings(CeremonyLayoutSettingsBuilder ceremonyLayoutSettingsBuilder)` Set eSignLive signing ceremony branding and customization options.
`DocumentPackageSettingsBuilder`	`withDecline()` Enables the option for a signer to decline the signing ceremony as a whole.
`DocumentPackageSettingsBuilder`	`withDeclineOther()` Display an other option in decline reason
`DocumentPackageSettingsBuilder`	`withDeclineReason(String reason)` Set a reason text that will be displayed to the signer when they click on the decline button, if this button is enabled.
`DocumentPackageSettingsBuilder`	`withDefaultTimeBasedExpiry()` Use time based Expiry of package.
`DocumentPackageSettingsBuilder`	`withDialogOnComplete()` Enables displaying the completion dialog, which asks the users whether they want to review the documents or leave the system, is shown to the signer after completing the signing ceremony.
`DocumentPackageSettingsBuilder`	`withDocumentToolbarDownloadButton()` Display a download button with a link to download the document in the toolbar above the document when all the signatures are completed
`DocumentPackageSettingsBuilder`	`withEnforceCaptureSignature()` Enforce capture signature
`DocumentPackageSettingsBuilder`	`withFontSize(Integer fontSize)` Sets the default font size for the package..
`DocumentPackageSettingsBuilder`	`withHandOverLinkAutoRedirect()` Set linkAutoredirect @see #withHandOverLinkHref the signer will be automatically redirected to the handover URL once signing is complete.
`DocumentPackageSettingsBuilder`	`withHandOverLinkHref(String href)` Enables adding a link on the signing ceremony page where the user will be sent after being shown the completion dialog box.
`DocumentPackageSettingsBuilder`	`withHandOverLinkParameters(Set<String> parameters)` Set linkParameters @see #withHandOverLinkHref defines which parameters to include in the handover URL If left empty, it means no parameters will be appended to the URL By default the 3 supported parameters will be appended: ["PACKAGE", "SIGNER", "STATUS"]
`DocumentPackageSettingsBuilder`	`withHandOverLinkText(String text)` Set the text to be displayed for the @see #withHandOverLinkHref.
`DocumentPackageSettingsBuilder`	`withHandOverLinkTooltip(String tooltip)` Set the text to be displayed for the @see #withHandOverLinkHref tool tip when the user over with the mouse over the handoverlink href.
`DocumentPackageSettingsBuilder`	`withInPerson()` Enables the participating signer to be changed during the signing ceremony without resorting to emails or clicking on links.
`DocumentPackageSettingsBuilder`	`withLanguageDropDown()`
`DocumentPackageSettingsBuilder`	`withLeftMenuExpand()` Enables the option to expand the left menu.
`DocumentPackageSettingsBuilder`	`withMaxAttachmentFiles(Integer maxAttachmentFiles)` Sets the maximum number of uploads per attachment
`DocumentPackageSettingsBuilder`	`withOptOut()` Enables the option for a signer to decline signing electronically.
`DocumentPackageSettingsBuilder`	`withOptOutOther()` Display an other option in opt out reason
`DocumentPackageSettingsBuilder`	`withOptOutReason(String reason)` Set a reason text that will be displayed to the signer when they click on the opt-out button, if this button is enabled.
`DocumentPackageSettingsBuilder`	`withoutAda()` Disables the option for a signer to sign ADA documents.
`DocumentPackageSettingsBuilder`	`withoutCaptureText()` Disables the stamping documents with the date, time, and signer's name at each location they were signed.
`DocumentPackageSettingsBuilder`	`withoutDecline()` Disables the option for a signer to decline the signing ceremony as a whole.
`DocumentPackageSettingsBuilder`	`withoutDeclineOther()` Removes an other option in decline reason
`DocumentPackageSettingsBuilder`	`withoutDefaultTimeBasedExpiry()` Do not use time based Expiry of package.
`DocumentPackageSettingsBuilder`	`withoutDialogOnComplete()` Disables displaying the completion dialog after completing the signing ceremony.
`DocumentPackageSettingsBuilder`	`withoutDocumentToolbarDownloadButton()` Removes the download link that appears after the signer completed the signing ceremony
`DocumentPackageSettingsBuilder`	`withoutEnforceCaptureSignature()` Disable enforce capture signature
`DocumentPackageSettingsBuilder`	`withoutHandOverLinkAutoRedirect()` Set linkAutoredirect @see #withHandOverLinkHref the signer will not be automatically redirected to the handover URL.
`DocumentPackageSettingsBuilder`	`withoutInPerson()` Disables switching signer during the same signature session.
`DocumentPackageSettingsBuilder`	`withoutLanguageDropDown()`
`DocumentPackageSettingsBuilder`	`withoutLeftMenuExpand()` Disables the option to expand the left menu.
`DocumentPackageSettingsBuilder`	`withoutOptOut()` Disables the option for a signer to decline signing electronically.
`DocumentPackageSettingsBuilder`	`withoutOptOutOther()` Removes an other option in opt out reason
`DocumentPackageSettingsBuilder`	`withoutShowNseHelp()` Do not show NSE help.
`DocumentPackageSettingsBuilder`	`withoutShowNseLogoInIframe()` Do not show NSE Logo in iFrame.
`DocumentPackageSettingsBuilder`	`withoutShowNseOverview()` Do not show NSE Overview.
`DocumentPackageSettingsBuilder`	`withoutWatermark()` Disables the option to stamp the signed documents with the eSignLive logo at each location they were signed.
`DocumentPackageSettingsBuilder`	`withRemainingDays(Integer expireInDays)` Set the number of days since Creation date the package should expire
`DocumentPackageSettingsBuilder`	`withShowNseHelp()` Show NSE help.
`DocumentPackageSettingsBuilder`	`withShowNseLogoInIframe()` Show NSE Logo in iFrame Overview
`DocumentPackageSettingsBuilder`	`withShowNseOverview()` Show NSE Overview.
`DocumentPackageSettingsBuilder`	`withWatermark()` Enables the option to stamp the signed documents with the eSignLive logo at each location they were signed.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - newDocumentPackageSettings
```
public static DocumentPackageSettingsBuilder newDocumentPackageSettings()
```
  - showOwnerInPersonDropDown
```
public DocumentPackageSettingsBuilder showOwnerInPersonDropDown()
```
    Displays the owner int the list of users, when switching users during an inPerson signing ceremony.
    
    Returns:
    
    This
  - hideOwnerInPersonDropDown
```
public DocumentPackageSettingsBuilder hideOwnerInPersonDropDown()
```
    Removes the owner of the package from the list of users, when switching users during an inPerson signing ceremony.
  - withLanguageDropDown
```
public DocumentPackageSettingsBuilder withLanguageDropDown()
```
  - withoutLanguageDropDown
```
public DocumentPackageSettingsBuilder withoutLanguageDropDown()
```
  - enableFirstAffidavit
```
public DocumentPackageSettingsBuilder enableFirstAffidavit()
```
  - disableFirstAffidavit
```
public DocumentPackageSettingsBuilder disableFirstAffidavit()
```
  - enableSecondAffidavit
```
public DocumentPackageSettingsBuilder enableSecondAffidavit()
```
  - disableSecondAffidavit
```
public DocumentPackageSettingsBuilder disableSecondAffidavit()
```
  - withDialogOnComplete
```
public DocumentPackageSettingsBuilder withDialogOnComplete()
```
    Enables displaying the completion dialog, which asks the users whether they want to review the documents or leave the system, is shown to the signer after completing the signing ceremony.
    DEFAULT: ENABLED
    
    Returns:
    
    This
  - withoutDialogOnComplete
```
public DocumentPackageSettingsBuilder withoutDialogOnComplete()
```
    Disables displaying the completion dialog after completing the signing ceremony.
    
    Returns:
    
    This
    
    See Also:
    
    withDialogOnComplete()
  - withInPerson
```
public DocumentPackageSettingsBuilder withInPerson()
```
    Enables the participating signer to be changed during the signing ceremony without resorting to emails or clicking on links. This setting is typically used when two or more signers (e.g.: an Agent and a customer, for example) share the same device (e.g.: the Agent's computer) to sign a document.
    DEFAULT: ENABLED
    
    Returns:
    
    This
  - withoutInPerson
```
public DocumentPackageSettingsBuilder withoutInPerson()
```
    Disables switching signer during the same signature session.
    
    Returns:
    
    This
    
    See Also:
    
    withInPerson()
  - withOptOut
```
public DocumentPackageSettingsBuilder withOptOut()
```
    Enables the option for a signer to decline signing electronically.
    DEFAULT: ENABLED
    
    Returns:
    
    This
  - withoutOptOut
```
public DocumentPackageSettingsBuilder withoutOptOut()
```
    Disables the option for a signer to decline signing electronically.
    
    Returns:
    
    This
    
    See Also:
    
    withOptOut()
  - withDecline
```
public DocumentPackageSettingsBuilder withDecline()
```
    Enables the option for a signer to decline the signing ceremony as a whole.
    DEFAULT: ENABLED
    
    Returns:
    
    This
  - withoutDecline
```
public DocumentPackageSettingsBuilder withoutDecline()
```
    Disables the option for a signer to decline the signing ceremony as a whole.
    
    Returns:
    
    This
    
    See Also:
    
    withDecline()
  - withLeftMenuExpand
```
public DocumentPackageSettingsBuilder withLeftMenuExpand()
```
    Enables the option to expand the left menu.
    DEFAULT: DISABLED
    
    Returns:
    
    This
  - withoutLeftMenuExpand
```
public DocumentPackageSettingsBuilder withoutLeftMenuExpand()
```
    Disables the option to expand the left menu.
    
    Returns:
    
    This
    
    See Also:
    
    withLeftMenuExpand()
  - withWatermark
```
public DocumentPackageSettingsBuilder withWatermark()
```
    Enables the option to stamp the signed documents with the eSignLive logo at each location they were signed.
    DEFAULT: ENABLED
    
    Returns:
    
    This
  - withoutWatermark
```
public DocumentPackageSettingsBuilder withoutWatermark()
```
    Disables the option to stamp the signed documents with the eSignLive logo at each location they were signed.
    
    Returns:
    
    This
    
    See Also:
    
    withWatermark()
  - withCaptureText
```
public DocumentPackageSettingsBuilder withCaptureText()
```
    Enables the stamping documents with the date, time, and signer's name at each location they were signed.
    DEFAULT: DISABLED
    
    Returns:
    
    This
  - withoutCaptureText
```
public DocumentPackageSettingsBuilder withoutCaptureText()
```
    Disables the stamping documents with the date, time, and signer's name at each location they were signed.
    DEFAULT: DISABLED
    
    Returns:
    
    This
  - withAda
```
public DocumentPackageSettingsBuilder withAda()
```
    Enables the option for a signer to sign ADA documents.
    DEFAULT: ENABLED
    
    Returns:
    
    This
  - withoutAda
```
public DocumentPackageSettingsBuilder withoutAda()
```
    Disables the option for a signer to sign ADA documents.
    DEFAULT: DISABLED
    
    Returns:
    
    This
  - withFontSize
```
public DocumentPackageSettingsBuilder withFontSize(Integer fontSize)
```
    Sets the default font size for the package..
    DEFAULT: null
    
    Returns:
    
    This
  - withHandOverLinkHref
```
public DocumentPackageSettingsBuilder withHandOverLinkHref(String href)
```
    Enables adding a link on the signing ceremony page where the user will be sent after being shown the completion dialog box. Replaces the continue button during the signing ceremony. Use the LinkBuilder class to create one.
    DEFAULT: DISABLED
    
    Parameters:
    
    href - URL to where the user will be redirected upon clicking on the link. @size(max="255")
    
    Returns:
    
    This
  - withHandOverLinkText
```
public DocumentPackageSettingsBuilder withHandOverLinkText(String text)
```
    Set the text to be displayed for the @see #withHandOverLinkHref.
    DEFAULT: DISABLED
    
    Parameters:
    
    text - text displayed to represent the handoverlink href on the eSignLive UI. @size(max="255")
    
    Returns:
    
    This
    
    See Also:
    
    withHandOverLinkHref(String)
  - withDefaultTimeBasedExpiry
```
public DocumentPackageSettingsBuilder withDefaultTimeBasedExpiry()
```
    Use time based Expiry of package. If enabled, set the number of days #withRemainingDays since pacakge creation date the package should expire.
    
    Returns:
    
    This
    
    See Also:
    
    withDefaultTimeBasedExpiry()
  - withoutDefaultTimeBasedExpiry
```
public DocumentPackageSettingsBuilder withoutDefaultTimeBasedExpiry()
```
    Do not use time based Expiry of package.
    
    Returns:
    
    This
    
    See Also:
    
    withoutDefaultTimeBasedExpiry()
  - withRemainingDays
```
public DocumentPackageSettingsBuilder withRemainingDays(Integer expireInDays)
```
    Set the number of days since Creation date the package should expire
    
    Parameters:
    
    expireInDays - Number of Days from Package Creation Date. @size(max="999")
    
    Returns:
    
    This
    
    See Also:
    
    withDefaultTimeBasedExpiry()
  - withShowNseHelp
```
public DocumentPackageSettingsBuilder withShowNseHelp()
```
    Show NSE help.
    
    Returns:
    
    This
  - withoutShowNseHelp
```
public DocumentPackageSettingsBuilder withoutShowNseHelp()
```
    Do not show NSE help.
    
    Returns:
    
    This
  - withHandOverLinkTooltip
```
public DocumentPackageSettingsBuilder withHandOverLinkTooltip(String tooltip)
```
    Set the text to be displayed for the @see #withHandOverLinkHref tool tip when the user over with the mouse over the handoverlink href.
    DEFAULT: DISABLED
    
    Parameters:
    
    tooltip - text displayed to represent the handoverlink href tool tip on the eSignLive UI. @size(max="255")
    
    Returns:
    
    This
    
    See Also:
    
    withHandOverLinkHref(String)
  - withHandOverLinkAutoRedirect
```
public DocumentPackageSettingsBuilder withHandOverLinkAutoRedirect()
```
    Set linkAutoredirect @see #withHandOverLinkHref the signer will be automatically redirected to the handover URL once signing is complete.
    
    Returns:
    
    This
    
    See Also:
    
    withHandOverLinkHref(String)
  - withoutHandOverLinkAutoRedirect
```
public DocumentPackageSettingsBuilder withoutHandOverLinkAutoRedirect()
```
    Set linkAutoredirect @see #withHandOverLinkHref the signer will not be automatically redirected to the handover URL.
    
    Returns:
    
    This
    
    See Also:
    
    withHandOverLinkHref(String)
  - withHandOverLinkParameters
```
public DocumentPackageSettingsBuilder withHandOverLinkParameters(Set<String> parameters)
```
    Set linkParameters @see #withHandOverLinkHref defines which parameters to include in the handover URL If left empty, it means no parameters will be appended to the URL By default the 3 supported parameters will be appended: ["PACKAGE", "SIGNER", "STATUS"]
    
    Parameters:
    
    parameters -
    
    Returns:
    
    This
    
    See Also:
    
    withHandOverLinkHref(String)
  - withCeremonyLayoutSettings
```
public DocumentPackageSettingsBuilder withCeremonyLayoutSettings(CeremonyLayoutSettingsBuilder ceremonyLayoutSettingsBuilder)
```
    Set eSignLive signing ceremony branding and customization options.
    
    Parameters:
    
    ceremonyLayoutSettingsBuilder -
    
    Returns:
    
    This
  - withCeremonyLayoutSettings
```
public DocumentPackageSettingsBuilder withCeremonyLayoutSettings(CeremonyLayoutSettings ceremonyLayoutSettings)
```
    Set eSignLive signing ceremony branding and customization options.
    
    Parameters:
    
    ceremonyLayoutSettings -
    
    Returns:
    
    This
  - withMaxAttachmentFiles
```
public DocumentPackageSettingsBuilder withMaxAttachmentFiles(Integer maxAttachmentFiles)
```
    Sets the maximum number of uploads per attachment
    DEFAULT: null
    
    Returns:
    
    This
  - withShowNseOverview
```
public DocumentPackageSettingsBuilder withShowNseOverview()
```
    Show NSE Overview.
    
    Returns:
    
    This
  - withoutShowNseOverview
```
public DocumentPackageSettingsBuilder withoutShowNseOverview()
```
    Do not show NSE Overview.
    
    Returns:
    
    This
  - withShowNseLogoInIframe
```
public DocumentPackageSettingsBuilder withShowNseLogoInIframe()
```
    Show NSE Logo in iFrame Overview
    
    Returns:
    
    This
  - withoutShowNseLogoInIframe
```
public DocumentPackageSettingsBuilder withoutShowNseLogoInIframe()
```
    Do not show NSE Logo in iFrame.
    
    Returns:
    
    This
  - build
```
public DocumentPackageSettings build()
```
    Builds the actual Field with the values specified.
    
    Returns:
    
    the built DocumentPackageSettings
  - withDeclineReason
```
public DocumentPackageSettingsBuilder withDeclineReason(String reason)
```
    Set a reason text that will be displayed to the signer when they click on the decline button, if this button is enabled. There can be multiple reasons and this method can be invoked multiple times to add different reasons.
    
    Parameters:
    
    reason - @size(max="255")
    
    Returns:
    
    This
  - withOptOutReason
```
public DocumentPackageSettingsBuilder withOptOutReason(String reason)
```
    Set a reason text that will be displayed to the signer when they click on the opt-out button, if this button is enabled. There can be multiple reasons and this method can be invoked multiple times to add different reasons.
    
    Parameters:
    
    reason - @size(max="255")
    
    Returns:
    
    This
    
    See Also:
    
    withOptOut()
  - withDocumentToolbarDownloadButton
```
public DocumentPackageSettingsBuilder withDocumentToolbarDownloadButton()
```
    Display a download button with a link to download the document in the toolbar above the document when all the signatures are completed
    DEFAULT: ENABLED
    
    Returns:
    
    This
  - withoutDocumentToolbarDownloadButton
```
public DocumentPackageSettingsBuilder withoutDocumentToolbarDownloadButton()
```
    Removes the download link that appears after the signer completed the signing ceremony
    
    Returns:
    
    This
    
    See Also:
    
    withDocumentToolbarDownloadButton()
  - withDeclineOther
```
public DocumentPackageSettingsBuilder withDeclineOther()
```
    Display an other option in decline reason
    DEFAULT: ENABLED
    
    Returns:
    
    This
  - withoutDeclineOther
```
public DocumentPackageSettingsBuilder withoutDeclineOther()
```
    Removes an other option in decline reason
    
    Returns:
    
    This
    
    See Also:
    
    withDeclineOther()
  - withOptOutOther
```
public DocumentPackageSettingsBuilder withOptOutOther()
```
    Display an other option in opt out reason
    DEFAULT: ENABLED
    
    Returns:
    
    This
  - withoutOptOutOther
```
public DocumentPackageSettingsBuilder withoutOptOutOther()
```
    Removes an other option in opt out reason
    
    Returns:
    
    This
    
    See Also:
    
    withOptOutOther()
  - withEnforceCaptureSignature
```
public DocumentPackageSettingsBuilder withEnforceCaptureSignature()
```
    Enforce capture signature
    DEFAULT: DISABLED
    
    Returns:
    
    This
  - withoutEnforceCaptureSignature
```
public DocumentPackageSettingsBuilder withoutEnforceCaptureSignature()
```
    Disable enforce capture signature
    
    Returns:
    
    This
    
    See Also:
    
    withOptOutOther()

Class DocumentPackageSettingsBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

newDocumentPackageSettings

showOwnerInPersonDropDown

hideOwnerInPersonDropDown

withLanguageDropDown

withoutLanguageDropDown

enableFirstAffidavit

disableFirstAffidavit

enableSecondAffidavit

disableSecondAffidavit

withDialogOnComplete

withoutDialogOnComplete

withInPerson

withoutInPerson

withOptOut

withoutOptOut

withDecline

withoutDecline

withLeftMenuExpand

withoutLeftMenuExpand

withWatermark

withoutWatermark

withCaptureText

withoutCaptureText

withAda

withoutAda

withFontSize

withHandOverLinkHref

withHandOverLinkText

withDefaultTimeBasedExpiry

withoutDefaultTimeBasedExpiry

withRemainingDays

withShowNseHelp

withoutShowNseHelp

withHandOverLinkTooltip

withHandOverLinkAutoRedirect

withoutHandOverLinkAutoRedirect

withHandOverLinkParameters

withCeremonyLayoutSettings

withCeremonyLayoutSettings

withMaxAttachmentFiles

withShowNseOverview

withoutShowNseOverview

withShowNseLogoInIframe

withoutShowNseLogoInIframe

build

withDeclineReason

withOptOutReason

withDocumentToolbarDownloadButton

withoutDocumentToolbarDownloadButton

withDeclineOther

withoutDeclineOther

withOptOutOther

withoutOptOutOther

withEnforceCaptureSignature

withoutEnforceCaptureSignature