CloverConnector  4.0.0
Copyright (C) 2018 Clover Network, Inc.
com.clover.remotepay.sdk.CloverConnectorFactory Class Reference

Factory to create an instance of the CloverConnector. More...

Static Public Member Functions

static ICloverConnector createICloverConnector (CloverDeviceConfiguration config)
 Factory to create an instance of the CloverConnector More...
 
static ICloverConnector CreateUsbConnector (string remoteApplicationId, string posName, string serialNumber, bool enableLogging=false)
 Create a USB configured connection CloverConnector to a Clover Device running USB Pay Display (UsbPD) Convenience wrapper around creating a USBCloverDeviceConfiguration object and calling CloverConnectorFactory.createICloverConnector More...
 
static ICloverConnector CreateWebSocketConnector (string endpoint, string remoteApplicationId, string posName, string serialNumber, string pairingAuthToken, PairingDeviceConfiguration.OnPairingCodeHandler pairingCodeHandler, PairingDeviceConfiguration.OnPairingSuccessHandler pairingSuccessHandler, PairingDeviceConfiguration.OnPairingStateHandler pairingStateHandler, bool enableLogging=false)
 Create a WebSockect configured connection CloverConnector to a Clover Device running Secure Network Pay Display (SNPD) Convenience wrapper around creating a WebSocketCloverDeviceConfiguration object and calling CloverConnectorFactory.createICloverConnector More...
 

Detailed Description

Factory to create an instance of the CloverConnector.

Definition at line 22 of file CloverConnectorFactory.cs.

Member Function Documentation

◆ createICloverConnector()

static ICloverConnector com.clover.remotepay.sdk.CloverConnectorFactory.createICloverConnector ( CloverDeviceConfiguration  config)
static

Factory to create an instance of the CloverConnector

Parameters
configObject that conveys the required information used by the connector. Usually a USBCloverDeviceConfiguration (USB connection) or WebSocketCloverDeviceConfiguration (Network/SNPD connection)
Returns
Initialized instance conforming to the ICloverConnector

Definition at line 30 of file CloverConnectorFactory.cs.

◆ CreateUsbConnector()

static ICloverConnector com.clover.remotepay.sdk.CloverConnectorFactory.CreateUsbConnector ( string  remoteApplicationId,
string  posName,
string  serialNumber,
bool  enableLogging = false 
)
static

Create a USB configured connection CloverConnector to a Clover Device running USB Pay Display (UsbPD) Convenience wrapper around creating a USBCloverDeviceConfiguration object and calling CloverConnectorFactory.createICloverConnector

Parameters
remoteApplicationIdApplication ID for server reporting
posNamePoint of Sale name for server reporting
serialNumberStation ID / serial number for server reporting
enableLoggingTurn logging on or off
Returns

Definition at line 44 of file CloverConnectorFactory.cs.

◆ CreateWebSocketConnector()

static ICloverConnector com.clover.remotepay.sdk.CloverConnectorFactory.CreateWebSocketConnector ( string  endpoint,
string  remoteApplicationId,
string  posName,
string  serialNumber,
string  pairingAuthToken,
PairingDeviceConfiguration.OnPairingCodeHandler  pairingCodeHandler,
PairingDeviceConfiguration.OnPairingSuccessHandler  pairingSuccessHandler,
PairingDeviceConfiguration.OnPairingStateHandler  pairingStateHandler,
bool  enableLogging = false 
)
static

Create a WebSockect configured connection CloverConnector to a Clover Device running Secure Network Pay Display (SNPD) Convenience wrapper around creating a WebSocketCloverDeviceConfiguration object and calling CloverConnectorFactory.createICloverConnector

Parameters
endpointClover Device Secure Network Pay Display (SNPD) network address, usually similar to "https://192.168.0.1:1234/remote_pay"
remoteApplicationIdApplication ID for server reporting
posNamePoint of Sale name for server reporting
serialNumberStation ID / serial number for server reporting
pairingAuthTokenPrevious paired auth token to allow quick reconnection without initiating antoerh pairing. Blank value, invalid or expired token will initiate a new pairing
pairingCodeHandlerDelegate method called with temporary pairing code to enter on device, like 6341 - display to user to enter on Clover Device to complete pairing
pairingSuccessHandlerDelegate method called with reconnection auth token when pairing has succeeded
pairingStateHandlerDelegate method called during pairing flow transitions
enableLoggingTurn logging on or off
Returns

Definition at line 64 of file CloverConnectorFactory.cs.


The documentation for this class was generated from the following file: