Search
Preparing search index...
The search index is not available
Clover SDK for Javascript Integration
Options
All
Public
Public/Protected
All
Inherited
Only exported
Menu
Globals
"remote/client/CloverConnectorFactory"
LegacyCloverConnector
InnerDeviceObserver
Class InnerDeviceObserver
Hierarchy
InnerDeviceObserver
Implements
CloverDeviceObserver
Index
Constructors
constructor
Properties
clover
Connector
lastPRR
logger
Methods
on
Activity
Response
on
Auth
Tip
Adjusted
on
Balance
Inquiry
Response
on
Capture
Pre
Auth
on
Capture
Pre
Auth
Error
on
Cashback
Selected
on
Closeout
Response
on
Confirm
Payment
on
Customer
Provided
Data
Message
on
Device
Connected
on
Device
Disconnected
on
Device
Error
on
Device
Ready
on
Device
Status
Response
on
Display
Receipt
Options
Response
on
Finish
Cancel
on
Finish
Cancel
Auth
on
Finish
Cancel
Manual
Refund
on
Finish
Cancel
Pre
Auth
on
Finish
Cancel
Refund
on
Finish
Cancel
Sale
on
Finish
Cancel_
rmm
on
Finish
Ok
on
Finish
OkCredit
on
Finish
OkPayment
on
Finish
OkRefund
on
Increment
Pre
Auth
Error
on
Increment
Pre
Auth
Response
on
Invalid
State
Transition
Response
on
Key
Pressed
on
Message
Ack
on
Message
From
Activity
on
Partial
Auth
on
Payment
Refund
Response
on
Payment
Refund
Void
Response
on
Payment
Refund
Voided
on
Payment
Voided
on
Payment
Voided_
response
Code
on
Pending
Payments
Response
on
Print
Credit
on
Print
Credit
Decline
on
Print
Job
Status
Response
on
Print
Merchant
Receipt
on
Print
Payment
on
Print
Payment
Decline
on
Print
Refund
Payment
on
Read
Card
Data
Response
on
Read
Card
Response
on
Request
Tip
Response
on
Reset
Device
Response
on
Retrieve
Payment
Response
on
Retrieve
Printers
Response
on
Signature
Collected
on
Tip
Added
on
TxStart
Response
on
TxState
on
UiState
on
Vault
Card
Response
on
Verify
Signature
Constructors
constructor
new
Inner
Device
Observer
(
cc
:
CloverConnector
)
:
InnerDeviceObserver
Parameters
cc:
CloverConnector
Returns
InnerDeviceObserver
Properties
clover
Connector
clover
Connector
:
CloverConnector
lastPRR
lastPRR
:
RefundPaymentResponse
logger
logger
:
Logger
= Logger.create()
Methods
on
Activity
Response
on
Activity
Response
(
status
:
ResultStatus
, payload
:
string
, reason
:
string
, actionId
:
string
)
:
void
Parameters
status:
ResultStatus
payload:
string
reason:
string
actionId:
string
Returns
void
on
Auth
Tip
Adjusted
on
Auth
Tip
Adjusted
(
tarm
:
TipAdjustResponseMessage
, responseCode
?:
ResponseCode
)
:
void
Parameters
tarm:
TipAdjustResponseMessage
Optional
responseCode:
ResponseCode
Returns
void
on
Balance
Inquiry
Response
on
Balance
Inquiry
Response
(
balanceInquiryResponseMessage
:
BalanceInquiryResponseMessage
)
:
void
Parameters
balanceInquiryResponseMessage:
BalanceInquiryResponseMessage
Returns
void
on
Capture
Pre
Auth
on
Capture
Pre
Auth
(
capturePreAuthResponseMessage
:
CapturePreAuthResponseMessage
)
:
void
Parameters
capturePreAuthResponseMessage:
CapturePreAuthResponseMessage
Returns
void
on
Capture
Pre
Auth
Error
on
Capture
Pre
Auth
Error
(
result
:
ResponseCode
, reason
:
string
, message
:
string
, paymentId
:
string
)
:
void
Parameters
result:
ResponseCode
reason:
string
message:
string
paymentId:
string
Returns
void
on
Cashback
Selected
on
Cashback
Selected
(
cashbackAmount
:
number
)
:
void
Parameters
cashbackAmount:
number
Returns
void
on
Closeout
Response
on
Closeout
Response
(
status
:
ResultStatus
, reason
:
string
, batch
:
Batch
)
:
void
Parameters
status:
ResultStatus
reason:
string
batch:
Batch
Returns
void
on
Confirm
Payment
on
Confirm
Payment
(
payment
:
Payment
, challenges
:
Challenge
[]
)
:
void
Parameters
payment:
Payment
challenges:
Challenge
[]
Returns
void
on
Customer
Provided
Data
Message
on
Customer
Provided
Data
Message
(
result
:
ResponseCode
, eventId
:
string
, config
:
LoyaltyDataConfig
, data
:
string
)
:
void
Parameters
result:
ResponseCode
eventId:
string
config:
LoyaltyDataConfig
data:
string
Returns
void
on
Device
Connected
on
Device
Connected
(
)
:
void
Returns
void
on
Device
Disconnected
on
Device
Disconnected
(
device
:
CloverDevice
, message
?:
string
)
:
void
Parameters
device:
CloverDevice
Optional
message:
string
Returns
void
on
Device
Error
on
Device
Error
(
errorEvent
:
CloverDeviceErrorEvent
)
:
void
Parameters
errorEvent:
CloverDeviceErrorEvent
Returns
void
on
Device
Ready
on
Device
Ready
(
device
:
CloverDevice
, drm
:
DiscoveryResponseMessage
)
:
void
Parameters
device:
CloverDevice
drm:
DiscoveryResponseMessage
Returns
void
on
Device
Status
Response
on
Device
Status
Response
(
retrieveDeviceStatusResponseMessage
:
RetrieveDeviceStatusResponseMessage
)
:
void
Parameters
retrieveDeviceStatusResponseMessage:
RetrieveDeviceStatusResponseMessage
Returns
void
on
Display
Receipt
Options
Response
on
Display
Receipt
Options
Response
(
status
:
ResultStatus
, reason
:
string
)
:
void
Parameters
status:
ResultStatus
reason:
string
Returns
void
on
Finish
Cancel
on
Finish
Cancel
(
requestInfo
:
string
)
:
void
Parameters
requestInfo:
string
Returns
void
on
Finish
Cancel
Auth
on
Finish
Cancel
Auth
(
result
:
ResponseCode
, reason
?:
string
, message
?:
string
)
:
void
Parameters
result:
ResponseCode
Optional
reason:
string
Optional
message:
string
Returns
void
on
Finish
Cancel
Manual
Refund
on
Finish
Cancel
Manual
Refund
(
result
:
ResponseCode
, reason
?:
string
, message
?:
string
)
:
void
Parameters
result:
ResponseCode
Optional
reason:
string
Optional
message:
string
Returns
void
on
Finish
Cancel
Pre
Auth
on
Finish
Cancel
Pre
Auth
(
result
:
ResponseCode
, reason
?:
string
, message
?:
string
)
:
void
Parameters
result:
ResponseCode
Optional
reason:
string
Optional
message:
string
Returns
void
on
Finish
Cancel
Refund
on
Finish
Cancel
Refund
(
result
:
ResponseCode
, reason
?:
string
, message
?:
string
)
:
void
Parameters
result:
ResponseCode
Optional
reason:
string
Optional
message:
string
Returns
void
on
Finish
Cancel
Sale
on
Finish
Cancel
Sale
(
result
:
ResponseCode
, reason
?:
string
, message
?:
string
)
:
void
Parameters
result:
ResponseCode
Optional
reason:
string
Optional
message:
string
Returns
void
on
Finish
Cancel_
rmm
on
Finish
Cancel_
rmm
(
result
:
ResponseCode
, reason
:
string
, message
:
string
, requestInfo
:
string
)
:
void
Parameters
result:
ResponseCode
reason:
string
message:
string
requestInfo:
string
Returns
void
on
Finish
Ok
on
Finish
Ok
(
payment
:
Payment
, signature
:
Signature
, requestInfo
:
string
)
:
void
on
Finish
Ok
(
credit
:
Credit
)
:
void
on
Finish
Ok
(
refund
:
Refund
)
:
void
Parameters
payment:
Payment
signature:
Signature
requestInfo:
string
Returns
void
Parameters
credit:
Credit
Returns
void
Parameters
refund:
Refund
Returns
void
on
Finish
OkCredit
on
Finish
OkCredit
(
credit
:
Credit
)
:
void
Parameters
credit:
Credit
Returns
void
on
Finish
OkPayment
on
Finish
OkPayment
(
payment
:
Payment
, signature
:
Signature
, requestInfo
:
string
)
:
void
Parameters
payment:
Payment
signature:
Signature
requestInfo:
string
Returns
void
on
Finish
OkRefund
on
Finish
OkRefund
(
refund
:
Refund
)
:
void
Parameters
refund:
Refund
Returns
void
on
Increment
Pre
Auth
Error
on
Increment
Pre
Auth
Error
(
result
:
ResponseCode
, reason
:
string
, message
:
string
)
:
void
Parameters
result:
ResponseCode
reason:
string
message:
string
Returns
void
on
Increment
Pre
Auth
Response
on
Increment
Pre
Auth
Response
(
responseMsg
:
IncrementPreAuthResponseMessage
)
:
void
Parameters
responseMsg:
IncrementPreAuthResponseMessage
Returns
void
on
Invalid
State
Transition
Response
on
Invalid
State
Transition
Response
(
status
:
ResultStatus
, reason
:
string
, requestedTransition
:
string
, state
:
ExternalDeviceState
, data
:
ExternalDeviceStateData
)
:
void
Parameters
status:
ResultStatus
reason:
string
requestedTransition:
string
state:
ExternalDeviceState
data:
ExternalDeviceStateData
Returns
void
on
Key
Pressed
on
Key
Pressed
(
keyPress
:
KeyPress
)
:
void
Parameters
keyPress:
KeyPress
Returns
void
on
Message
Ack
on
Message
Ack
(
messageId
:
string
)
:
void
Parameters
messageId:
string
Returns
void
on
Message
From
Activity
on
Message
From
Activity
(
actionId
:
string
, payload
:
string
)
:
void
Parameters
actionId:
string
payload:
string
Returns
void
on
Partial
Auth
on
Partial
Auth
(
partialAmount
:
number
)
:
void
Parameters
partialAmount:
number
Returns
void
on
Payment
Refund
Response
on
Payment
Refund
Response
(
refundResponseMessage
:
RefundResponseMessage
)
:
void
Parameters
refundResponseMessage:
RefundResponseMessage
Returns
void
on
Payment
Refund
Void
Response
on
Payment
Refund
Void
Response
(
voidPaymentRefundResponseMessage
:
VoidPaymentRefundResponseMessage
)
:
void
Parameters
voidPaymentRefundResponseMessage:
VoidPaymentRefundResponseMessage
Returns
void
on
Payment
Refund
Voided
on
Payment
Refund
Voided
(
refund
:
Refund
, code
:
ResponseCode
, reason
:
string
, message
:
string
)
:
void
Parameters
refund:
Refund
code:
ResponseCode
reason:
string
message:
string
Returns
void
on
Payment
Voided
on
Payment
Voided
(
voidPaymentResponseMessage
:
VoidPaymentResponseMessage
)
:
void
Parameters
voidPaymentResponseMessage:
VoidPaymentResponseMessage
Returns
void
on
Payment
Voided_
response
Code
on
Payment
Voided_
response
Code
(
code
:
ResponseCode
, reason
:
string
, message
:
string
)
:
void
Parameters
code:
ResponseCode
reason:
string
message:
string
Returns
void
on
Pending
Payments
Response
on
Pending
Payments
Response
(
success
:
boolean
, pendingPayments
:
Array
<
PendingPaymentEntry
>
, reason
?:
string
, message
?:
string
)
:
void
Parameters
success:
boolean
pendingPayments:
Array
<
PendingPaymentEntry
>
Optional
reason:
string
Optional
message:
string
Returns
void
on
Print
Credit
on
Print
Credit
(
credit
:
Credit
)
:
void
Parameters
credit:
Credit
Returns
void
on
Print
Credit
Decline
on
Print
Credit
Decline
(
credit
:
Credit
, reason
:
string
)
:
void
Parameters
credit:
Credit
reason:
string
Returns
void
on
Print
Job
Status
Response
on
Print
Job
Status
Response
(
result
:
ResponseCode
, printRequestId
:
string
, printStatus
:
PrintJobStatus
)
:
void
Parameters
result:
ResponseCode
printRequestId:
string
printStatus:
PrintJobStatus
Returns
void
on
Print
Merchant
Receipt
on
Print
Merchant
Receipt
(
payment
:
Payment
)
:
void
Parameters
payment:
Payment
Returns
void
on
Print
Payment
on
Print
Payment
(
payment
:
Payment
, order
:
Order
)
:
void
Parameters
payment:
Payment
order:
Order
Returns
void
on
Print
Payment
Decline
on
Print
Payment
Decline
(
payment
:
Payment
, reason
:
string
)
:
void
Parameters
payment:
Payment
reason:
string
Returns
void
on
Print
Refund
Payment
on
Print
Refund
Payment
(
payment
:
Payment
, order
:
Order
, refund
:
Refund
)
:
void
Parameters
payment:
Payment
order:
Order
refund:
Refund
Returns
void
on
Read
Card
Data
Response
on
Read
Card
Data
Response
(
result
:
ResponseCode
, reason
:
string
, message
:
string
)
:
void
Parameters
result:
ResponseCode
reason:
string
message:
string
Returns
void
on
Read
Card
Response
on
Read
Card
Response
(
status
:
ResultStatus
, reason
:
string
, cardData
:
CardData
)
:
void
Parameters
status:
ResultStatus
reason:
string
cardData:
CardData
Returns
void
on
Request
Tip
Response
on
Request
Tip
Response
(
requestTipResponseMessage
:
RequestTipResponseMessage
)
:
void
Parameters
requestTipResponseMessage:
RequestTipResponseMessage
Returns
void
on
Reset
Device
Response
on
Reset
Device
Response
(
result
:
ResponseCode
, reason
:
string
, state
:
ExternalDeviceState
)
:
void
Parameters
result:
ResponseCode
reason:
string
state:
ExternalDeviceState
Returns
void
on
Retrieve
Payment
Response
on
Retrieve
Payment
Response
(
retrievePaymentResponseMessage
:
RetrievePaymentResponseMessage
)
:
void
Parameters
retrievePaymentResponseMessage:
RetrievePaymentResponseMessage
Returns
void
on
Retrieve
Printers
Response
on
Retrieve
Printers
Response
(
result
:
ResponseCode
, printers
:
Array
<
Printer
>
)
:
void
Parameters
result:
ResponseCode
printers:
Array
<
Printer
>
Returns
void
on
Signature
Collected
on
Signature
Collected
(
signatureResponseMessage
:
SignatureResponseMessage
)
:
void
Parameters
signatureResponseMessage:
SignatureResponseMessage
Returns
void
on
Tip
Added
on
Tip
Added
(
tip
:
number
)
:
void
Parameters
tip:
number
Returns
void
on
TxStart
Response
on
TxStart
Response
(
txStartResponseMessage
:
TxStartResponseMessage
)
:
void
Parameters
txStartResponseMessage:
TxStartResponseMessage
Returns
void
on
TxState
on
TxState
(
txState
:
TxState
)
:
void
Parameters
txState:
TxState
Returns
void
on
UiState
on
UiState
(
uiState
:
UiState
, uiText
:
string
, uiDirection
:
UiDirection
, inputOptions
:
Array
<
InputOption
>
)
:
void
Parameters
uiState:
UiState
uiText:
string
uiDirection:
UiDirection
inputOptions:
Array
<
InputOption
>
Returns
void
on
Vault
Card
Response
on
Vault
Card
Response
(
vaultCardResponseMessage
:
VaultCardResponseMessage
, code
?:
ResponseCode
, message
?:
string
)
:
void
Parameters
vaultCardResponseMessage:
VaultCardResponseMessage
Optional
code:
ResponseCode
Optional
message:
string
Returns
void
on
Verify
Signature
on
Verify
Signature
(
payment
:
Payment
, signature
:
Signature
)
:
void
Parameters
payment:
Payment
signature:
Signature
Returns
void
Globals
"
Version"
"remote/client/
Card
Entry
Methods"
"remote/client/
Clover
Connector
Factory"
"remote/client/
Clover
Connector
Factory
Builder"
"remote/client/
Clover
Connector
Factory
V2"
"remote/client/IClover
Connector
Factory"
"remote/client/device/
Web
Socket
Cloud
Clover
Device
Configuration"
"remote/client/device/
Web
Socket
Paired
Clover
Device
Configuration"
"util/IImage
Util"
"util/
Image
Util"
"websocket/
Browser
Web
Socket
Impl"
"websocket/
Clover
Web
Socket
Interface"
"websocket/
Web
Socket
Listener"
"websocket/
Web
Socket
State"
Clover
Connector
Factory
Legacy
Clover
Connector
Inner
Device
Observer
constructor
clover
Connector
lastPRR
logger
on
Activity
Response
on
Auth
Tip
Adjusted
on
Balance
Inquiry
Response
on
Capture
Pre
Auth
on
Capture
Pre
Auth
Error
on
Cashback
Selected
on
Closeout
Response
on
Confirm
Payment
on
Customer
Provided
Data
Message
on
Device
Connected
on
Device
Disconnected
on
Device
Error
on
Device
Ready
on
Device
Status
Response
on
Display
Receipt
Options
Response
on
Finish
Cancel
on
Finish
Cancel
Auth
on
Finish
Cancel
Manual
Refund
on
Finish
Cancel
Pre
Auth
on
Finish
Cancel
Refund
on
Finish
Cancel
Sale
on
Finish
Cancel_
rmm
on
Finish
Ok
on
Finish
OkCredit
on
Finish
OkPayment
on
Finish
OkRefund
on
Increment
Pre
Auth
Error
on
Increment
Pre
Auth
Response
on
Invalid
State
Transition
Response
on
Key
Pressed
on
Message
Ack
on
Message
From
Activity
on
Partial
Auth
on
Payment
Refund
Response
on
Payment
Refund
Void
Response
on
Payment
Refund
Voided
on
Payment
Voided
on
Payment
Voided_
response
Code
on
Pending
Payments
Response
on
Print
Credit
on
Print
Credit
Decline
on
Print
Job
Status
Response
on
Print
Merchant
Receipt
on
Print
Payment
on
Print
Payment
Decline
on
Print
Refund
Payment
on
Read
Card
Data
Response
on
Read
Card
Response
on
Request
Tip
Response
on
Reset
Device
Response
on
Retrieve
Payment
Response
on
Retrieve
Printers
Response
on
Signature
Collected
on
Tip
Added
on
TxStart
Response
on
TxState
on
UiState
on
Vault
Card
Response
on
Verify
Signature
Generated using
TypeDoc