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

Select your printer model

Parameters are refined by the selected printer.

setReceiveEventDelegate

Registers a callback method for a response document reception event.

Syntax

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

Parameter

delegate

Specifies an object conforming to the Epos2PtrReceiveDelegate protocol.

Protocol declaration

 
 
@protocol Epos2PtrReceiveDelegate <NSObject>
@required
- (void) onPtrReceive:(Epos2Printer *)printerObj
code:(int)code status:(Epos2PrinterStatusInfo *)status printJobId:(NSString *)printJobId;
@end

Parameter

printerObj

The callback source object is stored.

code

The processing result is stored.

Error status

Description

EPOS2_CODE_SUCCESS

Print succeeded.

EPOS2_CODE_PRINTING

Printing

EPOS2_CODE_ERR_AUTORECOVER

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

Print timeout occurred.

EPOS2_CODE_ERR_JOB_NOT_FOUND

Specified print job ID does not exist.

EPOS2_CODE_ERR_SPOOLER

Print queue is full.

EPOS2_CODE_ERR_BATTERY_LOW

Battery has run out.

EPOS2_CODE_ERR_TOO_MANY_REQUESTS

The number of print jobs sent to the printer has exceeded the allowable limit.

EPOS2_CODE_ERR_REQUEST_ENTITY_TOO_LARGE

The size of the print job data exceeds the capacity of the printer.

EPOS2_CODE_ERR_WAIT_REMOVAL

Print command sent while waiting for paper removal.

status

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

printJobId

  • When the spooler function has been enabled, a print job ID is stored.
  • When the spooler function is disabled, nil is stored.

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 Printer object in the caller and the printerObj parameter.
  • Check the details of automatic recovery errors and unrecoverable errors in getStatus.
 

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. Epos2Printer class »
  4. setReceiveEventDelegate

Jump to the top