Cat Class

Definition

Namespace:

Microsoft.PointOfService

Assembly:

Microsoft.PointOfService.dll

Defines the programmatic interface for a UPOS credit authorization terminal (CAT) device.

public abstract class Cat : Microsoft.PointOfService.PosCommon

type Cat = class
    inherit PosCommon

Public MustInherit Class Cat
Inherits PosCommon

Inheritance

Object

PosDevice

PosCommon

Cat

Derived

Microsoft.PointOfService.BasicServiceObjects.CatBasic

Constructors

Cat()

Creates an instance of the Cat class.

Fields

ExtendedErrorCenterError	Indicates an error was returned from the approval agency in CenterResultCode.
ExtendedErrorCommandError	Indicates the command sent to the CAT is incorrect.
ExtendedErrorCommunicationError	Indicates a communication error has occurred between the approval agency and the CAT.
ExtendedErrorDailyLogOverflow	Indicates the daily log is too big to be stored.
ExtendedErrorDeficient	Indicates the balance is insufficient for an electronic money device. The device cannot close the settlement.
ExtendedErrorFirmwareBadFile	Indicates the specified firmware file or files exist, but one or more of those files are either not in the correct format or are corrupted. (Inherited from PosCommon)
ExtendedErrorOverDeposit	Indicates a failure occurs for an electronic money device if the attempted settlement amount exceeds the charge account limit.
ExtendedErrorReset	Indicates the CAT was stopped during processing by the CAT Reset key or Stop key.
ExtendedErrorStatistics	Indicates a specified statistic could not be reset or updated. (Inherited from PosCommon)
ExtendedErrorStatisticsDependency	(Inherited from PosCommon)
StatisticCommunicationErrorCount	Holds the programmatic name of the Communication Error Count common statistic. (Inherited from PosCommon)
StatisticDeviceCategory	Holds the programmatic name of the Device Category common statistic. (Inherited from PosCommon)
StatisticFirmwareRevision	Holds the programmatic name of the Firmware Revision common statistic. (Inherited from PosCommon)
StatisticHoursPoweredCount	Holds the programmatic name of the Hours Powered On common statistic. (Inherited from PosCommon)
StatisticInstallationDate	Holds the programmatic name of the Installation Date common statistic. (Inherited from PosCommon)
StatisticInterface	Holds the programmatic name of the Interface common statistic. (Inherited from PosCommon)
StatisticManufactureDate	Holds the programmatic name of the Manufacture Date common statistic. (Inherited from PosCommon)
StatisticManufacturerName	Holds the programmatic name of the Manufacturer Name common statistic. (Inherited from PosCommon)
StatisticMechanicalRevision	Holds the programmatic name of the Mechanical Revision common statistic. (Inherited from PosCommon)
StatisticModelName	Holds the programmatic name of the Model Name common statistic. (Inherited from PosCommon)
StatisticSerialNumber	Holds the programmatic name of the Serial Number common statistic. (Inherited from PosCommon)
StatisticUnifiedPOSVersion	Holds the programmatic name of the Unified POS Version common statistic. (Inherited from PosCommon)
StatusPowerOff	Indicates that the device’s power is turned off or it is detached from the terminal. (Inherited from PosCommon)
StatusPowerOffline	Indicates that the device is powered on but is either not ready or unable to respond to requests. (Inherited from PosCommon)
StatusPowerOffOffline	Indicates that either the device’s power is off or it is offline. (Inherited from PosCommon)
StatusPowerOnline	Indicates that the device’s power is turned on and it is ready for use. (Inherited from PosCommon)
StatusUpdateFirmwareComplete	Indicates the update firmware process has completed successfully. (Inherited from PosCommon)
StatusUpdateFirmwareCompleteDeviceNotRestored	Indicates the update firmware process succeeded. However, the Service Object and/or the physical device cannot be returned to the state they were in before the update firmware process started. (Inherited from PosCommon)
StatusUpdateFirmwareFailedDeviceNeedsFirmware	Indicates the update firmware process failed. The device will not be operational until another attempt to update the firmware is successful. (Inherited from PosCommon)
StatusUpdateFirmwareFailedDeviceOk	Indicates the update firmware process failed. However, the device is still operational. (Inherited from PosCommon)
StatusUpdateFirmwareFailedDeviceUnknown	Indicates the update firmware process failed. The device is in an indeterminate state. (Inherited from PosCommon)
StatusUpdateFirmwareFailedDeviceUnrecoverable	Indicates the update firmware process failed. The device is either unusable or unrecoverable through software. (Inherited from PosCommon)
StatusUpdateFirmwareProgress	Indicates the update firmware process has completed 1 to 100 percent successfully. (Inherited from PosCommon)
WaitForever	Used as the value for a timeout parameter in common and device-specific methods to indicate the method should wait until it receives a response, instead of timing out. (Inherited from PosCommon)

Properties

AccountNumber	Gets the credit card number of the settled account.
AdditionalSecurityInformation	Gets or sets additional security information for an authorization operation.
ApprovalCode	Gets the credit approval code.
AsyncMode	Gets or sets the Boolean value that indicates whether the authorization runs asynchronously.
Balance	Gets a credit card balance.
CapAdditionalSecurityInformation	Gets the Boolean value that indicates whether the AdditionalSecurityInformation property can be used.
CapAuthorizeCompletion	Gets the Boolean value that indicates whether the AuthorizeCompletion(Int32, Decimal, Decimal, Int32) method is implemented.
CapAuthorizePreSales	Gets the Boolean value that indicates whether the AuthorizePreSales(Int32, Decimal, Decimal, Int32) method is implemented.
CapAuthorizeRefund	Gets the Boolean value that indicates whether the AuthorizeRefund(Int32, Decimal, Decimal, Int32) method is implemented.
CapAuthorizeVoid	Gets the Boolean value that indicates whether the AuthorizeVoid(Int32, Decimal, Decimal, Int32) method is implemented.
CapAuthorizeVoidPreSales	Gets the Boolean value that indicates whether the AuthorizeVoidPreSales(Int32, Decimal, Decimal, Int32) method is implemented.
CapCashDeposit	Gets the Boolean value that indicates whether the CashDeposit(Int32, Decimal, Int32) method is implemented.
CapCenterResultCode	Gets the Boolean value that indicates whether the CenterResultCode method is implemented.
CapCheckCard	Gets the Boolean value that indicates whether the CheckCard(Int32, Int32) method is implemented.
CapCompareFirmwareVersion	Gets a Boolean value that indicates whether the Service Object/device supports comparing the firmware version in the physical device against that of a firmware file. (Inherited from PosCommon)
CapDailyLog	Gets the daily log ability of the device.
CapInstallments	Gets the Boolean value that indicates whether the "Installments" item is provided.
CapLockTerminal	Gets a Boolen value that indicates whether the device has a security lock and can set it.
CapLogStatus	Gets a Boolen value that indicates whether the device can give information about the status of the log.
CapPaymentDetail	Gets the Boolean value that indicates whether the PaymentDetail property is implemented.
CapPowerReporting	Gets the power reporting capabilities of the device. (Inherited from PosCommon)
CapStatisticsReporting	Gets a Boolean value that indicates whether the device can accumulate and can provide various statistics regarding usage. (Inherited from PosCommon)
CapTaxOthers	Gets the Boolean value that indicates whether the item "TaxOthers" is provided.
CapTrainingMode	Gets the Boolean value that indicates whether the TrainingMode property is implemented.
CapTransactionNumber	Gets the Boolean value that indicates whether the TransactionNumber property is implemented.
CapUnlockTerminal	Gets the Boolean value that indicates whether the security lock can be released.
CapUpdateFirmware	Gets a Boolean value that indicates whether the device's firmware can be updated through the UpdateFirmware method. (Inherited from PosCommon)
CapUpdateStatistics	Gets a Boolean value that indicates whether some or all the device statistics can be reset to 0 (zero) by using the ResetStatistic and ResetStatistics methods, or updated by using the UpdateStatistic and UpdateStatistics methods. (Inherited from PosCommon)
CardCompanyId	Gets the credit card company ID.
CenterResultCode	Gets the code from the approval agency.
CheckHealthText	Gets a string that indicates the health of the device. (Inherited from PosCommon)
Claimed	Gets a Boolean value that indicates whether the device is claimed for exclusive access. (Inherited from PosCommon)
Compatibility	(Inherited from PosDevice)
DailyLog	Gets the result of the AccessDailyLog(Int32, CatLogs, Int32) method.
DeviceDescription	Gets a string identifying the device and the company that manufactured it. (Inherited from PosCommon)
DeviceEnabled	Gets or sets a Boolean value that indicates whether the device has been placed in an operational state. (Inherited from PosCommon)
DeviceInstanceId	(Inherited from PosCommon)
DeviceName	Gets a short string identifying the device and any pertinent information about it. (Inherited from PosCommon)
DevicePath	Gets or sets the hardware path of a device. (Inherited from PosCommon)
FreezeEvents	Gets or sets a Boolean value that indicates whether the application has requested that the Service Object not deliver events. (Inherited from PosCommon)
HardwareId	(Inherited from PosCommon)
IsExclusiveUseDevice	Gets the Boolean value that indicates whether the credit authorization terminal is an exclusive-use device.
LogStatus	Gets the status of the dealing log of the CAT device.
OutputId	Gets the identifier of the most recently started asynchronous output.
PaymentCondition	Gets the payment condition of the most recent successful authorization operation.
PaymentDetail	Gets payment condition details as the result of an authorization operation.
PaymentMedia	Gets or sets the payment media type that the approval method should approve.
PowerNotify	Gets or sets the type of power notification selection made by the application. (Inherited from PosCommon)
PowerState	Gets the current power condition. (Inherited from PosCommon)
SequenceNumber	Gets a "sequence number" as the result of each method call.
ServiceObjectDescription	Gets a string identifying the Service Object that supports the device and the company that produced it. (Inherited from PosCommon)
ServiceObjectVersion	Gets the Service Object version number. (Inherited from PosCommon)
SettledAmount	Gets the amount of the settlement for an electronic money device.
SlipNumber	Gets a "slip number" as the result of each authorization operation.
State	Gets the current state of the device. (Inherited from PosCommon)
SynchronizingObject	Gets or sets the object that is used to marshal the event handler calls issued because of a POS event. (Inherited from PosCommon)
TrainingMode	Gets or sets the Boolean value that indicates whether each operation is run in training mode.
TransactionNumber	Gets a transaction number as the result of each authorization operation.
TransactionType	Gets a transaction number as the result of each authorization operation.

Methods

AccessDailyLog(Int32, CatLogs, Int32)	Gets the daily log from CAT.
AuthorizeCompletion(Int32, Decimal, Decimal, Int32)	Authorizes the purchase after approval.
AuthorizePreSales(Int32, Decimal, Decimal, Int32)	Preauthorizes a purchase.
AuthorizeRefund(Int32, Decimal, Decimal, Int32)	Approves a refund for a purchase.
AuthorizeSales(Int32, Decimal, Decimal, Int32)	Approves a purchase.
AuthorizeVoid(Int32, Decimal, Decimal, Int32)	Approves cancellation of a purchase.
AuthorizeVoidPreSales(Int32, Decimal, Decimal, Int32)	Preauthorizes a cancellation.
CashDeposit(Int32, Decimal, Int32)	Charges the specified amount of money to the account.
CheckCard(Int32, Int32)	Indicates that a card check is intended.
CheckHealth(HealthCheckLevel)	Tests the state of a device. (Inherited from PosCommon)
Claim(Int32)	Requests exclusive access to the device. (Inherited from PosCommon)
ClearOutput()	Clears outputs that have been buffered for the unit.
Close()	Releases the device and its resources. (Inherited from PosCommon)
CompareFirmwareVersion(String)	Determines whether the version of the specified firmware is newer than, older than, or the same as the version of firmware in the physical device. (Inherited from PosCommon)
DeleteConfigurationProperty(String)	Deletes the specified property from the XML configuration file. (Inherited from PosCommon)
DirectIO(Int32, Int32, Object)	Used to communicate directly with the Service Object. (Inherited from PosCommon)
GetConfigurationProperty(String)	Used by the Service Object to retrieve the specified property from the XML configuration file. (Inherited from PosCommon)
Invoke(Delegate, Object[])	Used by the Service Objects to raise an event. (Inherited from PosCommon)
LockTerminal()	Sets the security lock.
Open()	Opens a device for later input/output processing. (Inherited from PosCommon)
Release()	Releases exclusive access to the device. (Inherited from PosCommon)
ResetStatistic(String)	Resets the specified statistic to 0 (zero). (Inherited from PosCommon)
ResetStatistics()	Resets all statistics associated with a device to 0 (zero). (Inherited from PosCommon)
ResetStatistics(StatisticCategories)	Resets all statistics for a specified category to 0 (zero). (Inherited from PosCommon)
ResetStatistics(String[])	Resets the specified statistics to 0 (zero). (Inherited from PosCommon)
RetrieveStatistic(String)	Retrieves the specified device statistic. (Inherited from PosCommon)
RetrieveStatistics()	Retrieves all device statistics. (Inherited from PosCommon)
RetrieveStatistics(StatisticCategories)	Retrieves the statistics for the specified category. (Inherited from PosCommon)
RetrieveStatistics(String[])	Retrieves the specified statistics. (Inherited from PosCommon)
SetConfigurationProperty(String, String)	Sets a property value (or create a new property) in the XML configuration file. (Inherited from PosCommon)
UnlockTerminal()	Releases the security lock.
UpdateFirmware(String)	Updates the firmware of a device with the version of the firmware contained or defined in the file specified by the firmwareFileName parameter regardless of whether that firmware’s version is newer than, older than, or the same as the version of the firmware already in the device. (Inherited from PosCommon)
UpdateStatistic(String, Object)	Updates the value of a specified device statistic. (Inherited from PosCommon)
UpdateStatistics(Statistic[])	Updates a list of statistics with the corresponding specified values. (Inherited from PosCommon)
UpdateStatistics(StatisticCategories, Object)	Updates the specified category of statistics with the specified value. (Inherited from PosCommon)

Events

DeviceAddedEvent	(Inherited from PosCommon)
DeviceRemovedEvent	(Inherited from PosCommon)
DirectIOEvent	Raised by the Service Object to communicate information directly to the application. (Inherited from PosCommon)
ErrorEvent	Notifies the application that a CAT error has been detected and suitable response by the application is necessary to process the error condition.
OutputCompleteEvent	Notifies the application that the queued output request associated with the OutputId property has completed successfully.
StatusUpdateEvent	Raised by the Service Object to alert the application of a device status change. (Inherited from PosCommon)