PPRetailPaymentDevice Class Reference
| Inherits from | PPRetailObject : NSObject |
|---|---|
| Declared in | PPRetailPaymentDevice.h |
Overview
A payment device represents the abstract concept of something that can read payment information from a customer. This includes card swipe readers, EMV readers, barcode scanners, biometric devices we don’t have yet, and DNA sequencers. Ok, not so much that last bit.
id
A unique identifier for the device @readonly
@property (nonatomic, strong, nullable, readonly) NSString *idDiscussion
A unique identifier for the device @readonly
Declared In
PPRetailPaymentDevice.h
address
Hardware address of this device
@property (nonatomic, strong, nullable) NSString *addressDiscussion
Hardware address of this device
Declared In
PPRetailPaymentDevice.h
name
A friendly name for the device @readonly
@property (nonatomic, strong, nullable, readonly) NSString *nameDiscussion
A friendly name for the device @readonly
Declared In
PPRetailPaymentDevice.h
model
The model of the card reader @readonly
@property (nonatomic, assign, readonly) PPRetailReaderModel modelDiscussion
The model of the card reader @readonly
Declared In
PPRetailPaymentDevice.h
serialNumber
The serial number of the device, if available @readonly
@property (nonatomic, strong, nullable, readonly) NSString *serialNumberDiscussion
The serial number of the device, if available @readonly
Declared In
PPRetailPaymentDevice.h
lastKnownBatteryInfo
Status of the device battery @readonly
@property (nonatomic, strong, nullable, readonly) PPRetailBatteryInfo *lastKnownBatteryInfoDiscussion
Status of the device battery @readonly
Declared In
PPRetailPaymentDevice.h
activated
shows if the device has any active transaction @readonly
@property (nonatomic, assign, readonly) BOOL activatedDiscussion
shows if the device has any active transaction @readonly
Declared In
PPRetailPaymentDevice.h
formFactors
The payment form factors this device can support @readonly
@property (nonatomic, strong, nullable, readonly) NSArray *formFactorsDiscussion
The payment form factors this device can support @readonly
Declared In
PPRetailPaymentDevice.h
pendingUpdate
Any pending software update for this device, or null if the device is current
@property (nonatomic, strong, nullable) PPRetailDeviceUpdate *pendingUpdateDiscussion
Any pending software update for this device, or null if the device is current
Declared In
PPRetailPaymentDevice.h
type
Indicates the type of reader @readonly
@property (nonatomic, assign, readonly) PPRetailreaderType typeDiscussion
Indicates the type of reader @readonly
Declared In
PPRetailPaymentDevice.h
connectionType
Indicates the connection channel of the reader @readonly
@property (nonatomic, assign, readonly) PPRetailreaderConnectionType connectionTypeDiscussion
Indicates the connection channel of the reader @readonly
Declared In
PPRetailPaymentDevice.h
cardInSlot
Indicates whether a card is inserted within the reader at this moment @readonly
@property (nonatomic, assign, readonly) BOOL cardInSlotDiscussion
Indicates whether a card is inserted within the reader at this moment @readonly
Declared In
PPRetailPaymentDevice.h
isBlacklisted
Indicates whether a card reader is blacklisted or not @readonly *
@property (nonatomic, assign, readonly) BOOL isBlacklistedDiscussion
Indicates whether a card reader is blacklisted or not @readonly *
Declared In
PPRetailPaymentDevice.h
– getManufacturer
EXTERNAL USE ONLY Get manufacturer of the device
- (NSString *_Nullable)getManufacturerDiscussion
EXTERNAL USE ONLY Get manufacturer of the device
Declared In
PPRetailPaymentDevice.h
– extractReaderLogs:
Extract logs from the device.
- (void)extractReaderLogs:(PPRetailPaymentDeviceDeviceLogsHandler _Nullable)callbackDiscussion
Extract logs from the device.
Declared In
PPRetailPaymentDevice.h
– isFormFactorActive:
Returns true if the passed FormFactor is active
- (BOOL)isFormFactorActive:(PPRetailFormFactor)formFactorDiscussion
Returns true if the passed FormFactor is active
Declared In
PPRetailPaymentDevice.h
– connect:
Connect to this device. A device connected event will be emitted once the device is connected
- (void)connect:(PPRetailPaymentDeviceConnectHandler _Nullable)callbackDiscussion
Connect to this device. A device connected event will be emitted once the device is connected
Declared In
PPRetailPaymentDevice.h
– retrieveBatteryInfo:
Query card reader for battery information
- (void)retrieveBatteryInfo:(PPRetailPaymentDeviceBatteryInfoHandler _Nullable)cbDiscussion
Query card reader for battery information
Declared In
PPRetailPaymentDevice.h
– disconnect:
Disconnect from the device.
- (void)disconnect:(PPRetailPaymentDeviceDisconnectHandler _Nullable)callbackDiscussion
Disconnect from the device.
Declared In
PPRetailPaymentDevice.h
– getVersionInfo
Gets the device version information
- (NSDictionary *_Nullable)getVersionInfoDiscussion
Gets the device version information
Declared In
PPRetailPaymentDevice.h
– isConnected
Return true if this device is connected
- (BOOL)isConnectedDiscussion
Return true if this device is connected
Declared In
PPRetailPaymentDevice.h
– isReadyForTransaction
Indicates if the device is ready for transaction
- (PPRetailDeviceStatus *_Nullable)isReadyForTransactionDiscussion
Indicates if the device is ready for transaction
Declared In
PPRetailPaymentDevice.h
– doesHaveCapability:
Return true if this device has the requested capability
- (BOOL)doesHaveCapability:(PPRetaildeviceCapabilityType)capabilityDiscussion
Return true if this device has the requested capability
Declared In
PPRetailPaymentDevice.h
– addConnectedListener:
Add a listener for the connected event
- (PPRetailConnectedSignal _Nullable)addConnectedListener:(PPRetailConnectedEvent _Nullable)listenerReturn Value
PPRetailConnectedSignal an object that can be used to remove the listener when you’re done with it.
Discussion
Add a listener for the connected event
Declared In
PPRetailPaymentDevice.h
– removeConnectedListener:
Remove a listener for the connected event given the signal object that was returned from addConnectedListener
- (void)removeConnectedListener:(PPRetailConnectedSignal _Nullable)listenerTokenDiscussion
Remove a listener for the connected event given the signal object that was returned from addConnectedListener
Declared In
PPRetailPaymentDevice.h
– addSelectedListener:
Add a listener for the selected event
- (PPRetailSelectedSignal _Nullable)addSelectedListener:(PPRetailSelectedEvent _Nullable)listenerReturn Value
PPRetailSelectedSignal an object that can be used to remove the listener when you’re done with it.
Discussion
Add a listener for the selected event
Declared In
PPRetailPaymentDevice.h
– removeSelectedListener:
Remove a listener for the selected event given the signal object that was returned from addSelectedListener
- (void)removeSelectedListener:(PPRetailSelectedSignal _Nullable)listenerTokenDiscussion
Remove a listener for the selected event given the signal object that was returned from addSelectedListener
Declared In
PPRetailPaymentDevice.h
– addConnectionErrorListener:
Add a listener for the connectionError event
- (PPRetailConnectionErrorSignal _Nullable)addConnectionErrorListener:(PPRetailConnectionErrorEvent _Nullable)listenerReturn Value
PPRetailConnectionErrorSignal an object that can be used to remove the listener when you’re done with it.
Discussion
Add a listener for the connectionError event
Declared In
PPRetailPaymentDevice.h
– removeConnectionErrorListener:
Remove a listener for the connectionError event given the signal object that was returned from addConnectionErrorListener
- (void)removeConnectionErrorListener:(PPRetailConnectionErrorSignal _Nullable)listenerTokenDiscussion
Remove a listener for the connectionError event given the signal object that was returned from addConnectionErrorListener
Declared In
PPRetailPaymentDevice.h
– addDisconnectedListener:
Add a listener for the disconnected event
- (PPRetailDisconnectedSignal _Nullable)addDisconnectedListener:(PPRetailDisconnectedEvent _Nullable)listenerReturn Value
PPRetailDisconnectedSignal an object that can be used to remove the listener when you’re done with it.
Discussion
Add a listener for the disconnected event
Declared In
PPRetailPaymentDevice.h
– removeDisconnectedListener:
Remove a listener for the disconnected event given the signal object that was returned from addDisconnectedListener
- (void)removeDisconnectedListener:(PPRetailDisconnectedSignal _Nullable)listenerTokenDiscussion
Remove a listener for the disconnected event given the signal object that was returned from addDisconnectedListener
Declared In
PPRetailPaymentDevice.h
– addUpdateRequiredListener:
Add a listener for the updateRequired event
- (PPRetailUpdateRequiredSignal _Nullable)addUpdateRequiredListener:(PPRetailUpdateRequiredEvent _Nullable)listenerReturn Value
PPRetailUpdateRequiredSignal an object that can be used to remove the listener when you’re done with it.
Discussion
Add a listener for the updateRequired event
Declared In
PPRetailPaymentDevice.h
– removeUpdateRequiredListener:
Remove a listener for the updateRequired event given the signal object that was returned from addUpdateRequiredListener
- (void)removeUpdateRequiredListener:(PPRetailUpdateRequiredSignal _Nullable)listenerTokenDiscussion
Remove a listener for the updateRequired event given the signal object that was returned from addUpdateRequiredListener
Declared In
PPRetailPaymentDevice.h
– addBatteryStatusUpdateListener:
Add a listener for the batteryStatusUpdate event
- (PPRetailBatteryStatusUpdateSignal _Nullable)addBatteryStatusUpdateListener:(PPRetailBatteryStatusUpdateEvent _Nullable)listenerReturn Value
PPRetailBatteryStatusUpdateSignal an object that can be used to remove the listener when you’re done with it.
Discussion
Add a listener for the batteryStatusUpdate event
Declared In
PPRetailPaymentDevice.h
– removeBatteryStatusUpdateListener:
Remove a listener for the batteryStatusUpdate event given the signal object that was returned from addBatteryStatusUpdateListener
- (void)removeBatteryStatusUpdateListener:(PPRetailBatteryStatusUpdateSignal _Nullable)listenerTokenDiscussion
Remove a listener for the batteryStatusUpdate event given the signal object that was returned from addBatteryStatusUpdateListener
Declared In
PPRetailPaymentDevice.h
– addCardRemovedListener:
Add a listener for the cardRemoved event
- (PPRetailCardRemovedSignal _Nullable)addCardRemovedListener:(PPRetailCardRemovedEvent _Nullable)listenerReturn Value
PPRetailCardRemovedSignal an object that can be used to remove the listener when you’re done with it.
Discussion
Add a listener for the cardRemoved event
Declared In
PPRetailPaymentDevice.h
– removeCardRemovedListener:
Remove a listener for the cardRemoved event given the signal object that was returned from addCardRemovedListener
- (void)removeCardRemovedListener:(PPRetailCardRemovedSignal _Nullable)listenerTokenDiscussion
Remove a listener for the cardRemoved event given the signal object that was returned from addCardRemovedListener
Declared In
PPRetailPaymentDevice.h
– addCardPresentedListener:
Add a listener for the cardPresented event
- (PPRetailCardPresentedSignal _Nullable)addCardPresentedListener:(PPRetailCardPresentedEvent _Nullable)listenerReturn Value
PPRetailCardPresentedSignal an object that can be used to remove the listener when you’re done with it.
Discussion
Add a listener for the cardPresented event
Declared In
PPRetailPaymentDevice.h
– removeCardPresentedListener:
Remove a listener for the cardPresented event given the signal object that was returned from addCardPresentedListener
- (void)removeCardPresentedListener:(PPRetailCardPresentedSignal _Nullable)listenerTokenDiscussion
Remove a listener for the cardPresented event given the signal object that was returned from addCardPresentedListener
Declared In
PPRetailPaymentDevice.h
– addBlacklistedListener:
Add a listener for the blacklisted event
- (PPRetailBlacklistedSignal _Nullable)addBlacklistedListener:(PPRetailBlacklistedEvent _Nullable)listenerReturn Value
PPRetailBlacklistedSignal an object that can be used to remove the listener when you’re done with it.
Discussion
Add a listener for the blacklisted event
Declared In
PPRetailPaymentDevice.h
– removeBlacklistedListener:
Remove a listener for the blacklisted event given the signal object that was returned from addBlacklistedListener
- (void)removeBlacklistedListener:(PPRetailBlacklistedSignal _Nullable)listenerTokenDiscussion
Remove a listener for the blacklisted event given the signal object that was returned from addBlacklistedListener
Declared In
PPRetailPaymentDevice.h