com.silanis.esl.sdk.service

Class AttachmentRequirementService

java.lang.Object

com.silanis.esl.sdk.service.AttachmentRequirementService

public class AttachmentRequirementService
extends Object

The AttachmentRequirementService class provides methods to help create attachments for signers.

Constructor Summary

Constructors

Constructor and Description
AttachmentRequirementService(AttachmentRequirementApiClient apiClient, RestClient restClient, String baseUrl)

Method Summary

Modifier and Type	Method and Description
void	acceptAttachment(PackageId packageId, Signer signer, String attachmentName) Sender accepts signer's attachment requirement.
void	deleteAttachmentFile(PackageId packageId, String attachmentId, Integer fileId, String signerSessionId)
DownloadedFile	downloadAllAttachmentFilesForPackage(PackageId packageId) Sender downloads all attachment files with file name for the package.
DownloadedFile	downloadAllAttachmentFilesForSignerInPackage(DocumentPackage sdkPackage, Signer signer) Sender downloads all attachment files with file name for the signer in the package.
byte[]	downloadAllAttachmentsForPackage(PackageId packageId) Deprecated. This method was replaced by downloadAllAttachmentFilesForPackage(com.silanis.esl.sdk.PackageId)
byte[]	downloadAllAttachmentsForSignerInPackage(DocumentPackage sdkPackage, Signer signer) Deprecated. This method was replaced by downloadAllAttachmentFilesForSignerInPackage(com.silanis.esl.sdk.DocumentPackage, com.silanis.esl.sdk.Signer)
byte[]	downloadAttachment(PackageId packageId, String attachmentId) Deprecated. This method was replaced by downloadAttachmentFile(com.silanis.esl.sdk.PackageId, java.lang.String)
DownloadedFile	downloadAttachmentFile(PackageId packageId, String attachmentId) Sender downloads the attachmentFile with file name.
DownloadedFile	downloadAttachmentFile(PackageId packageId, String attachmentId, Integer fileId) Sender downloads the attachmentFile with file name.
void	rejectAttachment(PackageId packageId, Signer signer, String attachmentName, String senderComment) Sender rejects signer's attachment requirement with a comment.
void	uploadAttachment(PackageId packageId, String attachmentId, Map<String,byte[]> files, String signerSessionId)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AttachmentRequirementService

public AttachmentRequirementService(AttachmentRequirementApiClient apiClient,
                                    RestClient restClient,
                                    String baseUrl)

Method Detail

acceptAttachment

public void acceptAttachment(PackageId packageId,
                             Signer signer,
                             String attachmentName)

Sender accepts signer's attachment requirement.

Parameters:

packageId - the package ID

signer - the signer who uploaded the attachment

attachmentName -

rejectAttachment

public void rejectAttachment(PackageId packageId,
                             Signer signer,
                             String attachmentName,
                             String senderComment)

Sender rejects signer's attachment requirement with a comment.

Parameters:

packageId - the package ID

signer - the signer who uploaded the attachment

attachmentName -

senderComment - the sender's rejection comment

downloadAttachment

@Deprecated
public byte[] downloadAttachment(PackageId packageId,
                                             String attachmentId)

Deprecated. This method was replaced by downloadAttachmentFile(com.silanis.esl.sdk.PackageId, java.lang.String)

downloadAttachmentFile

public DownloadedFile downloadAttachmentFile(PackageId packageId,
                                             String attachmentId)

Sender downloads the attachmentFile with file name.

Parameters:

packageId - the package ID

attachmentId - the attachment's ID

Returns:

downloadAttachmentFile

public DownloadedFile downloadAttachmentFile(PackageId packageId,
                                             String attachmentId,
                                             Integer fileId)

Sender downloads the attachmentFile with file name.

Parameters:

packageId - the package ID

attachmentId - the attachment's ID

fileId - the attachment file ID

Returns:

downloadAllAttachmentsForPackage

@Deprecated
public byte[] downloadAllAttachmentsForPackage(PackageId packageId)

Deprecated. This method was replaced by downloadAllAttachmentFilesForPackage(com.silanis.esl.sdk.PackageId)

downloadAllAttachmentFilesForPackage

public DownloadedFile downloadAllAttachmentFilesForPackage(PackageId packageId)

Sender downloads all attachment files with file name for the package.

Parameters:

packageId - the package ID

Returns:

downloadAllAttachmentsForSignerInPackage

@Deprecated
public byte[] downloadAllAttachmentsForSignerInPackage(DocumentPackage sdkPackage,
                                                                   Signer signer)

Deprecated. This method was replaced by downloadAllAttachmentFilesForSignerInPackage(com.silanis.esl.sdk.DocumentPackage, com.silanis.esl.sdk.Signer)

downloadAllAttachmentFilesForSignerInPackage

public DownloadedFile downloadAllAttachmentFilesForSignerInPackage(DocumentPackage sdkPackage,
                                                                   Signer signer)

Sender downloads all attachment files with file name for the signer in the package.

Parameters:

sdkPackage - the package

signer - the Signer

Returns:

uploadAttachment

public void uploadAttachment(PackageId packageId,
                             String attachmentId,
                             Map<String,byte[]> files,
                             String signerSessionId)

deleteAttachmentFile

public void deleteAttachmentFile(PackageId packageId,
                                 String attachmentId,
                                 Integer fileId,
                                 String signerSessionId)