 |
CloverConnector
3.0.2
Copyright (C) 2018 Clover Network, Inc.
|
|
CloverConnector
3.0.2
Copyright (C) 2018 Clover Network, Inc.
|
Namespaces | |
| namespace | service |
Classes | |
| class | AcceptPayment |
| Object passed in to OnAcceptPayment More... | |
| class | ActivityMessage |
| base class for messages flowing between POS and CustomActivity More... | |
| class | AuthRequest |
| This request should be used for Auth only, but is backward compatible for older implementations. If you are currently using an AuthRequest with IsPreAuth = true, please change your code to use PreAuthRequest/PreAuthResponse for all PreAuth transactions. More... | |
| class | AuthResponse |
| Object passed in to OnAuthResponse More... | |
| class | BaseRequest |
| class | BaseResponse |
| class | BaseTransactionRequest |
| Base Sale/Auth/Refund/PreAuth Transaction Request More... | |
| class | CapturePreAuthRequest |
| This request should be used for capturing payments obtained from a PreAuth response More... | |
| class | CapturePreAuthResponse |
| Object passed in to OnCapturePreAuthResponse More... | |
| class | CloseoutRequest |
| This request should be passed in to make a closeout request More... | |
| class | CloseoutResponse |
| Object passed in to OnCloseoutResponse More... | |
| class | CloverConnector |
| class | CloverConnectorExtensions |
| class | CloverConnectorFactory |
| Factory to create an instance of the CloverConnector. More... | |
| class | CloverDeviceErrorEvent |
| class | CloverDeviceEvent |
| class | ConfirmPaymentRequest |
| Object passed in to ConfirmPaymentRequest. This must also be used to either accept or reject a payment as requested from the clover device. More... | |
| class | CustomActivityRequest |
| Request for the Clover device to start a Custom Activity More... | |
| class | CustomActivityResponse |
| Response when a custom activity completes on the Clover device when it is completed in a normal flow More... | |
| class | CustomerProvidedDataEvent |
| class | DefaultCloverConnectorListener |
| This is a default implementation of the ICloverConnectorListener that can be used for quickly creating applications by simply overriding the appropriate listener method(s) needed for testing a particular remote call. More... | |
| class | DeviceInfo |
| Contains the device information of the connected device More... | |
| class | DisplayPaymentReceiptOptionsRequest |
| The request used to show the receipt options screen More... | |
| class | DisplayReceiptOptionsRequest |
| class | DisplayReceiptOptionsResponse |
| class | ExternalDeviceStateData |
| Depending on the current device status, these fields may or may not be populated More... | |
| class | ExternalIDUtil |
| Used for generating a unique string of the length specified Uses the linear congruential generator (LCG) algorithm in conjunction with the .NET RNGCryptoServiceProvider class. | |
| interface | ICloverConnector |
| The CloverConnector API serves as the interface for connecting to a Clover device. This document defines the available methods. More... | |
| interface | ICloverConnectorListener |
| These are the methods to implement for intercepting messages that are sent from a Clover device. More... | |
| class | ManualRefundRequest |
| This should be used to request a manual refund via the ManualRefund method More... | |
| class | ManualRefundResponse |
| The object passed in to OnManualRefundResponse More... | |
| class | MerchantInfo |
| class | MessageFromActivity |
| class for sending message from a CustomActivity to POS More... | |
| class | MessageToActivity |
| class for sending messages to a CustomActivity from POS More... | |
| class | OpenCashDrawerRequest |
| class | PaymentResponse |
| class | PreAuthRequest |
| This request should be used for PreAuth transactions. If you are currently using an AuthRequest with IsPreAuth = true, please change your code to use PreAuthRequest/PreAuthResponse for all PreAuth transactions. More... | |
| class | PreAuthResponse |
| Object passed in to OnPreAuthResponse More... | |
| class | PrintJobStatusRequest |
| class | PrintJobStatusResponse |
| class | PrintManualRefundDeclineReceiptMessage |
| Callback to request the POS print a ManualRefund declined receipt More... | |
| class | PrintManualRefundReceiptMessage |
| Callback to request the POS print a receipt for a ManualRefund /summary> More... | |
| class | PrintPaymentDeclineReceiptMessage |
| Callback to the POS to request a payment declined receipt More... | |
| class | PrintPaymentMerchantCopyReceiptMessage |
| Callback to the POS to request a merchant payment receipt be printed More... | |
| class | PrintPaymentReceiptMessage |
| Callback to the POS to request a payment receipt be printed More... | |
| class | PrintRefundPaymentReceiptMessage |
| Callback to the POS to request a payment refund receipt be printed More... | |
| class | PrintRequest |
| This should be used for a print call. More... | |
| class | ReadCardDataRequest |
| This request should be passed to initiate retrieval of card data More... | |
| class | ReadCardDataResponse |
| Retrieve Card Data More... | |
| class | RefundPaymentRequest |
| This request should be used to make a payment request using the RefundPayment method More... | |
| class | RefundPaymentResponse |
| Object passed in to OnRefundPaymentResponse More... | |
| class | RegisterForCustomerProvidedDataRequest |
| class | RejectPayment |
| Object passed in to OnRejectPayment More... | |
| class | ResetDeviceResponse |
| class | ResponseCodeExtension |
| class | RetrieveDeviceStatusResponse |
| response to RetrieveDeviceStatus call More... | |
| class | RetrievePaymentResponse |
| response to RetrievePayment call More... | |
| class | RetrievePendingPaymentsResponse |
| The response object for offline payments that have not been processed by the Clover device More... | |
| class | RetrievePrintersResponse |
| class | SaleRequest |
| This request should be used for a Sale call. More... | |
| class | SaleResponse |
| Object passed in to an OnSaleResponse More... | |
| class | SDKInfo |
| Descriptive information about this SDK More... | |
| class | SetCustomerInfoRequest |
| class | TipAdded |
| Pased in to OnTipAdded, when an on-screen tip is selected More... | |
| class | TipAdjustAuthRequest |
| This request should be used to make a request to adjust the tip amount on a payment obtained from an Auth request or payment after a CapturePreAuth request More... | |
| class | TipAdjustAuthResponse |
| Object passed in to OnTipAdjustAuthResponse More... | |
| class | TransactionRequest |
| Extended Sale/Auth Transaction Request More... | |
| class | TransactionStartResponse |
| class | TypeInfo |
| class | VaultCardResponse |
| Object passed in to an OnVaultCardResponse More... | |
| class | VerifySignatureRequest |
| Object passed in to VerifySignatureRequest. This must also be used to either accept or reject a signature as requested from the clover device. More... | |
| class | VoidPaymentRefundRequest |
| Voiding a payment refund (card present flows like canada region) More... | |
| class | VoidPaymentRefundResponse |
| Object passed in to OnVoidPaymentRefundResponse More... | |
| class | VoidPaymentRequest |
| Object passed in to request the voiding of a payment More... | |
| class | VoidPaymentResponse |
| Object passed in to OnVoidPaymentResopnse More... | |
Enumerations | |
| enum | ResponseCode { ResponseCode.SUCCESS, ResponseCode.FAIL, ResponseCode.UNSUPPORTED, ResponseCode.CANCEL, ResponseCode.ERROR } |
| enum | TipMode { TipMode.TIP_PROVIDED, TipMode.ON_SCREEN_BEFORE_PAYMENT, TipMode.NO_TIP } |
| enum | PrintJobStatus { PrintJobStatus.IN_QUEUE, PrintJobStatus.PRINTING, PrintJobStatus.DONE, PrintJobStatus.ERROR, PrintJobStatus.UNKNOWN, PrintJobStatus.NOT_FOUND } |
| enum | ExternalDeviceState { ExternalDeviceState.UNKNOWN, ExternalDeviceState.IDLE, ExternalDeviceState.BUSY, ExternalDeviceState.WAITING_FOR_POS, ExternalDeviceState.WAITING_FOR_CUSTOMER } |
| enum of current states of the Clover device. IDLE - device can handle new requests. Sale, CustomActivity, etc. BUSY - device will not response to new requests WAITING_FOR_POS - device is waiting for a response from the POS WAITING_FOR_CUSTOMER - device is waiting for the customer to take some action More... | |
|
strong |
enum of current states of the Clover device. IDLE - device can handle new requests. Sale, CustomActivity, etc. BUSY - device will not response to new requests WAITING_FOR_POS - device is waiting for a response from the POS WAITING_FOR_CUSTOMER - device is waiting for the customer to take some action
| Enumerator | |
|---|---|
| UNKNOWN | |
| IDLE | |
| BUSY | |
| WAITING_FOR_POS | |
| WAITING_FOR_CUSTOMER | |
Definition at line 898 of file TransactionBeans.cs.
|
strong |
| Enumerator | |
|---|---|
| IN_QUEUE | |
| PRINTING | |
| DONE | |
| ERROR | |
| UNKNOWN | |
| NOT_FOUND | |
Definition at line 662 of file TransactionBeans.cs.
|
strong |
| Enumerator | |
|---|---|
| SUCCESS | |
| FAIL | |
| UNSUPPORTED | |
| CANCEL | |
| ERROR | |
Definition at line 38 of file TransactionBeans.cs.
|
strong |
| Enumerator | |
|---|---|
| TIP_PROVIDED | |
| ON_SCREEN_BEFORE_PAYMENT | |
| NO_TIP | |
Definition at line 70 of file TransactionBeans.cs.
1.8.13