| Package | Description |
|---|---|
| com.silanis.esl.sdk.builder |
Builder classes provide high-level support for creating model objects.
|
| Modifier and Type | Method and Description |
|---|---|
DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.disableFirstAffidavit() |
DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.disableSecondAffidavit() |
DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.enableFirstAffidavit() |
DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.enableSecondAffidavit() |
DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.hideOwnerInPersonDropDown()
Removes the owner of the package from the list of users, when switching users during an inPerson signing ceremony.
|
static DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.newDocumentPackageSettings() |
DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.showOwnerInPersonDropDown()
Displays the owner int the list of users, when switching users during an inPerson signing ceremony.
|
DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.withAda()
Enables the option for a signer to sign ADA documents.
|
DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.withCaptureText()
Enables the stamping documents with the date, time, and signer's name at each location they were signed.
|
DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.withCeremonyLayoutSettings(CeremonyLayoutSettings ceremonyLayoutSettings)
Set eSignLive signing ceremony branding and customization options.
|
DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.withCeremonyLayoutSettings(CeremonyLayoutSettingsBuilder ceremonyLayoutSettingsBuilder)
Set eSignLive signing ceremony branding and customization options.
|
DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.withDecline()
Enables the option for a signer to decline the signing ceremony as a whole.
|
DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.withDeclineOther()
Display an other option in decline reason
|
DocumentPackageSettingsBuilder |
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 |
DocumentPackageSettingsBuilder.withDefaultTimeBasedExpiry()
Use time based Expiry of package.
|
DocumentPackageSettingsBuilder |
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 |
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 |
DocumentPackageSettingsBuilder.withEnforceCaptureSignature()
Enforce capture signature
|
DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.withFontSize(Integer fontSize)
Sets the default font size for the package..
|
DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.withHandOverLinkAutoRedirect()
Set linkAutoredirect @see
#withHandOverLinkHref the signer will be automatically redirected to
the handover URL once signing is complete.
|
DocumentPackageSettingsBuilder |
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 |
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 |
DocumentPackageSettingsBuilder.withHandOverLinkText(String text)
Set the text to be displayed for the @see #withHandOverLinkHref.
|
DocumentPackageSettingsBuilder |
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 |
DocumentPackageSettingsBuilder.withInPerson()
Enables the participating signer to be changed during the signing
ceremony without resorting to emails or clicking on links.
|
DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.withLanguageDropDown() |
DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.withLeftMenuExpand()
Enables the option to expand the left menu.
|
DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.withMaxAttachmentFiles(Integer maxAttachmentFiles)
Sets the maximum number of uploads per attachment
|
DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.withOptOut()
Enables the option for a signer to decline signing electronically.
|
DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.withOptOutOther()
Display an other option in opt out reason
|
DocumentPackageSettingsBuilder |
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 |
DocumentPackageSettingsBuilder.withoutAda()
Disables the option for a signer to sign ADA documents.
|
DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.withoutCaptureText()
Disables the stamping documents with the date, time, and signer's name at each location they were signed.
|
DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.withoutDecline()
Disables the option for a signer to decline the signing ceremony as a whole.
|
DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.withoutDeclineOther()
Removes an other option in decline reason
|
DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.withoutDefaultTimeBasedExpiry()
Do not use time based Expiry of package.
|
DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.withoutDialogOnComplete()
Disables displaying the completion dialog after completing the signing ceremony.
|
DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.withoutDocumentToolbarDownloadButton()
Removes the download link that appears after the signer completed the signing ceremony
|
DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.withoutEnforceCaptureSignature()
Disable enforce capture signature
|
DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.withoutHandOverLinkAutoRedirect()
Set linkAutoredirect @see
#withHandOverLinkHref the signer will not be automatically redirected to
the handover URL.
|
DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.withoutInPerson()
Disables switching signer during the same signature session.
|
DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.withoutLanguageDropDown() |
DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.withoutLeftMenuExpand()
Disables the option to expand the left menu.
|
DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.withoutOptOut()
Disables the option for a signer to decline signing electronically.
|
DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.withoutOptOutOther()
Removes an other option in opt out reason
|
DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.withoutShowNseHelp()
Do not show NSE help.
|
DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.withoutShowNseLogoInIframe()
Do not show NSE Logo in iFrame.
|
DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.withoutShowNseOverview()
Do not show NSE Overview.
|
DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.withoutWatermark()
Disables the option to stamp the signed documents with the eSignLive logo at each location they were signed.
|
DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.withRemainingDays(Integer expireInDays)
Set the number of days since Creation date the package should expire
|
DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.withShowNseHelp()
Show NSE help.
|
DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.withShowNseLogoInIframe()
Show NSE Logo in iFrame Overview
|
DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.withShowNseOverview()
Show NSE Overview.
|
DocumentPackageSettingsBuilder |
DocumentPackageSettingsBuilder.withWatermark()
Enables the option to stamp the signed documents with the eSignLive logo at each location they were signed.
|
| Modifier and Type | Method and Description |
|---|---|
PackageBuilder |
PackageBuilder.withSettings(DocumentPackageSettingsBuilder builder)
Set the package configuration options such as options to opt-out, decline, watermark, etc...
|
Copyright 2022 OneSpan All rights reserved.