| Package | Description |
|---|---|
| com.silanis.esl.sdk.internal |
For internal use only.
|
| com.silanis.esl.sdk.service |
Service classes provide low-level support for interacting with eSignLive.
|
| com.silanis.esl.sdk.service.apiclient |
| Modifier and Type | Class and Description |
|---|---|
class |
EslServerException |
| Modifier and Type | Method and Description |
|---|---|
Placeholder |
TemplateService.addPlaceholder(PackageId templateId,
Placeholder placeholder)
Adds a placeholder to the template.
|
Role |
PackageService.addRole(PackageId packageId,
Role role)
Adds a role to the package.
|
String |
ApprovalService.addSignature(DocumentPackage sdkPackage,
String documentId,
Signature signature)
Add a signature to a document
|
void |
PackageService.changePackageStatusToDraft(PackageId packageId)
Change the package's status to DRAFT.
|
void |
PackageService.configureDocumentVisibility(PackageId packageId,
DocumentVisibility visibility)
Configure a document visibility.
|
PackageId |
PackageService.createPackage(Package aPackage)
Creates a package with roles.
|
PackageId |
PackageService.createPackageOneStep(Package aPackage,
Collection<Document> documents)
Creates a package and uploads the documents in one step
|
SessionToken |
SessionService.createSenderSessionToken() |
SessionToken |
SessionService.createSessionToken(String packageId,
String signerId)
Creates a session token for a signer and returns the session token.
|
Verification |
SignerVerificationService.createSignerVerification(String packageId,
String roleId,
Verification verification) |
void |
PackageService.deleteDocument(PackageId packageId,
String documentId)
Deletes the document from the package.
|
void |
PackageService.deleteDocuments(PackageId packageId,
DocumentId... documentIds)
Deletes the documents from the package.
|
void |
PackageService.deleteRole(PackageId packageId,
Role role)
Deletes a role from the package.
|
void |
ApprovalService.deleteSignature(PackageId packageId,
String documentId,
SignatureId signatureId)
Delete a signature from a document
|
void |
SignerVerificationService.deleteSignerVerification(String packageId,
String roleId) |
byte[] |
PackageService.downloadDocument(PackageId packageId,
Document document)
Downloads a document from the package and returns a byte[].
|
byte[] |
PackageService.downloadDocument(PackageId packageId,
String documentId) |
byte[] |
PackageService.downloadEvidenceSummary(PackageId packageId)
Downloads the evidence summary (in PDF) from the package and returns a byte[].
|
byte[] |
PackageService.downloadOriginalDocument(PackageId packageId,
String documentId)
Downloads the original document (without fields) from the package and returns a byte[].
|
byte[] |
PackageService.downloadZippedDocuments(PackageId packageId)
Downloads the documents (in a zip archive) from the package and returns a byte[].
|
List<Signature> |
ApprovalService.getAllSignableSignatures(DocumentPackage sdkPackage,
String documentId,
String signerId)
Get all signable signatures
|
Package |
PackageService.getApiPackage(String packageId)
Gets the package.
|
List<Audit> |
AuditService.getAudit(PackageId packageId)
Gets the audit trail for a package and returns a list of audits.
|
DocumentVisibility |
PackageService.getDocumentVisibility(PackageId packageId)
Get a document visibility.
|
List<FieldSummary> |
FieldSummaryService.getFieldSummary(PackageId packageId)
Gets the field summary for the package and returns a list of field summaries.
|
List<Role> |
PackageService.getRoles(PackageId packageId)
Gets the roles for a package.
|
Signature |
ApprovalService.getSignature(DocumentPackage sdkPackage,
String documentId,
SignatureId signatureId)
Get a signature from a document
|
Verification |
SignerVerificationService.getSignerVerification(String packageId,
String roleId) |
void |
ApprovalService.modifySignature(DocumentPackage sdkPackage,
String documentId,
Signature signature)
Update a signature from a document
|
void |
PackageService.sendPackage(PackageId packageId)
Sends the package.
|
void |
PackageService.updatePackage(PackageId packageId,
DocumentPackage sdkPackage)
Updates the package's fields and roles.
|
Placeholder |
TemplateService.updatePlaceholder(PackageId templateId,
Placeholder placeholder)
Update a placeholder.
|
Role |
PackageService.updateRole(PackageId packageId,
Role role)
Updates a role from the package.
|
Verification |
SignerVerificationService.updateSignerVerification(String packageId,
String roleId,
Verification verification) |
Document |
PackageService.uploadDocument(PackageId packageId,
String fileName,
byte[] fileBytes,
Document document)
Uploads the Document and file in byte[] to the package.
|
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.
|
| Modifier and Type | Method and Description |
|---|---|
Approval |
ApprovalApiClient.addSignature(String packageId,
String documentId,
Approval approval) |
CustomField |
CustomFieldApiClient.createCustomField(CustomField customField) |
void |
ApprovalApiClient.deleteSignature(String packageId,
String documentId,
String signatureId) |
void |
CustomFieldApiClient.deleteUserCustomField(String id) |
String |
AuditApiClient.getAudit(String packageId) |
Approval |
ApprovalApiClient.getSignature(String packageId,
String documentId,
String approvalId) |
List<UserCustomField> |
CustomFieldApiClient.getUserCustomFields() |
void |
ApprovalApiClient.modifySignature(String packageId,
String documentId,
Approval approval) |
UserCustomField |
CustomFieldApiClient.submitCustomFieldValue(UserCustomField userCustomField) |
Copyright 2022 OneSpan All rights reserved.