class Abbyy::Models::ProcessCheckmarkFieldRequest

Overview

Request object for /processCheckmarkField API-method.

Included Modules

Defined in:

abbyy/models/process_checkmark_field_request.cr

Constant Summary

DEFAULT_CHECKMARK_TYPE = CheckmarkType::Empty
DEFAULT_CORRECTION_ALLOWED = 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, checkmark_type : CheckmarkType | Nil = nil, correction_allowed : Bool | Nil = nil, description : String | Nil = nil, pdf_password : String | Nil = nil) #

[View source]

Instance Method Detail

def checkmark_type : CheckmarkType | Nil #

Specifies the type of the checkmark. It can be one of the following:

This parameter is not required.

Default value is CheckmarkType::Empty.


[View source]
def checkmark_type=(checkmark_type : CheckmarkType | Nil) #

Specifies the type of the checkmark. It can be one of the following:

This parameter is not required.

Default value is CheckmarkType::Empty.


[View source]
def correction_allowed : Bool | Nil #

This property set to true means that checkmark block can be selected and then corrected.

This parameter is not required.

Default value is false.


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

This property set to true means that checkmark block can be selected and then corrected.

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]
def set_description(description : String | Nil) #

[View source]