class Abbyy::Models::ProcessBarcodeFieldRequest

Overview

Request object for /processBarcodeField API-method.

Included Modules

Defined in:

abbyy/models/process_barcode_field_request.cr

Constant Summary

DEFAULT_BARCODE_TYPE = BarcodeType::AutoDetect
DEFAULT_CONTAINS_BINARY_DATA = false
DEFAULT_DESCRIPTION = ""
DEFAULT_PASSWORD = ""
DEFAULT_REGION = Region.new(-1, -1, -1, -1)

Constructors

Instance Method Summary

Instance methods inherited from module Abbyy::Models::FileBody

body : HTTP::Client::BodyType body, file_path : String file_path, file_path=(file_path : String) file_path=

Constructor methods inherited from module Abbyy::Models::FileBody

new(file_path : String) new

Instance methods inherited from class Abbyy::Models::BaseRequest

body : HTTP::Client::BodyType body, params : Hash(String, String) params

Constructor Detail

def self.new(file_path : String, region : Region | Nil = nil, barcode_type : BarcodeType | Array(BarcodeType) | Nil = nil, contains_binary_data : Bool | Nil = nil, description : String | Nil = nil, pdf_password : String | Nil = nil) #

[View source]

Instance Method Detail

def barcode_type : BarcodeType | Array(BarcodeType) | Nil #

Specifies the type of the barcode. This parameter may also contain several barcode types in an array, for example:

[BarcodeType::Code39, BarcodeType::Code93]

The following values can be used:

See the description of barcode types for details.

This parameter is not required.

Default value is BarcodeType::AutoDetect.


[View source]
def barcode_type=(barcode_type : BarcodeType | Array(BarcodeType) | Nil) #

Specifies the type of the barcode. This parameter may also contain several barcode types in an array, for example:

[BarcodeType::Code39, BarcodeType::Code93]

The following values can be used:

See the description of barcode types for details.

This parameter is not required.

Default value is BarcodeType::AutoDetect.


[View source]
def contains_binary_data : Bool | Nil #

This parameter makes sense only for PDF417 and Aztec barcodes, which encode some binary data. If this parameter is set to true, the binary data encoded in a barcode are saved as a sequence of hexadecimal values for corresponding bytes.

This parameter is not required.

Default value is false.


[View source]
def contains_binary_data=(contains_binary_data : Bool | Nil) #

This parameter makes sense only for PDF417 and Aztec barcodes, which encode some binary data. If this parameter is set to true, the binary data encoded in a barcode are saved as a sequence of hexadecimal values for corresponding bytes.

This parameter is not required.

Default value is false.


[View source]
def description : String | Nil #

Contains the description of the processing task. Cannot contain more than 255 characters.

This parameter is not required.


[View source]
def description=(description : String | Nil) #

[View source]
def params : Hash(String, String) #

[View source]
def pdf_password : String | Nil #

Contains a password for accessing password-protected images in PDF format.

This parameter is not required.


[View source]
def pdf_password=(pdf_password : String | Nil) #

Contains a password for accessing password-protected images in PDF format.

This parameter is not required.


[View source]
def region : Region | Nil #

Specifies the region of the text field on the image. The coordinates of the region are measured in pixels relative to the left top corner of the image and are specified in the following order: left, top, right, bottom. By default, the region of the whole image is used.

This parameter is not required.

Default value is Region.new(-1, -1, -1, -1).


[View source]
def region=(region : Region | Nil) #

Specifies the region of the text field on the image. The coordinates of the region are measured in pixels relative to the left top corner of the image and are specified in the following order: left, top, right, bottom. By default, the region of the whole image is used.

This parameter is not required.

Default value is Region.new(-1, -1, -1, -1).


[View source]
def region=(coordinates : Array(Int32)) #

[View source]