Home » Epson Manuals » Cash Registers & POS Equipment » Epson TM-T70-i » Manual Viewer

Epson TM-T70-i ePOS-Print API Users Manual For TM-i firmware 4.1 - Page 185

onreceive event, Parameter of the callback function, Properties of the response object

Add to My Manuals
Save this manual to your list of manuals

Page 185 highlights

Chapter 5 ePOS-Print Canvas API onreceive event This property registers the callback function and obtains a response message receipt event. Syntax Function (response) Parameter of the callback function Parameter: Name: Object type: response (See "Properties of the response object" on page 185.) Response message Object Properties of the response object Parameter success (p. 185) code (p. 185) status (p. 186) battery (p. 186) printjobid (p. 186) * Name Print result Error code Status Battery status Print job ID Boolean String Number Number String Object type * ePOS-Print Service Ver.4.1 or later versions supported  Value of success Value true or 1 false or 0 Description  Printing succeeded  Processing succeeded (When the spooler function is enabled)  Printing Failed  Processing Failed (When the spooler function is enabled)  Value of code Value Description 5 'EPTR_AUTOMATICAL' An automatically recoverable error occurred 'EPTR_BATTERY_LOW' No remaining battery 'EPTR_COVER_OPEN' A cover open error occurred 'EPTR_CUTTER' An autocutter error occurred 'EPTR_MECHANICAL' A mechanical error occurred 'EPTR_REC_EMPTY' No paper in roll paper end sensor 'EPTR_UNRECOVERABLE' An unrecoverable error occurred 'SchemaError' The request document contains a syntax error 'DeviceNotFound' The printer with the specified device ID does not exist 'PrintSystemError' An error occurred on the printing system 'EX_BADPORT' An error was detected on the communication port 'EX_TIMEOUT' A print timeout occurred 'EX_SPOOLER' * There is not enough space available in the printing queue 'JobNotFound' * The specified job ID does not exist 'Printing' * Print job now printing * ePOS-Print Service Ver.4.1 or later versions supported 185

Section	Page
Cover	1
For Safety	3
Key to Symbols	3
Restriction of Use	3
About this Manual	4
Aim of the Manual	4
Manual Content	4
Contents	5
Chapter 1 Overview	11
Overview of ePOS-Print	11
Features	12
Print Example	13
Print Flow	15
Features	16
Operating Environment	17
Applications environment	17
Terminal	17
ePOS-Print Supported TM printer	17
Printers That Can Be Controlled	18
System Construction Example	19
Registering a Web Application Into the Web Server	19
Registering a Web Application Into a TM-i	20
Registering a Web application to a cloud	21
Specifying the Print Job ID from the Application	22
Spooler Function	23
Contents in the Package	26
Download	27
Restrictions	28
Chapter 2 Sample Program	29
Sample Program System Overview	29
Sample Program Screen	29
Print Image	31
Program Flow	32
Operating Environment	35
TM-i	35
Environment Settings	36
Registration of Sample Program	38
Sample Program Settings	39
Chapter 3 Programming Guide	41
ePOS-Print API	41
Print Mode	41
Programming Flow	41
Embedding of ePOS-Print API	42
Print Document Creation	43
Transmission of Print Document	46
Reception of Print Result	47
Reception of Status Event	49
ePOS-Print Canvas API	50
Embedding of ePOS-Print Canvas API	51
Rendering in HTML5 Canvas	52
Prints an Canvas image	53
Reception of Print Result	54
Reception of Status Event	56
Using the Spooler Function	57
Chapter 4 ePOS-Print API	61
List of API functions	61
window.epson.ePOSBuilder Components	61
window.epson.ePOSPrint Components	65
ePOS-Print Builder Object	66
Constructor	66
addTextAlign method	67
addTextLineSpace method	68
addTextRotate method	69
addText method	70
addTextLang method	71
addTextFont method	74
addTextSmooth method	75
addTextDouble method	76
addTextSize method	78
addTextStyle method	79
addTextPosition method	81
addTextVPosition method	82
addFeedUnit method	83
addFeedLine method	84
addFeedPosition method	85
addFeed method	87
addImage method	88
addLogo method	90
addBarcode method	91
addSymbol method	96
addHLine method	102
addVLineBegin method	104
addVLineEnd method	105
addPageBegin method	106
addPageEnd method	107
addPageArea method	108
addPageDirection method	110
addPagePosition method	112
addPageLine method	114
addPageRectangle method	116
addCut method	118
addPulse method	119
addSound method	121
addLayout method	123
addRecovery method	127
addReset method	128
addCommand method	129
toString method	130
halftone property	131
brightness property	132
force property	133
message property	134
ePOS-Print Object	135
Constructor	135
send method	136
getPrintJobStatus method	138
open method	139
close method	140
address property	141
enabled property	142
interval property	142
status property	143
battery property	143
timeout property	144
onreceive event	145
onerror event	148
onstatuschange event	149
onbatterystatuschange event	149
ononline event	150
onoffline event	150
onpoweroff event	151
oncoverok event	151
oncoveropen event	152
onpaperok event	152
onpapernearend event	153
onpaperend event	153
ondrawerclosed event	154
ondraweropen event	154
onbatteryok event	155
onbatterylow event	155
Chapter 5 ePOS-Print Canvas API	157
List of ePOS-Print Canvas API functions	157
window.epson.CanvasPrint Components	157
ePOS-Print Canvas API Object	159
Constructor	159
print method	160
getPrintJobStatus method	162
open method	163
close method	164
recover method	165
reset method	165
address property	166
enabled property	167
interval property	168
status property	169
battery property	170
timeout property	171
halftone property	172
brightness property	173
cut property	174
mode property	175
align property	176
color property	177
feed property	178
paper property	179
layout property	180
onreceive event	185
onerror event	188
onstatuschange event	189
onbatterystatuschange event	190
onbatteryok event	191
onbatterylow event	191
ononline event	192
onoffline event	192
onpoweroff event	193
oncoverok event	193
oncoveropen event	194
onpaperok event	194
onpapernearend event	195
onpaperend event	195
ondrawerclosed event	196
ondraweropen event	196
Chapter 6 ePOS-Print Editor	197
ePOS-Print Editor Operating Environment	197
Displaying ePOS-Print Editor	197
Setting	198
Creating a Sample Code	199
Print	201
Import	202
Appendix	203
Printer specifications	203
TM-L90-i/ TM-L90	203
TM-T70-i/ TM-T70	205
TM-T70-i (Multi-language model)	206
TM-T88V-i/ TM-T88V	207
TM-P60II	209
TM-P60II with Peeler	211
TM-P80	213
TM-T20	215
TM-T70 (Multi-language model)	217
TM-T88IV	218
TM-T90	220
TM-U220	222
Rendering in HTML5 Canvas	224
Rendering Text (canvas-print-text.html)	224
Rendering Images (canvas-print-image.html)	226
Rendering Graphics (canvas-print-graph.html)	228
Rendering Handwritten Images (canvas-print-hand.html)	230
Rendering Barcode (canvas-print-barcode.html)	232
Rendering Label (canvas-print-label.html)	234
Windows Store Apps	236
Sample Program Screen	236
Environment of Sample Program	238
Sample Program Settings	239

Match case Limit results 1 per page

185

Chapter 5

ePOS-Print Canvas API

onreceive event

This property registers the callback function and obtains a response message receipt event.

Syntax

Function (response)

Parameter of the callback function

Parameter:

response (

See “Properties of the response object” on page 185.

)

Name:

Response message

Object type:

Object

Properties of the response object

ePOS-Print Service Ver.4.1 or later versions supported



Value of success



Value of code

ePOS-Print Service Ver.4.1 or later versions supported

Parameter

Name

Object type

success (

p. 185

)

Print result

Boolean

code (

p. 185

)

Error code

String

status (

p. 186

)

Status

Number

battery (

p. 186

)

Battery status

Number

printjobid (

p. 186

) *

Print job ID

String

Value

Description

true or 1



Printing succeeded



Processing succeeded (When the spooler function is enabled)

false or 0



Printing Failed



Processing Failed (When the spooler function is enabled)

Value

Description

'EPTR_AUTOMATICAL'

An automatically recoverable error occurred

'EPTR_BATTERY_LOW'

No remaining battery

'EPTR_COVER_OPEN'

A cover open error occurred

'EPTR_CUTTER'

An autocutter error occurred

'EPTR_MECHANICAL'

A mechanical error occurred

'EPTR_REC_EMPTY'

No paper in roll paper end sensor

'EPTR_UNRECOVERABLE'

An unrecoverable error occurred

'SchemaError'

The request document contains a syntax error

'DeviceNotFound'

The printer with the specified device ID does not exist

'PrintSystemError'

An error occurred on the printing system

'EX_BADPORT'

An error was detected on the communication port

'EX_TIMEOUT'

A print timeout occurred

'EX_SPOOLER' *

There is not enough space available in the printing queue

'JobNotFound' *

The specified job ID does not exist

'Printing' *

Print job now printing