Image Generator SDK  4.24.0
The Image Generator SDK provides a library to generate QR codes and CrontoSign images
IImageGeneratorSDK Interface Reference

The Image Generator SDK main class. It can generate a QR code or a CrontoSign image. More...

Inherited by ImageGeneratorSDK.

Public Member Functions

BWQRCodeResponse GenerateBWQRCode (int imageSize, string inputValue, int errorCorrectionLevel)
 Generates a black and white QR code image More...
 
CrontoImageResponse GenerateCrontoSign (int squareSize, string inputValue)
 Generates a CRONTO image for the corresponding input values. A scrambling is applied on the input before generating the image.
The output image is to be printed on paper. More...
 
CrontoImageResponse GenerateCrontoSign (int squareSize, string inputValue, bool onPaper)
 Generates a CRONTO image for the corresponding input values. A scrambling is applied on the input before generating the image. More...
 
CrontoImageResponse GenerateDynamicCrontoImage (int squareSize, string inputValue, bool onPaper)
 Generates a CRONTO image for the corresponding input values. The size of the image is dynamic and depends on the inputValue length.
CAUTION: The CRONTO images generated with this method cannot be scanned by VASCO hardware authenticators (e.g. DP760, DP780). More...
 

Static Public Attributes

const string VERSION = "4.24.0"
 Version of the Image Generator SDK More...
 

Detailed Description

The Image Generator SDK main class. It can generate a QR code or a CrontoSign image.

Member Function Documentation

◆ GenerateBWQRCode()

BWQRCodeResponse GenerateBWQRCode ( int  imageSize,
string  inputValue,
int  errorCorrectionLevel 
)

Generates a black and white QR code image

Parameters
imageSizeThe side length of the generated image. The minimum square size is QRCODE_MIN_IMAGE_SIZE, and the maximum square size is QRCODE_MAX_IMAGE_SIZE
inputValueString to encode. Supports numeric, alphanumeric, ISO 8859-1 and Shift JIS X 0208 formats
errorCorrectionLevelThe error correction level (which is QRCODE_ERROR_CORRECTION_LEVEL_LOW, QRCODE_ERROR_CORRECTION_LEVEL_LOW, QRCODE_ERROR_CORRECTION_LEVEL_LOW or QRCODE_ERROR_CORRECTION_LEVEL_LOW)
Returns
A BWQRCodeResponse object containing the QR code image and the associated boolean matrix
Exceptions
OneSpan.Image.Exceptions.ImageGeneratorSDKException

Implemented in ImageGeneratorSDK.

◆ GenerateCrontoSign() [1/2]

CrontoImageResponse GenerateCrontoSign ( int  squareSize,
string  inputValue 
)

Generates a CRONTO image for the corresponding input values. A scrambling is applied on the input before generating the image.
The output image is to be printed on paper.

Parameters
squareSizeThe size of a CrontoSign square. The minimum square size is CRONTOSIGN_MIN_SQUARE_SIZE, and the maximum square size is CRONTOSIGN_MAX_SQUARE_SIZE
inputValueThe hexadecimal string to encode. The max size is CRONTOSIGN_MAX_INPUT_VALUE_LENGTH
Returns
A CrontoImageResponse object containing the cronto image
Exceptions
OneSpan.Image.Exceptions.ImageGeneratorSDKExceptionIf an exception occured, the following error code can be thrown:

Implemented in ImageGeneratorSDK.

◆ GenerateCrontoSign() [2/2]

CrontoImageResponse GenerateCrontoSign ( int  squareSize,
string  inputValue,
bool  onPaper 
)

Generates a CRONTO image for the corresponding input values. A scrambling is applied on the input before generating the image.

Parameters
squareSizeThe size of a CrontoSign square. The minimum square size is CRONTOSIGN_MIN_SQUARE_SIZE, and the maximum square size is CRONTOSIGN_MAX_SQUARE_SIZE
inputValueThe hexadecimal string to encode. The max size is CRONTOSIGN_MAX_INPUT_VALUE_LENGTH
onPaperTrue if and only if the image is to be printed on paper
Returns
A CrontoImageResponse object containing the cronto image
Exceptions
OneSpan.Image.Exceptions.ImageGeneratorSDKExceptionIf an exception occured, the following error code can be thrown:

Implemented in ImageGeneratorSDK.

◆ GenerateDynamicCrontoImage()

CrontoImageResponse GenerateDynamicCrontoImage ( int  squareSize,
string  inputValue,
bool  onPaper 
)

Generates a CRONTO image for the corresponding input values. The size of the image is dynamic and depends on the inputValue length.
CAUTION: The CRONTO images generated with this method cannot be scanned by VASCO hardware authenticators (e.g. DP760, DP780).

Parameters
squareSizeThe size of a CrontoSign square. The minimum square size is CRONTOSIGN_MIN_SQUARE_SIZE, and the maximum square size is CRONTOSIGN_MAX_SQUARE_SIZE
inputValueThe hexadecimal string to encode. The max size is CRONTOSIGN_MAX_INPUT_VALUE_LENGTH
onPaperTrue if and only if the image is to be printed on paper
Returns
A CrontoImageResponse object containing the cronto image
Exceptions
OneSpan.Image.Exceptions.ImageGeneratorSDKExceptionIf an exception occured, the following error code can be thrown:

Implemented in ImageGeneratorSDK.

Field Documentation

◆ VERSION

const string VERSION = "4.24.0"
static

Version of the Image Generator SDK


The documentation for this interface was generated from the following file: