com.silanis.esl.sdk.service

Class QRCodeService

java.lang.Object

com.silanis.esl.sdk.service.QRCodeService

public class QRCodeService
extends Object

The QRCodeService class provides methods to help create, modify, get, delete and update QR codes in documents.

Constructor Summary

Constructors

Constructor and Description
QRCodeService(RestClient restClient, String baseUrl)

Method Summary

Modifier and Type	Method and Description
FieldId	addQRCode(PackageId packageId, String documentId, Field qrCodeField) Add a QR code field to the document.
void	deleteQRCode(PackageId packageId, String documentId, FieldId qrCodeId) Delete the QR code from document.
Field	getQRCode(PackageId packageId, String documentId, FieldId qrCodeId) Get the QR code from document.
void	modifyQRCode(PackageId packageId, String documentId, Field qrCodeField) Modify the QR code in document.
void	updateQRCodes(PackageId packageId, String documentId, List<Field> qrCodeList) Update all the QR codes for a document.

Methods inherited from class java.lang.Object

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

Constructor Detail

QRCodeService

public QRCodeService(RestClient restClient,
                     String baseUrl)

Method Detail

addQRCode

public FieldId addQRCode(PackageId packageId,
                         String documentId,
                         Field qrCodeField)

Add a QR code field to the document.

Parameters:

packageId - of the DocumentPackage which contains the document to add QR code to

documentId - of the Document to add QR code to

qrCodeField - the QR code field to add

Returns:

the field Id of the added QR code

modifyQRCode

public void modifyQRCode(PackageId packageId,
                         String documentId,
                         Field qrCodeField)

Modify the QR code in document.

Parameters:

packageId - of the DocumentPackage which contains the document with the QR code to modify

documentId - of the Document which contains the QR code to modify

qrCodeField - the new QR code field

getQRCode

public Field getQRCode(PackageId packageId,
                       String documentId,
                       FieldId qrCodeId)

Get the QR code from document.

Parameters:

packageId - of the DocumentPackage which contains the document with the QR code to get

documentId - of the Document to get QR code from

qrCodeId - of the QR code to get

Returns:

the QR code field

deleteQRCode

public void deleteQRCode(PackageId packageId,
                         String documentId,
                         FieldId qrCodeId)

Delete the QR code from document.

Parameters:

packageId -

documentId - of the Document which contains the QR code to delete

qrCodeId - of the QR code to delete

updateQRCodes

public void updateQRCodes(PackageId packageId,
                          String documentId,
                          List<Field> qrCodeList)

Update all the QR codes for a document.

Parameters:

packageId - of the DocumentPackage which contains the document with QR codes to update

documentId - of the Document which contains the QR codes to update

qrCodeList - The list of QR codes (Field) to update for document