| Package | Description |
|---|---|
| com.silanis.esl.sdk |
The eSignLive Java SDK base package containing the EslClient and model classes.
|
| com.silanis.esl.sdk.builder |
Builder classes provide high-level support for creating model objects.
|
| com.silanis.esl.sdk.examples |
Examples and helper classes of how to use the eSignLive Java SDK.
|
| com.silanis.esl.sdk.internal.converter |
For internal use only.
|
| com.silanis.esl.sdk.service |
Service classes provide low-level support for interacting with eSignLive.
|
| Modifier and Type | Method and Description |
|---|---|
DocumentPackage |
EslClient.getPackage(PackageId packageId) |
| Modifier and Type | Method and Description |
|---|---|
PackageId |
EslClient.createAndSendPackage(DocumentPackage documentPackage)
Creates a new packages, and immediately sends it to be signed.
|
PackageId |
EslClient.createPackage(DocumentPackage documentPackage)
Creates the package.
|
PackageId |
EslClient.createPackageFromTemplate(DocumentPackage documentPackage,
PackageId packageId)
Deprecated.
Please use createPackageFromTemplate( PackageId packageId, DocumentPackage documentPackage ) instead of this method.
|
PackageId |
EslClient.createPackageFromTemplate(PackageId packageId,
DocumentPackage documentPackage)
Creates a package based on an existent template
|
PackageId |
EslClient.createPackageOneStep(DocumentPackage documentPackage)
Creates the package in one step
WARNING: DOES NOT WORK WHEN SENDER HAS A SIGNATURE
|
List<Document> |
DocumentVisibility.getDocuments(DocumentPackage documentPackage,
String signerId) |
List<Signer> |
DocumentVisibility.getSigners(DocumentPackage documentPackage,
String documentId) |
void |
EslClient.updatePackage(PackageId packageId,
DocumentPackage documentPackage)
Update the package, when the package status is only Draft
|
Document |
EslClient.uploadDocument(Document document,
DocumentPackage documentPackage)
Deprecated.
Please use uploadDocument(Document document, PackageId packageId) instead of this method.
|
Document |
EslClient.uploadDocument(String fileName,
byte[] fileContent,
Document document,
DocumentPackage documentPackage)
Deprecated.
Please use uploadDocument(String fileName, byte[] fileContent, Document document, PackageId packageId) instead of this method.
|
| Modifier and Type | Method and Description |
|---|---|
DocumentPackage |
PackageBuilder.build()
Builds the actual document package.
|
| Modifier and Type | Field and Description |
|---|---|
Page<DocumentPackage> |
GetCompletedPackagesWithinDateRangeExample.archivedPackages |
Page<DocumentPackage> |
GetCompletedPackagesWithinDateRangeExample.completedPackages |
Page<DocumentPackage> |
GetCompletedPackagesWithinDateRangeExample.declinedPackages |
Page<DocumentPackage> |
GetCompletedPackagesWithinDateRangeExample.draftPackages |
List<DocumentPackage> |
DocumentLayoutExample.layouts |
Page<DocumentPackage> |
GetCompletedPackagesWithinDateRangeExample.sentPackages |
| Modifier and Type | Method and Description |
|---|---|
protected DocumentPackage |
SDKSample.getRetrievedPackage() |
DocumentPackage |
TemplateExample.getRetrievedTemplate() |
| Modifier and Type | Method and Description |
|---|---|
List<DocumentPackage> |
ListTemplatesExample.getTemplates() |
| Modifier and Type | Method and Description |
|---|---|
DocumentPackage |
DocumentPackageConverter.toSDKPackage()
Convert from API to SDK.
|
| Constructor and Description |
|---|
DocumentPackageConverter(DocumentPackage sdkPackage)
Construct with SDK object involved in conversion.
|
| Modifier and Type | Method and Description |
|---|---|
DocumentPackage |
LayoutService.createAndGetLayout(DocumentPackage layout)
Create and get a layout from an already created DocumentPackage.
|
DocumentPackage |
PackageService.getPackage(PackageId packageId) |
| Modifier and Type | Method and Description |
|---|---|
List<DocumentPackage> |
LayoutService.getLayouts(Direction direction,
PageRequest request)
Get a list of layouts (DocumentPackages).
|
Page<DocumentPackage> |
PackageService.getPackages(String status,
PageRequest request)
Returns a Page of DocumentPackages, which represents a paginated query response.
|
Page<DocumentPackage> |
PackageService.getTemplates(PageRequest request) |
Page<DocumentPackage> |
PackageService.getTemplates(PageRequest request,
Visibility visibility) |
Page<DocumentPackage> |
PackageService.getUpdatedPackagesWithinDateRange(PackageStatus status,
PageRequest request,
Date from,
Date to)
Returns a Page of DocumentPackages, that last updated in time range, which represents a paginated query response.
|
| Modifier and Type | Method and Description |
|---|---|
String |
ApprovalService.addSignature(DocumentPackage sdkPackage,
String documentId,
Signature signature)
Add a signature to a document
|
DocumentPackage |
LayoutService.createAndGetLayout(DocumentPackage layout)
Create and get a layout from an already created DocumentPackage.
|
String |
LayoutService.createLayout(DocumentPackage layout)
Create a document layout from an already created DocumentPackage.
|
PackageId |
TemplateService.createPackageFromTemplate(DocumentPackage documentPackage,
PackageId packageId)
Deprecated.
Please use createPackageFromTemplate( PackageId packageId, DocumentPackage documentPackage ) instead of this method.
|
PackageId |
TemplateService.createPackageFromTemplate(PackageId packageId,
DocumentPackage documentPackage)
Creates a package based on an existent template.
|
PackageId |
TemplateService.createTemplate(DocumentPackage template)
Creates a template.
|
PackageId |
TemplateService.createTemplateFromPackage(PackageId originalPackageId,
DocumentPackage delta)
Creates a template from package.
|
DownloadedFile |
AttachmentRequirementService.downloadAllAttachmentFilesForSignerInPackage(DocumentPackage sdkPackage,
Signer signer)
Sender downloads all attachment files with file name for the signer in the package.
|
byte[] |
AttachmentRequirementService.downloadAllAttachmentsForSignerInPackage(DocumentPackage sdkPackage,
Signer signer)
Deprecated.
|
List<Signature> |
ApprovalService.getAllSignableSignatures(DocumentPackage sdkPackage,
String documentId,
String signerId)
Get all signable signatures
|
Document |
PackageService.getDocumentMetadata(DocumentPackage documentPackage,
String documentId)
Get the document's metadata from the package.
|
Signature |
ApprovalService.getSignature(DocumentPackage sdkPackage,
String documentId,
SignatureId signatureId)
Get a signature from a document
|
void |
ApprovalService.modifySignature(DocumentPackage sdkPackage,
String documentId,
Signature signature)
Update a signature from a document
|
void |
PackageService.orderDocuments(DocumentPackage documentPackage)
Updates the documents signing order
|
void |
PackageService.orderSigners(DocumentPackage documentPackage)
Updates the signer order in a package.
|
void |
PackageService.updateDocumentMetadata(DocumentPackage documentPackage,
Document document)
Updates the document's metadata from the package.
|
void |
PackageService.updatePackage(PackageId packageId,
DocumentPackage sdkPackage)
Updates the package's fields and roles.
|
void |
ApprovalService.updateSignatures(DocumentPackage sdkPackage,
String documentId,
List<Signature> signatureList)
Update all the signatures for a document
|
void |
TemplateService.updateTemplate(DocumentPackage template)
Update a template.
|
Document |
PackageService.uploadDocument(PackageId packageId,
String fileName,
byte[] fileBytes,
Document document,
DocumentPackage documentPackage)
Deprecated.
Please use uploadDocument(PackageId packageId, String fileName, byte[] fileBytes, com.silanis.esl.sdk.Document document) instead of this method.
|
Copyright 2022 OneSpan All rights reserved.