4.9. StarIoExtManagerDelegate
Provides status information about printers and peripherals
This Delegate is Class-Only Protocol. It cannot apply to Swift struct(e.g.SwiftUI) and Enum. If necessary, create another class and apply it to the class.
Method
Name
Contents
Tells the printer impossible.
Tells the printer has come online.
Tells the printer has come offline.
Tells the printer has come paper ready.
Tells the printer has come paper near end.
Tells the printer has come paper empty.
Tells the printer has come cover open.
Tells the printer has come cover close.
Tells the delegate the cash drawer has come open.
Tells the delegate the cash drawer has come close.
Tells the delegate the barcode reader impossible.
Tells the delegate the barcode reader connected.
Tells the delegate the barcode reader disconnected.
Tells the delegate the barcode data received.
Tells the listener the accessory connection succeeded from disconnection.
Tells the listener the accessory connection failed from disconnection.
Tells the accessory disconnected.
Tells the status updated.
4.9.1. didConnectPort
added in version 1.11.0
Sends notice of connection success.
Declaration
optional func manager(_ manager: StarIoExtManager, didConnectPort portName: Any!)
Parameter
Name
Contents
Type
manager
A StarIoExtManager object informing the delegate
portName
Printer port name
String
Return value
None
4.9.2. didFailToConnectPort
added in version 1.11.0
Sends notice of connection failure.
Declaration
optional func manager(_ manager: StarIoExtManager, didFailToConnectPort portName: Any!, error: Any!)
Parameter
Name
Contents
Type
manager
A StarIoExtManager object informing the delegate
portName
Printer port name
String
error
Connection failure error informationAn error code is set in the code property.NSErrorPointer
Error code
Value
Contents
SMResultCodeFailed
Some kind of error occurred.
SMResultCodeInUse
Connection was refused by the printer (another host is connected or other reason).
SMResultCodeInProcess
Connection process is already in progress.
Return value
None
4.9.3. didPrinterImpossible
Tells the printer impossible.
Declaration
optional func didPrinterImpossible() optional func didPrinterImpossible(_ manager: StarIoExtManager!)
Parameter
Name
Contents
Type
manager
A StarIoExtManager object informing the delegate
Return value
None
4.9.4. didPrinterOnline
Tells the printer has come online.
Declaration
optional func didPrinterOnline() optional func didPrinterOnline(_ manager: StarIoExtManager!)
Parameter
Name
Contents
Type
manager
A StarIoExtManager object informing the delegate
Return value
None
4.9.5. didPrinterOffline
Tells the printer has come offline.
Declaration
optional func didPrinterOffline() optional func didPrinterOffline(_ manager: StarIoExtManager!)
Parameter
Name
Contents
Type
manager
A StarIoExtManager object informing the delegate
Return value
None
4.9.6. didPrinterPaperReady
Tells the printer has come paper ready.
Declaration
optional func didPrinterPaperReady() optional func didPrinterPaperReady(_ manager: StarIoExtManager!)
Parameter
Name
Contents
Type
manager
A StarIoExtManager object informing the delegate
Return value
None
4.9.7. didPrinterPaperNearEmpty
Tells the printer has come paper near end.
Declaration
optional func didPrinterPaperNearEmpty() optional func didPrinterPaperNearEmpty(_ manager: StarIoExtManager!)
Parameter
Name
Contents
Type
manager
A StarIoExtManager object informing the delegate
Return value
None
4.9.8. didPrinterPaperEmpty
Tells the printer has come paper empty.
Declaration
optional func didPrinterPaperEmpty() optional func didPrinterPaperEmpty(_ manager: StarIoExtManager!)
Parameter
Name
Contents
Type
manager
A StarIoExtManager object informing the delegate
Return value
None
4.9.9. didPrinterCoverOpen
Tells the printer has come cover open.
Declaration
optional func didPrinterCoverOpen() optional func didPrinterCoverOpen(_ manager: StarIoExtManager!)
Parameter
Name
Contents
Type
manager
A StarIoExtManager object informing the delegate
Return value
None
4.9.10. didPrinterCoverClose
Tells the printer has come cover close.
Declaration
optional func didPrinterCoverClose() optional func didPrinterCoverClose(_ manager: StarIoExtManager!)
Parameter
Name
Contents
Type
manager
A StarIoExtManager object informing the delegate
Return value
None
4.9.11. didCashDrawerOpen
Tells the delegate the cash drawer has come open.
Declaration
optional func didCashDrawerOpen() optional func didCashDrawerOpen(_ manager: StarIoExtManager!)
Parameter
Name
Contents
Type
manager
A StarIoExtManager object informing the delegate
Return value
None
4.9.12. didCashDrawerClose
Tells the delegate the cash drawer has come close.
Declaration
optional func didCashDrawerClose() optional func didCashDrawerClose(_ manager: StarIoExtManager!)
Parameter
Name
Contents
Type
manager
A StarIoExtManager object informing the delegate
Return value
None
4.9.13. didBarcodeReaderImpossible
Tells the delegate the barcode reader impossible.
Declaration
optional func didBarcodeReaderImpossible() optional func didBarcodeReaderImpossible(_ manager: StarIoExtManager!)
Parameter
Name
Contents
Type
manager
A StarIoExtManager object informing the delegate
Return value
None
4.9.14. didBarcodeReaderConnect
Tells the delegate the barcode reader connected.
Declaration
optional func didBarcodeReaderConnect() optional func didBarcodeReaderConnect(_ manager: StarIoExtManager!)
Parameter
Name
Contents
Type
manager
A StarIoExtManager object informing the delegate
Return value
None
4.9.15. didBarcodeReaderDisconnect
Tells the delegate the barcode reader disconnected.
Declaration
optional func didBarcodeReaderDisconnect() optional func didBarcodeReaderDisconnect(_ manager: StarIoExtManager!)
Parameter
Name
Contents
Type
manager
A StarIoExtManager object informing the delegate
Return value
None
4.9.16. didBarcodeDataReceive
Tells the delegate the barcode data received.
Declaration
optional func didBarcodeDataReceive(_ data: Data!) optional func didBarcodeDataReceive(_ manager: StarIoExtManager!, data: Data!)
Parameter
Name
Contents
Type
data
Received barcode data
Data
manager
A StarIoExtManager object informing the delegate
Return value
None
4.9.17. didAccessoryConnectSuccess
Tells the listener the accessory connection succeeded from disconnection.
Declaration
optional func didAccessoryConnectSuccess() optional func didAccessoryConnectSuccess(_ manager: StarIoExtManager!)
Parameter
Name
Contents
Type
manager
A StarIoExtManager object informing the delegate
Return value
None
4.9.18. didAccessoryConnectFailure
Tells the listener the accessory connection failed from disconnection.
Declaration
optional func didAccessoryConnectFailure() optional func didAccessoryConnectFailure(_ manager: StarIoExtManager!)
Parameter
Name
Contents
Type
manager
A StarIoExtManager object informing the delegate
Return value
None
4.9.19. didAccessoryDisconnect
Tells the accessory disconnected.
Declaration
optional func didAccessoryDisconnect() optional func didAccessoryDisconnect(_ manager: StarIoExtManager!)
Parameter
Name
Contents
Type
manager
A StarIoExtManager object informing the delegate
Return value
None
4.9.20. didStatusUpdate
Tells the status updated.
Declaration
optional func didStatusUpdate(_ status: String!) optional func didStatusUpdate(_ manager: StarIoExtManager!, status: String!)
Parameter
Name
Contents
Type
status
Updated statusHexdecimal digit sequence of 3rd to 6th bytes in Automatic Status. (ex. “28000000”)Please refer to STAR Line Mode and StarPRNT command manual for details of Automatic Status.Status update timing* When the status changes* Even no status change, every 5 minString
manager
A StarIoExtManager object informing the delegate
Return value
None