DeviceStatus Class Reference

This class represents the current status of a device connected to the SDK. More...

#import <DeviceStatus.h>

Inherits NSObject.

Class Methods
(DeviceStatusEnum)	+ getDeviceStatusEnum:
(NSString *)	+ getDeviceStatusString:

Properties
DeviceStatusEnum	deviceStatus
NSString *	availablityError
NSDictionary *	errorInformation
NSString *	name
NSString *	make
NSString *	model
NSString *	firmwareName
NSString *	firmwareVersion
NSString *	serialNumber
NSString *	pinPadRevision
NSString *	pinPadOsVersion
NSString *	pinPadKernelVersion
NSInteger	batteryChargePercentage
NSInteger	rawBatteryChargePercentage
NSString *	batteryChargingStatus
NSString *	batteryChargingStatusUpdateDateTime
NSString *	batteryChargingStatusUpdateDateTimeFormat

Detailed Description

This class represents the current status of a device connected to the SDK.

Author

Creditcall Ltd

Copyright

Copyright Creditcall Limited 2010 - 2017.

Method Documentation

getDeviceStatusEnum:

+ (DeviceStatusEnum) getDeviceStatusEnum:

(NSString *)

deviceStatusStr

Convert string constant into DeviceStatusEnum.

getDeviceStatusString:

+ (NSString *) getDeviceStatusString:

(DeviceStatusEnum)

deviceStatusEnum

Convert DeviceStatusEnum into string constant.

Property Documentation

availablityError

- (NSString*) availablityError

readnonatomicstrong

If filled the error why the device is currently unavailable.

batteryChargePercentage

- (NSInteger) batteryChargePercentage

readnonatomicassign

Battery charge percentage of the currently connected device.

batteryChargingStatus

- (NSString*) batteryChargingStatus

readnonatomicstrong

Charging status of the currently connected device. Returns "Not Charging", "Charging" or "Fully Charged".

batteryChargingStatusUpdateDateTime

- (NSString*) batteryChargingStatusUpdateDateTime

readnonatomicstrong

Date and time for the last battery charging status update of the currently connected device. Returned using the local date, time, and time zone of the mobile device. Format specified by batteryChargingStatusUpdateDateTimeFormat.

batteryChargingStatusUpdateDateTimeFormat

- (NSString*) batteryChargingStatusUpdateDateTimeFormat

readnonatomicstrong

Date and time format used for batteryChargingStatusUpdateDateTime. Returns "dd/MM/yyyy HH:mm:ss".

deviceStatus

- (DeviceStatusEnum) deviceStatus

readnonatomicassign

The current connection status of the device.

errorInformation

- (NSDictionary*) errorInformation

readnonatomicstrong

NSDictionary containing key value pairs with information about the availablilityError.

firmwareName

- (NSString*) firmwareName

readnonatomicstrong

Firmware name of the currently connected device.

firmwareVersion

- (NSString*) firmwareVersion

readnonatomicstrong

Firmware version of the currently connected device.

make

- (NSString*) make

readnonatomicstrong

Make of the currently connected device.

model

- (NSString*) model

readnonatomicstrong

Model of the currently connected device.

name

- (NSString*) name

readnonatomicstrong

PIN pad name of currently connected device.

pinPadKernelVersion

- (NSString*) pinPadKernelVersion

readnonatomicstrong

Kernel version of the connected PIN pad.

pinPadOsVersion

- (NSString*) pinPadOsVersion

readnonatomicstrong

Operating system version of the connected PIN pad.

pinPadRevision

- (NSString*) pinPadRevision

readnonatomicstrong

Revision of currently connected PIN pad.

rawBatteryChargePercentage

- (NSInteger) rawBatteryChargePercentage

readnonatomicassign

Raw Battery charge percentage of the currently connected device,

serialNumber

- (NSString*) serialNumber

readnonatomicstrong

Serial number of currently connected PIN pad.

---

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

• DeviceStatus.h