Windows.Devices.PointOfService Namespace
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Enables application developers to access Point of Service (POS) peripheral devices. The namespace provides a vendor-neutral interface for accessing POS devices from various manufacturers from the UWP app.
Also see the UnifiedPOS architectural specification.
Important classes | Description |
---|---|
BarcodeScanner | Enables application developers to access barcode scanners to retrieve decoded data from a variety of barcode symbologies such as UPC and QR Codes depending on support from the hardware. |
CashDrawer | Enables application developers to interact with cash drawers. |
LineDisplay | Enables application developers to control customer facing 2x20 line displays. |
MagneticStripeReader | Enables application developers to access magnetic stripe readers to retrieve data from magnetic stripe enabled cards such as credit/debit cards, loyalty cards, access cards, etc. |
POSPrinter | Enables application developers to print to network and Bluetooth connected receipt printers using the Epson ESC/POS printer control language. |
Common APIs | Description |
---|---|
UnifiedPosErrorData class | Provides error information. |
UnifiedPosErrorReason enumeration | Defines the constants that indicates the reason for the error event. |
UnifiedPosErrorSeverity enumeration | Defines the constants that indicates the error severity. |
UnifiedPosHealthCheckLevel enumeration | Defines the constants that indicates the type of health check that can be performed on the devices. |
UnifiedPosPowerReportingType enumeration | Defines the constants that indicates power reporting capabilities of the Point of Service (POS) device. |
Classes
BarcodeScanner |
Represents the barcode scanner device. |
BarcodeScannerCapabilities |
Represents the barcode scanner capabilities. |
BarcodeScannerDataReceivedEventArgs |
Provides the barcode data from the DataReceived event. |
BarcodeScannerErrorOccurredEventArgs |
Provides data for the ErrorOccurred event. |
BarcodeScannerImagePreviewReceivedEventArgs |
Provides the data from the ImagePreviewReceived event. |
BarcodeScannerReport |
Contains the barcode scanner data. |
BarcodeScannerStatusUpdatedEventArgs |
Provides information about an operation status change. |
BarcodeSymbologies |
Contains the barcode symbology. |
BarcodeSymbologyAttributes |
The attributes of a barcode scanner symbology. |
CashDrawer |
A cash drawer device in a retail scenario. |
CashDrawerCapabilities |
Represents the cash drawer capabilities. |
CashDrawerCloseAlarm |
The cash drawer close alarm. Parameter defaults are provided, however the user can update them as appropriate. |
CashDrawerClosedEventArgs |
This object is passed as a parameter to the event handlers for the DrawerClosed event. |
CashDrawerEventSource |
Provides event sources that allow a developer to detect when the cash drawer is opened or closed. |
CashDrawerOpenedEventArgs |
This object is passed as a parameter to the event handlers for the DrawerOpened event. |
CashDrawerStatus |
Provides the current power and availability status of the cash drawer. |
CashDrawerStatusUpdatedEventArgs |
This object is passed as a parameter to the event handlers for the StatusUpdated event. |
ClaimedBarcodeScanner |
Represents the claimed barcode scanner. |
ClaimedBarcodeScannerClosedEventArgs |
This object is passed as a parameter to the event handlers for the ClaimedBarcodeScanner.Closed event. |
ClaimedCashDrawer |
Provides access to exclusive and privileged methods, properties, and events on a point-of-service cash drawer device. |
ClaimedCashDrawerClosedEventArgs |
This object is passed as a parameter to the event handlers for the ClaimedCashDrawer.Closed event. |
ClaimedJournalPrinter |
Represents a journal printer station that has been claimed for use. |
ClaimedLineDisplay |
Represents a claimed line display device. |
ClaimedLineDisplayClosedEventArgs |
This object is passed as a parameter to the event handlers for the ClaimedLineDisplay.Closed event. |
ClaimedMagneticStripeReader |
Represents the claimed magnetic stripe reader. |
ClaimedMagneticStripeReaderClosedEventArgs |
This object is passed as a parameter to the event handlers for the ClaimedMagneticStripeReader.Closed event. |
ClaimedPosPrinter |
Represent a point-of-service printer that has been claimed for use. |
ClaimedPosPrinterClosedEventArgs |
This object is passed as a parameter to the event handlers for the ClaimedPosPrinter.Closed event. |
ClaimedReceiptPrinter |
Represents a receipt printer station that has been claimed for use. |
ClaimedSlipPrinter |
Represents a slip printer station that has been claimed for use. |
JournalPrinterCapabilities |
Represents the capabilities of journal station of a point-of-service printer. |
JournalPrintJob |
Represents a set of printing instructions that you want to run on the journal printer station. |
LineDisplay |
Represents a line display device. |
LineDisplayAttributes |
Represents the attributes of a line display device. |
LineDisplayCapabilities |
Represents the line display capabilities. |
LineDisplayCursor |
Represents a line display cursor. |
LineDisplayCursorAttributes |
Represents the attributes of a line display cursor. |
LineDisplayCustomGlyphs |
Represents a set of custom glyphs to be used by a line display. |
LineDisplayMarquee |
Represents an object containing properties describing and allowing control of marquee scrolling on a line display. |
LineDisplayStatisticsCategorySelector |
Represents a standard statistics category selector. |
LineDisplayStatusUpdatedEventArgs |
Provides event data for power state changes in the line display device. |
LineDisplayStoredBitmap |
Represents an object used to store a bitmap via the LineDisplayWindow.StoreBitmapAsync method. |
LineDisplayWindow |
Represents a line display window. |
MagneticStripeReader |
Represents the magnetic stripe reader device. |
MagneticStripeReaderAamvaCardDataReceivedEventArgs |
Provides the American Association of Motor Vehicle Administrators (AAMVA) card data from the AamvaCardDataReceived event. |
MagneticStripeReaderBankCardDataReceivedEventArgs |
Provides bank card data from the BankCardDataReceived event. |
MagneticStripeReaderCapabilities |
Provides capabilities information for the magnetic stripe reader. |
MagneticStripeReaderCardTypes |
Contains the card type of the recently swiped card. |
MagneticStripeReaderEncryptionAlgorithms |
Contains the encryption algorithm supported by the device. |
MagneticStripeReaderErrorOccurredEventArgs |
Provides error information for the ErrorOccurred event. |
MagneticStripeReaderReport |
Contains data from the recently swiped card. |
MagneticStripeReaderStatusUpdatedEventArgs |
Provides information about an operation status change. |
MagneticStripeReaderTrackData |
Contains the track data obtained following a card swipe. |
MagneticStripeReaderVendorSpecificCardDataReceivedEventArgs |
Provides data for the recently swiped vendor card. |
PaymentDevice | |
PaymentDeviceCapabilities | |
PaymentDeviceConfiguration | |
PaymentDeviceGetConfigurationResult | |
PaymentDeviceOperationResult | |
PaymentDeviceTransactionRequest | |
PaymentDeviceTransactionResult | |
PaymentMethod | |
PosPrinter |
Represents a point-of-service printer. |
PosPrinterCapabilities |
Represents the capabilities of the point-of-service printer. |
PosPrinterCharacterSetIds |
Represents the set of identifiers for the character sets that a point-of-service printer can use. |
PosPrinterFontProperty |
Represents the property of a specific point-of-service printer font. |
PosPrinterPrintOptions |
Represents the print options of the text that you want to print to a point-of-service printer. |
PosPrinterReleaseDeviceRequestedEventArgs |
Provides information about the ClaimedPosPrinter.ReleaseDeviceRequested event that occurs when a point-of-service printer gets a request to release its exclusive claim. |
PosPrinterStatus |
Provides information about the status of a point-of-service printer, such as the power state of the printer. |
PosPrinterStatusUpdatedEventArgs |
Provides information about the PosPrinter.StatusUpdated event that occurs when the status of a point-of-service printer changes. |
ReceiptPrinterCapabilities |
Represents the capabilities of receipt station of a point-of-service printer. |
ReceiptPrintJob |
Represents a set of printing instructions that you want to run on the receipt printer. |
SlipPrinterCapabilities |
Represents the capabilities of slip station of a point-of-service printer. |
SlipPrintJob |
Represents a set of printing instructions that you want to run on the slip printer station. |
UnifiedPosErrorData |
Provides error information. |
Structs
SizeUInt32 |
Defines the height and width of an object in a two-dimensional plane. |
Interfaces
ICashDrawerEventSourceEventArgs |
Represents the arguments common to cash drawer event sources. |
ICommonClaimedPosPrinterStation |
Represents properties and actions common to all type of claimed stations for a point-of-service printer. |
ICommonPosPrintStationCapabilities |
Represents the capabilities common to all types of stations for point-of-service printers. |
ICommonReceiptSlipCapabilities |
Represents the capabilities common to receipt and slip printer stations. |
IPosPrinterJob |
Represents actions common to jobs for all types of stations for a point-of-service printer. |
IReceiptOrSlipJob |
Represents actions common to jobs for receipt and slip printer stations. |
Enums
BarcodeScannerStatus |
Defines the constants that indicate the barcode scanner status. |
BarcodeSymbologyDecodeLengthKind |
The types of decode lengths that barcode symbologies can support. |
CashDrawerStatusKind |
Defines the constants that indicate the cash drawer power status. |
LineDisplayCursorType |
Defines the constants that indicate the type of cursor a line display is using. |
LineDisplayDescriptorState |
Defines the constants that indicate the state of a line display descriptor. |
LineDisplayHorizontalAlignment |
Defines the constants that indicate the horizontal alignment of text on a line display, relative to the current text character position. |
LineDisplayMarqueeFormat |
Defines the constants that indicate the marquee format for the current window. |
LineDisplayPowerStatus |
Defines the constants that indicate the power status of a line display. |
LineDisplayScrollDirection |
Defines the constants that indicate the scrolling direction of the line display. |
LineDisplayTextAttribute |
Defines the constants that indicate whether the line display is reversed or blinking. |
LineDisplayTextAttributeGranularity |
Defines the constants that indicate whether the line display supports blinking or reversing the display. |
LineDisplayVerticalAlignment |
Defines the constants that indicate the vertical alignment of text on a line display, relative to the current text character position. |
MagneticStripeReaderAuthenticationLevel |
Defines the constants that indicates the level of support for magnetic stripe reader authentication protocol: NotSupported, Optional, or Required. |
MagneticStripeReaderAuthenticationProtocol |
Defines the constants that indicates the authentication protocol supported by the device. |
MagneticStripeReaderErrorReportingType |
Defines the constants that indicates the error reporting type for the device. |
MagneticStripeReaderStatus |
Defines the constants that indicate the device authentication status. |
MagneticStripeReaderTrackErrorType |
Defines the constants that indicates the track error type. |
MagneticStripeReaderTrackIds |
Defines the constants that indicates the device track ID to read. |
PaymentMethodKind | |
PaymentOperationStatus | |
PaymentUserResponse | |
PosConnectionTypes |
Connection types that can be used to access a point of service device. |
PosPrinterAlignment |
Describes the possible horizontal alignments of the text that a point-of-service printer prints on the page. |
PosPrinterBarcodeTextPosition |
Describes the possible vertical positions in which a point-of-service printer prints the barcode text relative to the barcode. |
PosPrinterCartridgeSensors |
Describes the possible sensors available for a printer station of a point-of-service printer to use to report the status of the printer. |
PosPrinterColorCapabilities |
Describes the possible color cartridges that a point-of-service printer can support. |
PosPrinterColorCartridge |
Describes the color cartridges that the point-of-service printer can use for printing. |
PosPrinterLineDirection |
Describes the possible directions that a receipt or slip printer station can use to print a ruled line. |
PosPrinterLineStyle |
Describes the line styles that a receipt or slip printer station can use to print a ruled line. |
PosPrinterMapMode |
Describes the valid units of measure for point-of-service printers. |
PosPrinterMarkFeedCapabilities |
Describes the capabilities of a receipt printer station for handling mark-sensed paper. |
PosPrinterMarkFeedKind |
Describes the ways the receipt printer station should feed the mark-sensed paper when you call the ReceiptPrintJob.MarkFeed method. |
PosPrinterPrintSide |
Describes the sides of the sheet of paper on which the point-of-service printer prints. |
PosPrinterRotation |
Describes the possible ways that a point-of-service printer can rotate the text or image on the page. |
PosPrinterRuledLineCapabilities |
Describes the capabilities of the point-of-service printer to draw ruled lines. |
PosPrinterStatusKind |
Describes the power state for a point-of-service printer. |
UnifiedPosErrorReason |
Defines the constants that indicates the reason for the error event. |
UnifiedPosErrorSeverity |
Defines the constants that indicates the error severity. |
UnifiedPosHealthCheckLevel |
Defines the constants that indicates the type of health check that can be performed on the devices. |
UnifiedPosPowerReportingType |
Defines the constants that indicates power reporting capabilities of the Point of Service (POS) device. |
Remarks
Applications that use this namespace require the declaration of the pointOfService
DeviceCapability in the app package manifest.