1. TOP»
  2. Epson ePOS SDK for iOS »
  3. Epos2HybridPrinter class »
  4. setReceiveEventDelegate

Select your printer model

Parameters are refined by the selected printer.

setReceiveEventDelegate

Register the callback method for response document receive events.

Syntax

 
 
- (void) setReceiveEventDelegate:(id<Epos2HybdReceiveDelegate>)delegate;

Parameter

delegate

Specifies an object conforming to the Epos2HybdReceiveDelegate protocol.

Protocol declaration

 
 
@protocol Epos2HybdReceiveDelegate <NSObject>
@required
- (void) onHybdReceive:(Epos2HybridPrinter *) hybridPrinterObj
method:(int)method
code:(int)code
micrData:(NSString *)micrData
status:(Epos2HybridPrinterStatusInfo *)status
@end

Parameter

hybridPrinterObj

The callback source object is stored.

method

The method information is stored.

Code

Description

EPOS2_METHOD_WAITINSERTION

Result of the waitInsertion API

EPOS2_METHOD_SENDDATA

Result of the sendDataAPI

EPOS2_METHOD_CANCELINSERTION

Result of the cancelInsertion API

EPOS2_METHOD_EJECTPAPER

Result of the ejectPaper API

EPOS2_METHOD_READMICRDATA

Result of the readMicrData API

EPOS2_METHOD_CLEANMICRREADER

Result of the cleanMicrReader API

code

The processing result is stored.

Code

Description

EPOS2_CODE_SUCCESS

Processing successful.

EPOS2_CODE_CANCELED

Cancels the insertion wait status.

EPOS2_CODE_PRINTING

Printing

EPOS2_CODE_ERR_AUTOMATICAL

Automatic recovery error occurred.

EPOS2_CODE_ERR_COVER_OPEN

Cover open error occurred.

EPOS2_CODE_ERR_CUTTER

Auto cutter error occurred.

EPOS2_CODE_ERR_MECHANICAL

Mechanical error occurred.

EPOS2_CODE_ERR_EMPTY

No paper is left in the roll paper end detector.

EPOS2_CODE_ERR_UNRECOVERABLE

Unrecoverable error occurred.

EPOS2_CODE_ERR_FAILURE

Error exists in the requested document syntax.

EPOS2_CODE_ERR_NOT_FOUND

Printer specified by the device ID does not exist.

EPOS2_CODE_ERR_SYSTEM

Error occurred with the printing system.

EPOS2_CODE_ERR_PORT

Error was detected with the communication port.

EPOS2_CODE_ERR_TIMEOUT

Timeout occurred.

EPOS2_CODE_ERR_JOB_NOT_FOUND

Specified job ID does not exist.

EPOS2_CODE_ERR_SPOOLER

Print queue is full.

EPOS2_CODE_ERR_TOO_MANY_REQUESTS

Print data exceeding the printer firmware capacity was transmitted.

EPOS2_CODE_ERR_REQUEST_ENTITY_TOO_LARGE

Print data exceeding the maximum capacity per transfer was transmitted.

EPOS2_CODE_ERR_PAPER_PULLED_OUT

Paper removal was detected.

EPOS2_CODE_ERR_CANCEL_FAILED

Failed to cancel waiting for paper insertion.

EPOS2_CODE_ERR_NO_MICR_DATA

A slip sheet out of the standard was inserted.

EPOS2_CODE_ERR_NO_MAGNETIC_DATA

Cannot detect the magnetic waveform.

EPOS2_CODE_ERR_RECOGNITION

A character which cannot be analyzed was detected.

EPOS2_CODE_ERR_READ

Error occurred during MICR read operation.

EPOS2_CODE_ERR_NOISE_DETECTED

Noise error was detected.

EPOS2_CODE_ERR_COVER_OPEN

Cover open error occurred during MICR read operation.

EPOS2_CODE_ERR_PAPER_JAM

Paper jam error occurred during MICR read operation.

EPOS2_CODE_ ERR_PAPER_TYPE

Pinter operation differs from the specified print method.

EPOS2_CODE_ ERR_WAIT_INSERTION

Could not run the process while waiting for paper insertion.

EPOS2_CODE_ ERR_ILLEGAL

The function was used in an illegal way.

EPOS2_CODE_ ERR_INSERTED

Could not run the process while paper had already been inserted.

EPOS2_CODE_ ERR_WAIT_REMOVAL

Could not run the process while waiting for paper removal.

EPOS2_CODE_ERR_DEVICE_BUSY

The specified device is in process and the process cannot be executed.

micrData

MICR read result is stored.

status

Status at the timing when the process was run is stored as the Epos2PrinterStatusInfo type.

Supplementary explanation

  • When this API is run multiple times, the callback method specified later takes effect.
  • If nil is specified in delegate when calling this API, the registered callback method is canceled.
  • When a communication error occurs during ePOS-Device XML control, communication disconnection is not notified.
    To notify the disconnection event, implement the setConnectionEventDelegate.
  • When controlling multiple printers at a time, identify which printer has finished printing by comparing the HybridPrinter object in the caller and the hybridPrinterObj parameter.
 

Quick Access

  • [Name]
  • [Format]
  • [Range]
  • [Description]
  • [Notes]
Epson ePOS SDK includes patented or patent pending functions. The contents must not be disclosed to third parties.


Epson ePOS SDK for iOS

  1. TOP»
  2. Epson ePOS SDK for iOS »
  3. Epos2HybridPrinter class »
  4. setReceiveEventDelegate

Jump to the top