QrCodeSearchOptions

Inheritance: java.lang.Object, com.groupdocs.signature.options.OptionsExtensions, com.groupdocs.signature.options.search.SearchOptions

public class QrCodeSearchOptions extends SearchOptions

Represents abstract search Options for QR-Code signatures.

Constructors

Constructor	Description
QrCodeSearchOptions()	Initializes a new instance of the QRCodeSearchOptions class with default values.
QrCodeSearchOptions(QrCodeType encodeType)	Initializes a new instance of the QRCodeSearchOptions class with encode type value.
QrCodeSearchOptions(QrCodeType encodeType, String text)	Initializes a new instance of the QRCodeSearchOptions class with encode type and text values.

Methods

Method	Description
getEncodeType()	Specifies Encode Type property to search QR-Codes.
setEncodeType(QrCodeType value)	Specifies Encode Type property to search QR-Codes.
getText()	Specifies QR-Code Signature Text if it should be searched and matched.
setText(String value)	Specifies QR-Code Signature Text if it should be searched and matched.
getMatchType()	Gets or sets QR-Code Text Match Type search.
setMatchType(int value)	Gets or sets QR-Code Text Match Type search.
getDataEncryption()	Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.
setDataEncryption(IDataEncryption value)	Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.
getReturnContent()	Gets or sets flag to grab QR-Code image content of signature on document page.
setReturnContent(boolean value)	Gets or sets flag to grab QR-Code image content of signature on document page.
getReturnContentType()	Specifies file type of returned image content of the QR-Code signature when ReturnContent property is enabled.
setReturnContentType(FileType value)	Specifies file type of returned image content of the QR-Code signature when ReturnContent property is enabled.

QrCodeSearchOptions()

public QrCodeSearchOptions()

Initializes a new instance of the QRCodeSearchOptions class with default values.

QrCodeSearchOptions(QrCodeType encodeType)

public QrCodeSearchOptions(QrCodeType encodeType)

Initializes a new instance of the QRCodeSearchOptions class with encode type value.

Parameters:

Parameter	Type	Description
encodeType	QrCodeType	Specifies QR-Code encode type.

QrCodeSearchOptions(QrCodeType encodeType, String text)

public QrCodeSearchOptions(QrCodeType encodeType, String text)

Initializes a new instance of the QRCodeSearchOptions class with encode type and text values.

Parameters:

Parameter	Type	Description
encodeType	QrCodeType	Specifies QR-Code encode type.
text	java.lang.String	Set Text of QR-Code signature.

getEncodeType()

public final QrCodeType getEncodeType()

Specifies Encode Type property to search QR-Codes. If this value is not set, search is processed for all supported QR-Code Types.

Returns: QrCodeType

setEncodeType(QrCodeType value)

public final void setEncodeType(QrCodeType value)

Specifies Encode Type property to search QR-Codes. If this value is not set, search is processed for all supported QR-Code Types.

Parameters:

Parameter	Type	Description
value	QrCodeType

getText()

public final String getText()

Specifies QR-Code Signature Text if it should be searched and matched.

Returns: java.lang.String

setText(String value)

public final void setText(String value)

Specifies QR-Code Signature Text if it should be searched and matched.

Parameters:

Parameter	Type	Description
value	java.lang.String

getMatchType()

public final int getMatchType()

Gets or sets QR-Code Text Match Type search. It is used only when Text property is set.

Returns: int

setMatchType(int value)

public final void setMatchType(int value)

Gets or sets QR-Code Text Match Type search. It is used only when Text property is set.

Parameters:

Parameter	Type	Description
value	int

getDataEncryption()

public final IDataEncryption getDataEncryption()

Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.

Returns: IDataEncryption

setDataEncryption(IDataEncryption value)

public final void setDataEncryption(IDataEncryption value)

Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.

Parameters:

Parameter	Type	Description
value	IDataEncryption

getReturnContent()

public final boolean getReturnContent()

Gets or sets flag to grab QR-Code image content of signature on document page. If this flag is set true, QR-Code signature image content will keep raw image data by required format ReturnContentType (#getReturnContentType.getReturnContentType/#setReturnContentType(FileType).setReturnContentType(FileType)). By default this option is disabled.

Returns: boolean

setReturnContent(boolean value)

public final void setReturnContent(boolean value)

Parameters:

Parameter	Type	Description
value	boolean

getReturnContentType()

public final FileType getReturnContentType()

Specifies file type of returned image content of the QR-Code signature when ReturnContent property is enabled. By default it set to Null. That means to return QR-Code image content in original format. This image format is specified at QrCodeSignature.Format () Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP. If provided format is not supported than QR-Code image content in original .png will be returned.

Returns: FileType

setReturnContentType(FileType value)

public final void setReturnContentType(FileType value)

Parameters:

Parameter	Type	Description
value	FileType

MetadataSearchOptions SearchOptions