Uses of Class
com.silanis.esl.sdk.PackageId

Packages that use PackageId

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.service	Service classes provide low-level support for interacting with eSignLive.
com.silanis.esl.sdk.service.apiclient

Uses of PackageId in com.silanis.esl.sdk

Methods in com.silanis.esl.sdk that return 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
PackageId	DocumentPackage.getId()
PackageId	ReminderSchedule.getPackageId()

Methods in com.silanis.esl.sdk with parameters of type PackageId

Modifier and Type	Method and Description
void	EslClient.changePackageStatusToDraft(PackageId packageId) Change the package's status from SENT to DRAFT.
void	EslClient.configureDocumentVisibility(PackageId packageId, DocumentVisibility visibility) Configure the document visibility.
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
SessionToken	EslClient.createSessionToken(PackageId packageId, String signerId) Deprecated. Use the AuthenticationTokensService.createSignerAuthenticationToken(java.lang.String, java.lang.String).
SessionToken	EslClient.createSignerSessionToken(PackageId packageId, String signerId) Deprecated. Use the AuthenticationTokensService.createSignerAuthenticationToken(java.lang.String, java.lang.String).
void	EslClient.createSignerVerification(PackageId packageId, String roleId, SignerVerification signerVerification)
void	EslClient.deleteAttachmentFile(PackageId packageId, String attachmentId, Integer fileId, String signerId)
void	EslClient.deleteSignerVerification(PackageId packageId, String roleId)
byte[]	EslClient.downloadDocument(PackageId packageId, String documentId) Downloads a document that belongs to a package
byte[]	EslClient.downloadEvidenceSummary(PackageId packageId) Downloads the evidence summary for a package
byte[]	EslClient.downloadOriginalDocument(PackageId packageId, String documentId) Downloads an original document that belongs to a package.
byte[]	EslClient.downloadZippedDocuments(PackageId packageId) Downloads the zipped documents of a package
List<Document>	EslClient.getDocuments(PackageId packageId, String signerId)
DocumentVisibility	EslClient.getDocumentVisibility(PackageId packageId) Get document visibility.
List<FieldSummary>	EslClient.getFieldValues(PackageId packageId) Retrieves a summary for all the document fields of the package identified by its packageId
DocumentPackage	EslClient.getPackage(PackageId packageId)
List<Signer>	EslClient.getSigners(PackageId packageId, String documentId)
SignerVerification	EslClient.getSignerVerification(PackageId packageId, String roleId)
SigningStatus	EslClient.getSigningStatus(PackageId packageId, SignerId signerId, DocumentId documentId)
void	EslClient.sendPackage(PackageId id) It does the followings for the package ID specified as argument:
void	DocumentPackage.setId(PackageId id)
void	ReminderSchedule.setPackageId(PackageId packageId)
void	EslClient.signDocument(PackageId packageId, String documentName) Sign a document using current api key
void	EslClient.signDocument(PackageId packageId, String documentName, CapturedSignature capturedSignature) Sign a document using current api key
void	EslClient.signDocuments(PackageId packageId) Sign documents using current api key
void	EslClient.signDocuments(PackageId packageId, CapturedSignature capturedSignature) Sign documents using current api key
void	EslClient.signDocuments(PackageId packageId, String signerId) Sign documents using signer id
void	EslClient.signDocuments(PackageId packageId, String signerId, CapturedSignature capturedSignature) Sign documents using signer id
void	EslClient.updatePackage(PackageId packageId, DocumentPackage documentPackage) Update the package, when the package status is only Draft
void	EslClient.updateSignerVerification(PackageId packageId, String roleId, SignerVerification signerVerification)
void	EslClient.uploadAttachment(PackageId packageId, String attachmentId, Map<String,byte[]> files, String signerId)
void	EslClient.uploadAttachment(PackageId packageId, String attachmentId, String filename, byte[] fileContent, String signerId)
Document	EslClient.uploadDocument(Document document, PackageId packageId)
Document	EslClient.uploadDocument(String fileName, byte[] fileContent, Document document, PackageId packageId)
List<Document>	EslClient.uploadDocuments(PackageId packageId, Document... documents)
List<Document>	EslClient.uploadDocuments(PackageId packageId, List<Document> documents)

Uses of PackageId in com.silanis.esl.sdk.builder

Methods in com.silanis.esl.sdk.builder with parameters of type PackageId

Modifier and Type	Method and Description
static ReminderScheduleBuilder	ReminderScheduleBuilder.forPackageWithId(PackageId packageId) Defines a new email reminder schedule for a given package.
PackageBuilder	PackageBuilder.withID(PackageId id) Deprecated. Please do not use withID() from now on. Will get deleted in a future release

Uses of PackageId in com.silanis.esl.sdk.examples

Fields in com.silanis.esl.sdk.examples declared as PackageId

Modifier and Type	Field and Description
PackageId	TemplateExample.instantiatedTemplateId
PackageId	DownloadReportExample.package2Id
protected PackageId	SDKSample.packageId
PackageId	CreateTemplateOnBehalfOfAnotherSenderExample.templateId
PackageId	CreateTemplateExample.templateId
PackageId	ListTemplatesExample.templateId
PackageId	CreatePackageFromTemplateWithReplacingPlaceholderExample.templateId
PackageId	CreateTemplateFromPackageExample.templateId
PackageId	TemplateExample.templateId
PackageId	CreateSenderTemplateExample.templateId
PackageId	UpdateTemplateWithPlaceholderExample.templateId
PackageId	StartFastTrackExample.templateId

Methods in com.silanis.esl.sdk.examples that return PackageId

Modifier and Type	Method and Description
protected PackageId	SDKSample.getPackageId()

Uses of PackageId in com.silanis.esl.sdk.service

Methods in com.silanis.esl.sdk.service that return PackageId

Modifier and Type	Method and Description
PackageId	PackageService.createPackage(Package aPackage) Creates a package with roles.
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	PackageService.createPackageFromTemplate(PackageId packageId, Package aPackage) Create a new package based on an existing template.
PackageId	PackageService.createPackageOneStep(Package aPackage, Collection<Document> documents) Creates a package and uploads the documents in one step
PackageId	TemplateService.createTemplate(DocumentPackage template) Creates a template.
PackageId	TemplateService.createTemplateFromPackage(PackageId originalPackageId, DocumentPackage delta) Creates a template from package.
PackageId	TemplateService.createTemplateFromPackage(PackageId originalPackageId, String templateName) Creates a template from package.

Methods in com.silanis.esl.sdk.service with parameters of type PackageId

Modifier and Type	Method and Description
void	AttachmentRequirementService.acceptAttachment(PackageId packageId, Signer signer, String attachmentName) Sender accepts signer's attachment requirement.
String	ApprovalService.addField(PackageId packageId, String documentId, SignatureId signatureId, Field field) Add a field to a signature
Placeholder	TemplateService.addPlaceholder(PackageId templateId, Placeholder placeholder) Adds a placeholder to the template.
FieldId	QRCodeService.addQRCode(PackageId packageId, String documentId, Field qrCodeField) Add a QR code field to the document.
Role	PackageService.addRole(PackageId packageId, Role role) Adds a role to the package.
String	PackageService.addSigner(PackageId packageId, Signer signer) Adds a signer to the specified package
void	LayoutService.applyLayout(PackageId packageId, String documentId, String layoutId) Apply a document layout to a document in a DocumentPackage.
void	LayoutService.applyLayoutByName(PackageId packageId, String documentId, String layoutName) Apply a document layout to a document in a DocumentPackage.
void	PackageService.archive(PackageId packageId) Archive the specified package.
void	PackageService.changePackageStatusToDraft(PackageId packageId) Change the package's status to DRAFT.
void	ReminderService.clearReminderScheduleForPackage(PackageId packageId)
void	PackageService.configureDocumentVisibility(PackageId packageId, DocumentVisibility visibility) Configure a document visibility.
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	PackageService.createPackageFromTemplate(PackageId packageId, Package aPackage) Create a new package based on an existing template.
PackageId	TemplateService.createTemplateFromPackage(PackageId originalPackageId, DocumentPackage delta) Creates a template from package.
PackageId	TemplateService.createTemplateFromPackage(PackageId originalPackageId, String templateName) Creates a template from package.
void	AttachmentRequirementService.deleteAttachmentFile(PackageId packageId, String attachmentId, Integer fileId, String signerSessionId)
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	ApprovalService.deleteField(PackageId packageId, String documentId, SignatureId signatureId, FieldId fieldId) Delete a field from a signature
void	PackageService.deletePackage(PackageId packageId) Deletes the specified package.
void	QRCodeService.deleteQRCode(PackageId packageId, String documentId, FieldId qrCodeId) Delete the QR code from document.
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
DownloadedFile	AttachmentRequirementService.downloadAllAttachmentFilesForPackage(PackageId packageId) Sender downloads all attachment files with file name for the package.
byte[]	AttachmentRequirementService.downloadAllAttachmentsForPackage(PackageId packageId) Deprecated. This method was replaced by AttachmentRequirementService.downloadAllAttachmentFilesForPackage(com.silanis.esl.sdk.PackageId)
byte[]	AttachmentRequirementService.downloadAttachment(PackageId packageId, String attachmentId) Deprecated. This method was replaced by AttachmentRequirementService.downloadAttachmentFile(com.silanis.esl.sdk.PackageId, java.lang.String)
DownloadedFile	AttachmentRequirementService.downloadAttachmentFile(PackageId packageId, String attachmentId) Sender downloads the attachmentFile with file name.
DownloadedFile	AttachmentRequirementService.downloadAttachmentFile(PackageId packageId, String attachmentId, Integer fileId) Sender downloads the attachmentFile with file name.
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<Audit>	AuditService.getAudit(PackageId packageId) Gets the audit trail for a package and returns a list of audits.
SupportConfiguration	PackageService.getConfig(PackageId packageId) Get package support configuration.
List<Document>	PackageService.getDocuments(PackageId packageId, String signerId)
DocumentVisibility	PackageService.getDocumentVisibility(PackageId packageId) Get a document visibility.
Field	ApprovalService.getField(PackageId packageId, String documentId, SignatureId signatureId, FieldId fieldId) Get a field from a signature
List<FieldSummary>	FieldSummaryService.getFieldSummary(PackageId packageId) Gets the field summary for the package and returns a list of field summaries.
DocumentPackage	PackageService.getPackage(PackageId packageId)
Field	QRCodeService.getQRCode(PackageId packageId, String documentId, FieldId qrCodeId) Get the QR code from document.
ReminderSchedule	ReminderService.getReminderScheduleForPackage(PackageId packageId)
List<Role>	PackageService.getRoles(PackageId packageId) Gets the roles for a package.
DownloadedFile	SignatureImageService.getSignatureImageForPackageRole(PackageId packageId, String signerId, SignatureImageFormat imageFormat)
Signer	PackageService.getSigner(PackageId packageId, String signerId) Get a signer from the specified package
List<Signer>	PackageService.getSigners(PackageId packageId, String documentId)
SigningStatus	PackageService.getSigningStatus(PackageId packageId, SignerId signerId, DocumentId documentId) Retrieves the current signing status of the DocumentPackage, Document or Signer specified.
String	PackageService.getSigningUrl(PackageId packageId, String signerId) Get a signing url
String	PackageService.getThankYouDialogContent(PackageId packageId) Get thank you dialog content.
VirtualRoom	VirtualRoomService.getVirtualRoom(PackageId packageId) Gets the virtual room configuration for package.
void	PackageService.markComplete(PackageId packageId) Mark complete on the specified package.
void	QRCodeService.modifyQRCode(PackageId packageId, String documentId, Field qrCodeField) Modify the QR code in document.
void	PackageService.notifySigner(PackageId packageId, GroupId groupId)
void	PackageService.notifySigner(PackageId packageId, String signerEmail, String message) Notifies the specified signer by email, including a custom message.
void	AttachmentRequirementService.rejectAttachment(PackageId packageId, Signer signer, String attachmentName, String senderComment) Sender rejects signer's attachment requirement with a comment.
void	PackageService.removeSigner(PackageId packageId, String signerId) Removes a signer from a package
void	PackageService.restore(PackageId packageId) Restores the specified package.
void	PackageService.sendPackage(PackageId packageId) Sends the package.
void	PackageService.sendSmsToSigner(PackageId packageId, Signer signer) Send SMS to the signer.
void	VirtualRoomService.setVirtualRoom(PackageId packageId, VirtualRoom virtualRoom) Update virtual room configuration for package.
void	SigningService.signDocument(PackageId packageId, SignedDocument signedDocument)
void	SigningService.signDocuments(PackageId packageId, SignedDocuments signedDocumentses)
String	PackageService.startFastTrack(PackageId packageId, List<FastTrackSigner> signers) Create Fast Track Package.
void	PackageService.trash(PackageId packageId) Trash the specified package.
void	PackageService.unlockSigner(PackageId packageId, String signerId) Unlock a signer which has been locked out due to too many failed authentication attempts.
void	ApprovalService.updateConditionalField(PackageId packageId, String documentId, SignatureId signatureId, ConditionalField conditionalField) Update a conditional field from a signature
void	ApprovalService.updateField(PackageId packageId, String documentId, SignatureId signatureId, Field field) Update a field from a signature
void	PackageService.updatePackage(PackageId packageId, DocumentPackage sdkPackage) Updates the package's fields and roles.
Placeholder	TemplateService.updatePlaceholder(PackageId templateId, Placeholder placeholder) Update a placeholder.
void	QRCodeService.updateQRCodes(PackageId packageId, String documentId, List<Field> qrCodeList) Update all the QR codes for a document.
Role	PackageService.updateRole(PackageId packageId, Role role) Updates a role from the package.
void	PackageService.updateSigner(PackageId packageId, Signer signer) Updates a signer's information from a package
void	AttachmentRequirementService.uploadAttachment(PackageId packageId, String attachmentId, Map<String,byte[]> files, String signerSessionId)
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.

Uses of PackageId in com.silanis.esl.sdk.service.apiclient

Methods in com.silanis.esl.sdk.service.apiclient with parameters of type PackageId

Modifier and Type	Method and Description
String	ApprovalApiClient.addField(PackageId packageId, String documentId, SignatureId signatureId, Field apiField)